Class Offset

The <offset> element

Parent elements: <direction>, <harmony>, <listening>, <sound>

An <offset> is represented in terms of divisions, and indicates where the direction will appear relative to the current musical location. The current musical location is always within the current measure, even at the end of a measure. If an element within a <direction> includes a default-x attribute, the <offset> value will be ignored when determining the appearance of that element.

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

Hierarchy

  • Offset

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getSound getValue setSound setValue

Constructors

constructor

Properties

attributes

attributes: OffsetAttributes

contents

contents: OffsetContents

Readonly schema

schema: {
    attributes: {
        sound: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }];
    name: "offset";
} = Offset.schema

Type declaration

  • Readonly attributes: {
        sound: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    }
    • Readonly sound: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }]
  • Readonly name: "offset"

Static Readonly schema

schema: {
    attributes: {
        sound: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }];
    name: "offset";
} = ...

Type declaration

  • Readonly attributes: {
        sound: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    }
    • Readonly sound: {
          type: "optional";
          value: {
              choices: readonly ["yes", "no"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        }
        • Readonly choices: readonly ["yes", "no"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }]
  • Readonly name: "offset"

Methods

getSound

getValue

setSound

setValue

Settings

Theme

On This Page

Generated using TypeDoc