Class Supports

The <supports> element

Parent element: <encoding>

The <supports> element indicates if a MusicXML encoding supports a particular MusicXML element. This is recommended for elements like <beam>, <stem>, and <accidental>, where the absence of an element is ambiguous if you do not know if the encoding supports that element. It also allows programs to indicate support for specific attributes, or specific attributes with specific values. This lets applications communicate, for example, that all system and/or page breaks are contained in the MusicXML file.

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/supports/

Hierarchy

  • Supports

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getAttribute getElement getType getValue setAttribute setElement setType setValue

Constructors

constructor

Properties

attributes

attributes: SupportsAttributes

contents

contents: []

Readonly schema

schema: {
    attributes: {
        attribute: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        element: {
            type: "required";
            value: {
                type: "string";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        value: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [];
    name: "supports";
} = Supports.schema

Type declaration

  • Readonly attributes: {
        attribute: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        element: {
            type: "required";
            value: {
                type: "string";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        value: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    }
    • Readonly attribute: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly element: {
          type: "required";
          value: {
              type: "string";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly type: {
          type: "required";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly value: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly []
  • Readonly name: "supports"

Static Readonly schema

schema: {
    attributes: {
        attribute: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        element: {
            type: "required";
            value: {
                type: "string";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        value: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    };
    contents: readonly [];
    name: "supports";
} = ...

Type declaration

  • Readonly attributes: {
        attribute: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        element: {
            type: "required";
            value: {
                type: "string";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        value: {
            type: "optional";
            value: {
                type: "string";
            };
        };
    }
    • Readonly attribute: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly element: {
          type: "required";
          value: {
              type: "string";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly type: {
          type: "required";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "required"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
    • Readonly value: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
  • Readonly contents: readonly []
  • Readonly name: "supports"

Methods

getAttribute

getElement

getType

getValue

setAttribute

setElement

setType

setValue

Settings

Theme

On This Page

Generated using TypeDoc