Class AccidentalMark

The <accidental-mark> element

Parent elements: <notations>, <ornaments>

An <accidental-mark> element can be used as a separate notation or as part of an ornament. When used in an ornament, position and placement are relative to the ornament, not relative to the note.

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

Hierarchy

AccidentalMark

Implements

XMLElement<"accidental-mark", AccidentalMarkAttributes, AccidentalMarkContents>

Constructors

constructor

new AccidentalMark(opts?): AccidentalMark
Parameters
- Optional opts: {
  attributes?: Partial<AccidentalMarkAttributes>;
  contents?: AccidentalMarkContents;
  }
  - Optional attributes?: Partial<AccidentalMarkAttributes>
  - Optional contents?: AccidentalMarkContents
Returns AccidentalMark
- Defined in generated/elements.ts:19251

Properties

attributes

attributes: AccidentalMarkAttributes

contents: AccidentalMarkContents

`Readonly` schema

schema: {
    attributes: {
        bracket: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        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";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        parentheses: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        size: {
            type: "optional";
            value: {
                choices: readonly ["cue", "full", "grace-cue", "large"];
                type: "choices";
            };
        };
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "acc";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "accidental-value";
            type: "label";
            value: {
                choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
                type: "choices";
            };
        };
    }];
    name: "accidental-mark";
} = AccidentalMark.schema

Type declaration

Readonly attributes: {
    bracket: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    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";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    parentheses: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    size: {
        type: "optional";
        value: {
            choices: readonly ["cue", "full", "grace-cue", "large"];
            type: "choices";
        };
    };
    smufl: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "acc";
        };
    };
}
- Readonly bracket: {
      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 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 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 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 parentheses: {
      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 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 size: {
      type: "optional";
      value: {
          choices: readonly ["cue", "full", "grace-cue", "large"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["cue", "full", "grace-cue", "large"];
    type: "choices";
    }
    - Readonly choices: readonly ["cue", "full", "grace-cue", "large"]
    - Readonly type: "choices"
- Readonly smufl: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "acc";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "acc";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "acc"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "accidental-value";
        type: "label";
        value: {
            choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
            type: "choices";
        };
    };
}]
Readonly name: "accidental-mark"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    bracket: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    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";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    parentheses: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    size: {
        type: "optional";
        value: {
            choices: readonly ["cue", "full", "grace-cue", "large"];
            type: "choices";
        };
    };
    smufl: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "acc";
        };
    };
}
- Readonly bracket: {
      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 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 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 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 parentheses: {
      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 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 size: {
      type: "optional";
      value: {
          choices: readonly ["cue", "full", "grace-cue", "large"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["cue", "full", "grace-cue", "large"];
    type: "choices";
    }
    - Readonly choices: readonly ["cue", "full", "grace-cue", "large"]
    - Readonly type: "choices"
- Readonly smufl: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "acc";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "acc";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "acc"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "accidental-value";
        type: "label";
        value: {
            choices: readonly ["other", "sharp", "natural", "flat", "double-sharp", "sharp-sharp", "flat-flat", "natural-sharp", "natural-flat", "quarter-flat", "quarter-sharp", "three-quarters-flat", "three-quarters-sharp", "sharp-down", "sharp-up", "natural-down", "natural-up", "flat-down", "flat-up", "double-sharp-down", "double-sharp-up", "flat-flat-down", "flat-flat-up", "arrow-down", "arrow-up", "triple-sharp", "triple-flat", "slash-quarter-sharp", "slash-sharp", "slash-flat", "double-slash-flat", "sharp-1", "sharp-2", "sharp-3", "sharp-5", "flat-1", "flat-2", "flat-3", "flat-4", "sori", "koron"];
            type: "choices";
        };
    };
}]
Readonly name: "accidental-mark"

Methods

getAccidentalValue

getAccidentalValue(): "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Gets

Returns "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
- Defined in generated/elements.ts:19393

getBracket

getBracket(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:19256

getColor

getColor(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:19265

getDefaultX

getDefaultX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:19274

getDefaultY

getDefaultY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:19283

getFontFamily

getFontFamily(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:19292

getFontSize

getFontSize(): null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Gets

Returns null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
- Defined in generated/elements.ts:19301

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:19312

getFontWeight

getFontWeight(): null | "bold" | "normal"
Gets

Returns null | "bold" | "normal"
- Defined in generated/elements.ts:19321

getId

getId(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:19330

getParentheses

getParentheses(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:19339

getPlacement

getPlacement(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:19348

getRelativeX

getRelativeX(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:19357

getRelativeY

getRelativeY(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:19366

getSize

getSize(): null | "cue" | "grace-cue" | "large" | "full"
Gets

Returns null | "cue" | "grace-cue" | "large" | "full"
- Defined in generated/elements.ts:19375

getSmufl

getSmufl(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:19384

setAccidentalValue

setAccidentalValue(accidentalValue): AccidentalMark
Sets
Parameters
- accidentalValue: "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"
Returns AccidentalMark
- Defined in generated/elements.ts:19438

setBracket

setBracket(bracket): AccidentalMark
Sets
Parameters
- bracket: null | "yes" | "no"
Returns AccidentalMark
- Defined in generated/elements.ts:19260

setColor

setColor(color): AccidentalMark
Sets
Parameters
- color: null | string
Returns AccidentalMark
- Defined in generated/elements.ts:19269

setDefaultX

setDefaultX(defaultX): AccidentalMark
Sets
Parameters
- defaultX: null | number
Returns AccidentalMark
- Defined in generated/elements.ts:19278

setDefaultY

setDefaultY(defaultY): AccidentalMark
Sets
Parameters
- defaultY: null | number
Returns AccidentalMark
- Defined in generated/elements.ts:19287

setFontFamily

setFontFamily(fontFamily): AccidentalMark
Sets
Parameters
- fontFamily: null | string
Returns AccidentalMark
- Defined in generated/elements.ts:19296

setFontSize

setFontSize(fontSize): AccidentalMark
Sets
Parameters
- fontSize: null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Returns AccidentalMark
- Defined in generated/elements.ts:19305

setFontStyle

setFontStyle(fontStyle): AccidentalMark
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns AccidentalMark
- Defined in generated/elements.ts:19316

setFontWeight

setFontWeight(fontWeight): AccidentalMark
Sets
Parameters
- fontWeight: null | "bold" | "normal"
Returns AccidentalMark
- Defined in generated/elements.ts:19325

setId

setId(id): AccidentalMark
Sets
Parameters
- id: null | string
Returns AccidentalMark
- Defined in generated/elements.ts:19334

setParentheses

setParentheses(parentheses): AccidentalMark
Sets
Parameters
- parentheses: null | "yes" | "no"
Returns AccidentalMark
- Defined in generated/elements.ts:19343

setPlacement

setPlacement(placement): AccidentalMark
Sets
Parameters
- placement: null | "above" | "below"
Returns AccidentalMark
- Defined in generated/elements.ts:19352

setRelativeX

setRelativeX(relativeX): AccidentalMark
Sets
Parameters
- relativeX: null | number
Returns AccidentalMark
- Defined in generated/elements.ts:19361

setRelativeY

setRelativeY(relativeY): AccidentalMark
Sets
Parameters
- relativeY: null | number
Returns AccidentalMark
- Defined in generated/elements.ts:19370

setSize

setSize(size): AccidentalMark
Sets
Parameters
- size: null | "cue" | "grace-cue" | "large" | "full"
Returns AccidentalMark
- Defined in generated/elements.ts:19379

setSmufl

setSmufl(smufl): AccidentalMark
Sets
Parameters
- smufl: null | string
Returns AccidentalMark
- Defined in generated/elements.ts:19388

Class AccidentalMark

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<AccidentalMarkAttributes>; contents?: AccidentalMarkContents; }

Optional attributes?: Partial<AccidentalMarkAttributes>

Optional contents?: AccidentalMarkContents

Returns AccidentalMark

Properties

attributes

contents

Readonly schema

Type declaration

Readonly bracket: { 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 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 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 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 parentheses: { 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"

`Optional` opts: {
attributes?: Partial<AccidentalMarkAttributes>;
contents?: AccidentalMarkContents;
}

`Optional` attributes?: Partial<AccidentalMarkAttributes>

`Optional` contents?: AccidentalMarkContents

`Readonly` schema

`Readonly` bracket: {
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` 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` 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` 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` parentheses: {
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` 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";
};
};
}