Class Cancel

The <cancel> element

Parent element: <key>

The <cancel> element indicates that the old key signature should be cancelled before the new one appears. This will always happen when changing to C major or A minor and need not be specified then. The <cancel> element value matches the fifths value of the cancelled key signature (e.g., a cancel of -2 will provide an explicit cancellation for changing from B flat major to F major).

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

Hierarchy

  • Cancel

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getFifths getLocation setFifths setLocation

Constructors

constructor

Properties

attributes

attributes: CancelAttributes

contents

contents: CancelContents

Readonly schema

schema: {
    attributes: {
        location: {
            type: "optional";
            value: {
                choices: readonly ["left", "right", "beforeBarline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "fifths";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "int";
            };
        };
    }];
    name: "cancel";
} = Cancel.schema

Type declaration

  • Readonly attributes: {
        location: {
            type: "optional";
            value: {
                choices: readonly ["left", "right", "beforeBarline"];
                type: "choices";
            };
        };
    }
    • Readonly location: {
          type: "optional";
          value: {
              choices: readonly ["left", "right", "beforeBarline"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["left", "right", "beforeBarline"];
            type: "choices";
        }
        • Readonly choices: readonly ["left", "right", "beforeBarline"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "fifths";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "int";
            };
        };
    }]
  • Readonly name: "cancel"

Static Readonly schema

schema: {
    attributes: {
        location: {
            type: "optional";
            value: {
                choices: readonly ["left", "right", "beforeBarline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "fifths";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "int";
            };
        };
    }];
    name: "cancel";
} = ...

Type declaration

  • Readonly attributes: {
        location: {
            type: "optional";
            value: {
                choices: readonly ["left", "right", "beforeBarline"];
                type: "choices";
            };
        };
    }
    • Readonly location: {
          type: "optional";
          value: {
              choices: readonly ["left", "right", "beforeBarline"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["left", "right", "beforeBarline"];
            type: "choices";
        }
        • Readonly choices: readonly ["left", "right", "beforeBarline"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        label: "fifths";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "int";
            };
        };
    }]
  • Readonly name: "cancel"

Methods

getFifths

getLocation

  • Gets

    Returns null | "left" | "right" | "beforeBarline"

setFifths

setLocation

Settings

Theme

On This Page

Generated using TypeDoc