Class Dynamics

The <dynamics> element

Parent elements: <direction-type>, <notations>

Dynamics can be associated either with a note or a general musical direction. To avoid inconsistencies between and amongst the letter abbreviations for dynamics (what is sf vs. sfz, standing alone or with a trailing dynamic that is not always piano), we use the actual letters as the names of these dynamic elements. The <other-dynamics> element allows other dynamic marks that are not covered here. Dynamics elements may also be combined to create marks not covered by a single element, such as <sf/>``<mp/>.

These letter dynamic symbols are separated from crescendo, decrescendo, and wedge indications. Dynamic representation is inconsistent in scores. Many things are assumed by the composer and left out, such as returns to original dynamics. The MusicXML format captures what is in the score, but does not try to be optimal for analysis or synthesis of dynamics.

The placement attribute is used when the dynamics are associated with a <note>. It is ignored when the dynamics are associated with a <direction>. In that case the <direction> element's placement attribute is used instead.

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

Hierarchy

  • Dynamics

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getColor getDefaultX getDefaultY getEnclosure getFontFamily getFontSize getFontStyle getFontWeight getHalign getId getLineThrough getOverline getPlacement getRelativeX getRelativeY getUnderline getValign getValue setColor setDefaultX setDefaultY setEnclosure setFontFamily setFontSize setFontStyle setFontWeight setHalign setId setLineThrough setOverline setPlacement setRelativeX setRelativeY setUnderline setValign setValue

Constructors

constructor

Properties

attributes

attributes: DynamicsAttributes

contents

contents: DynamicsContents

Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        enclosure: {
            type: "optional";
            value: {
                choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: {
                choices: readonly [typeof P, typeof Pp, typeof Ppp, typeof Pppp, typeof Ppppp, typeof Pppppp, typeof F, typeof Ff, typeof Fff, typeof Ffff, typeof Fffff, typeof Fffff, typeof Ffffff, typeof Mp, typeof Mf, typeof Sf, typeof Sfp, typeof Sfpp, typeof Fp, typeof Rf, typeof Rfz, typeof Sfz, typeof Sffz, typeof Fz, typeof N, typeof Pf, typeof Sfzp, typeof OtherDynamics];
                type: "choices";
            };
        };
    }];
    name: "dynamics";
} = Dynamics.schema

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        enclosure: {
            type: "optional";
            value: {
                choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly enclosure: {
          type: "optional";
          value: {
              choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]
        • Readonly type: "choices"
    • Readonly font-family: {
          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 font-size: {
          type: "optional";
          value: {
              choices: readonly [{
                  choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                  type: "choices";
              }, {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly font-style: {
          type: "optional";
          value: {
              choices: readonly ["normal", "italic"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "italic"]
        • Readonly type: "choices"
    • Readonly font-weight: {
          type: "optional";
          value: {
              choices: readonly ["normal", "bold"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "bold"]
        • Readonly type: "choices"
    • Readonly halign: {
          type: "optional";
          value: {
              choices: readonly ["left", "center", "right"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        }
        • Readonly choices: readonly ["left", "center", "right"]
        • 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 line-through: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly overline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • 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 relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly underline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly valign: {
          type: "optional";
          value: {
              choices: readonly ["top", "middle", "bottom", "baseline"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        }
        • Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: {
                choices: readonly [typeof P, typeof Pp, typeof Ppp, typeof Pppp, typeof Ppppp, typeof Pppppp, typeof F, typeof Ff, typeof Fff, typeof Ffff, typeof Fffff, typeof Fffff, typeof Ffffff, typeof Mp, typeof Mf, typeof Sf, typeof Sfp, typeof Sfpp, typeof Fp, typeof Rf, typeof Rfz, typeof Sfz, typeof Sffz, typeof Fz, typeof N, typeof Pf, typeof Sfzp, typeof OtherDynamics];
                type: "choices";
            };
        };
    }]
  • Readonly name: "dynamics"

Static Readonly schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        enclosure: {
            type: "optional";
            value: {
                choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: {
                choices: readonly [typeof P, typeof Pp, typeof Ppp, typeof Pppp, typeof Ppppp, typeof Pppppp, typeof F, typeof Ff, typeof Fff, typeof Ffff, typeof Fffff, typeof Fffff, typeof Ffffff, typeof Mp, typeof Mf, typeof Sf, typeof Sfp, typeof Sfpp, typeof Fp, typeof Rf, typeof Rfz, typeof Sfz, typeof Sffz, typeof Fz, typeof N, typeof Pf, typeof Sfzp, typeof OtherDynamics];
                type: "choices";
            };
        };
    }];
    name: "dynamics";
} = ...

Type declaration

  • Readonly attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        enclosure: {
            type: "optional";
            value: {
                choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    }
    • Readonly color: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "#000000";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "#000000"
    • Readonly default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly enclosure: {
          type: "optional";
          value: {
              choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
            type: "choices";
        }
        • Readonly choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]
        • Readonly type: "choices"
    • Readonly font-family: {
          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 font-size: {
          type: "optional";
          value: {
              choices: readonly [{
                  choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                  type: "choices";
              }, {
                  max: number;
                  min: number;
                  type: "float";
              }];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        }
        • Readonly choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }]
        • Readonly type: "choices"
    • Readonly font-style: {
          type: "optional";
          value: {
              choices: readonly ["normal", "italic"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "italic"]
        • Readonly type: "choices"
    • Readonly font-weight: {
          type: "optional";
          value: {
              choices: readonly ["normal", "bold"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        }
        • Readonly choices: readonly ["normal", "bold"]
        • Readonly type: "choices"
    • Readonly halign: {
          type: "optional";
          value: {
              choices: readonly ["left", "center", "right"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        }
        • Readonly choices: readonly ["left", "center", "right"]
        • 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 line-through: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly overline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • 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 relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly underline: {
          type: "optional";
          value: {
              max: 3;
              min: 0;
              type: "int";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: 3;
            min: 0;
            type: "int";
        }
        • Readonly max: 3
        • Readonly min: 0
        • Readonly type: "int"
    • Readonly valign: {
          type: "optional";
          value: {
              choices: readonly ["top", "middle", "bottom", "baseline"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        }
        • Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: {
                choices: readonly [typeof P, typeof Pp, typeof Ppp, typeof Pppp, typeof Ppppp, typeof Pppppp, typeof F, typeof Ff, typeof Fff, typeof Ffff, typeof Fffff, typeof Fffff, typeof Ffffff, typeof Mp, typeof Mf, typeof Sf, typeof Sfp, typeof Sfpp, typeof Fp, typeof Rf, typeof Rfz, typeof Sfz, typeof Sffz, typeof Fz, typeof N, typeof Pf, typeof Sfzp, typeof OtherDynamics];
                type: "choices";
            };
        };
    }]
  • Readonly name: "dynamics"

Methods

getColor

getDefaultX

getDefaultY

getEnclosure

  • Gets

    Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

getFontFamily

getFontSize

  • Gets

    Returns null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"

getFontStyle

getFontWeight

getHalign

getId

getLineThrough

getOverline

getPlacement

getRelativeX

getRelativeY

getUnderline

getValign

  • Gets

    Returns null | "top" | "middle" | "bottom" | "baseline"

getValue

setColor

setDefaultX

setDefaultY

setEnclosure

  • Sets

    Parameters

    • enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

    Returns Dynamics

setFontFamily

setFontSize

setFontStyle

setFontWeight

setHalign

setId

setLineThrough

setOverline

setPlacement

setRelativeX

setRelativeY

setUnderline

setValign

setValue

Settings

Theme

On This Page

Generated using TypeDoc