Class Direction

The <direction> element

Parent elements: <measure> (partwise), <part> (timewise)

A direction is a musical indication that is not necessarily attached to a specific note. Two or more may be combined to indicate words followed by the start of a dashed line, the end of a wedge followed by dynamics, etc. For applications where a specific direction is indeed attached to a specific note, the <direction> element can be associated with the first <note> element that follows it in score order that is not in a different voice.

By default, a series of <direction-type> elements and a series of child elements of a <direction-type> within a single <direction> element follow one another in sequence visually. For a series of <direction-type> children, non-positional formatting attributes are carried over from the previous element by default.

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

Hierarchy

  • Direction

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getDirectionTypes getDirective getFootnote getId getLevel getListening getOffset getPlacement getSound getStaff getSystem getVoice setDirectionTypes setDirective setFootnote setId setLevel setListening setOffset setPlacement setSound setStaff setSystem setVoice

Constructors

constructor

Properties

attributes

attributes: DirectionAttributes

contents

contents: DirectionContents

Readonly schema

schema: {
    attributes: {
        directive: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        system: {
            type: "optional";
            value: {
                choices: readonly ["none", "only-top", "also-top"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "direction-types";
        type: "label";
        value: {
            type: "oneOrMore";
            value: typeof DirectionType;
        };
    }, {
        type: "optional";
        value: typeof Offset;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Voice;
    }, {
        type: "optional";
        value: typeof Staff;
    }, {
        type: "optional";
        value: typeof Sound;
    }, {
        type: "optional";
        value: typeof Listening;
    }];
    name: "direction";
} = Direction.schema

Type declaration

  • Readonly attributes: {
        directive: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        system: {
            type: "optional";
            value: {
                choices: readonly ["none", "only-top", "also-top"];
                type: "choices";
            };
        };
    }
    • Readonly directive: {
          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 id: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly placement: {
          type: "optional";
          value: {
              choices: readonly ["above", "below"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["above", "below"];
            type: "choices";
        }
        • Readonly choices: readonly ["above", "below"]
        • Readonly type: "choices"
    • Readonly system: {
          type: "optional";
          value: {
              choices: readonly ["none", "only-top", "also-top"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "only-top", "also-top"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "only-top", "also-top"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "direction-types";
        type: "label";
        value: {
            type: "oneOrMore";
            value: typeof DirectionType;
        };
    }, {
        type: "optional";
        value: typeof Offset;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Voice;
    }, {
        type: "optional";
        value: typeof Staff;
    }, {
        type: "optional";
        value: typeof Sound;
    }, {
        type: "optional";
        value: typeof Listening;
    }]
  • Readonly name: "direction"

Static Readonly schema

schema: {
    attributes: {
        directive: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        system: {
            type: "optional";
            value: {
                choices: readonly ["none", "only-top", "also-top"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "direction-types";
        type: "label";
        value: {
            type: "oneOrMore";
            value: typeof DirectionType;
        };
    }, {
        type: "optional";
        value: typeof Offset;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Voice;
    }, {
        type: "optional";
        value: typeof Staff;
    }, {
        type: "optional";
        value: typeof Sound;
    }, {
        type: "optional";
        value: typeof Listening;
    }];
    name: "direction";
} = ...

Type declaration

  • Readonly attributes: {
        directive: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        system: {
            type: "optional";
            value: {
                choices: readonly ["none", "only-top", "also-top"];
                type: "choices";
            };
        };
    }
    • Readonly directive: {
          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 id: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "_";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "_"
    • Readonly placement: {
          type: "optional";
          value: {
              choices: readonly ["above", "below"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["above", "below"];
            type: "choices";
        }
        • Readonly choices: readonly ["above", "below"]
        • Readonly type: "choices"
    • Readonly system: {
          type: "optional";
          value: {
              choices: readonly ["none", "only-top", "also-top"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "only-top", "also-top"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "only-top", "also-top"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "direction-types";
        type: "label";
        value: {
            type: "oneOrMore";
            value: typeof DirectionType;
        };
    }, {
        type: "optional";
        value: typeof Offset;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }, {
        type: "optional";
        value: typeof Voice;
    }, {
        type: "optional";
        value: typeof Staff;
    }, {
        type: "optional";
        value: typeof Sound;
    }, {
        type: "optional";
        value: typeof Listening;
    }]
  • Readonly name: "direction"

Methods

getDirectionTypes

getDirective

getFootnote

getId

getLevel

getListening

getOffset

getPlacement

getSound

getStaff

getSystem

  • Gets

    Returns null | "none" | "only-top" | "also-top"

getVoice

setDirectionTypes

setDirective

setFootnote

setId

setLevel

setListening

setOffset

setPlacement

setSound

setStaff

setSystem

setVoice

Settings

Theme

On This Page

Generated using TypeDoc