Class StaffSize

The <staff-size> element

Parent element: <staff-details>

The <staff-size> element indicates how large a staff space is on this staff, expressed as a percentage of the work's default scaling. Values less than 100 make the staff space smaller while values over 100 make the staff space larger. A <staff-type> of cue, ossia, or editorial implies a <staff-size> of less than 100, but the exact value is implementation-dependent unless specified here. Staff size affects staff height only, not the relationship of the staff to the left and right margins.

In some cases, a <staff-size> different than 100 also scales the notation on the staff, such as with a cue staff. In other cases, such as percussion staves, the lines may be more widely spaced without scaling the notation on the staff. The scaling attribute allows these two cases to be distinguished.

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

Hierarchy

  • StaffSize

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getScaling getValue setScaling setValue

Constructors

constructor

Properties

attributes

attributes: StaffSizeAttributes

contents

contents: StaffSizeContents

Readonly schema

schema: {
    attributes: {
        scaling: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }];
    name: "staff-size";
} = StaffSize.schema

Type declaration

  • Readonly attributes: {
        scaling: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }
    • Readonly scaling: {
          type: "optional";
          value: {
              max: number;
              min: 0;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 0;
            type: "float";
        }
        • Readonly max: number
        • Readonly min: 0
        • Readonly type: "float"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }]
  • Readonly name: "staff-size"

Static Readonly schema

schema: {
    attributes: {
        scaling: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    };
    contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }];
    name: "staff-size";
} = ...

Type declaration

  • Readonly attributes: {
        scaling: {
            type: "optional";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }
    • Readonly scaling: {
          type: "optional";
          value: {
              max: number;
              min: 0;
              type: "float";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            max: number;
            min: 0;
            type: "float";
        }
        • Readonly max: number
        • Readonly min: 0
        • Readonly type: "float"
  • Readonly contents: readonly [{
        label: "value";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: 0;
                type: "float";
            };
        };
    }]
  • Readonly name: "staff-size"

Methods

getScaling

getValue

setScaling

setValue

Settings

Theme

On This Page

Generated using TypeDoc