Class StaffDetails

The <staff-details> element

Parent element: <attributes>

The <staff-details> element is used to indicate different types of staves.

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

Hierarchy

StaffDetails

Implements

XMLElement<"staff-details", StaffDetailsAttributes, StaffDetailsContents>

Constructors

constructor

new StaffDetails(opts?): StaffDetails
Parameters
- Optional opts: {
  attributes?: Partial<StaffDetailsAttributes>;
  contents?: StaffDetailsContents;
  }
  - Optional attributes?: Partial<StaffDetailsAttributes>
  - Optional contents?: StaffDetailsContents
Returns StaffDetails
- Defined in generated/elements.ts:49949

Properties

attributes

attributes: StaffDetailsAttributes

contents: StaffDetailsContents

`Readonly` schema

schema: {
    attributes: {
        number: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        print-object: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        print-spacing: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        show-frets: {
            type: "optional";
            value: {
                choices: readonly ["letters", "numbers"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof StaffType;
    }, {
        label: "lines";
        type: "label";
        value: {
            type: "optional";
            value: readonly [{
                type: "required";
                value: typeof StaffLines;
            }, {
                type: "zeroOrMore";
                value: typeof LineDetail;
            }];
        };
    }, {
        label: "staff-tunings";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffTuning;
        };
    }, {
        type: "optional";
        value: typeof Capo;
    }, {
        type: "optional";
        value: typeof StaffSize;
    }];
    name: "staff-details";
} = StaffDetails.schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
    print-object: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    print-spacing: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    show-frets: {
        type: "optional";
        value: {
            choices: readonly ["letters", "numbers"];
            type: "choices";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          max: number;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 1;
        type: "int";
    }
    - Readonly max: number
    - Readonly min: 1
    - Readonly type: "int"
- Readonly print-object: {
      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 print-spacing: {
      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 show-frets: {
      type: "optional";
      value: {
          choices: readonly ["letters", "numbers"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["letters", "numbers"];
    type: "choices";
    }
    - Readonly choices: readonly ["letters", "numbers"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: typeof StaffType;
}, {
    label: "lines";
    type: "label";
    value: {
        type: "optional";
        value: readonly [{
            type: "required";
            value: typeof StaffLines;
        }, {
            type: "zeroOrMore";
            value: typeof LineDetail;
        }];
    };
}, {
    label: "staff-tunings";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffTuning;
    };
}, {
    type: "optional";
    value: typeof Capo;
}, {
    type: "optional";
    value: typeof StaffSize;
}]
Readonly name: "staff-details"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
    print-object: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    print-spacing: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    show-frets: {
        type: "optional";
        value: {
            choices: readonly ["letters", "numbers"];
            type: "choices";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          max: number;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 1;
        type: "int";
    }
    - Readonly max: number
    - Readonly min: 1
    - Readonly type: "int"
- Readonly print-object: {
      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 print-spacing: {
      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 show-frets: {
      type: "optional";
      value: {
          choices: readonly ["letters", "numbers"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["letters", "numbers"];
    type: "choices";
    }
    - Readonly choices: readonly ["letters", "numbers"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: typeof StaffType;
}, {
    label: "lines";
    type: "label";
    value: {
        type: "optional";
        value: readonly [{
            type: "required";
            value: typeof StaffLines;
        }, {
            type: "zeroOrMore";
            value: typeof LineDetail;
        }];
    };
}, {
    label: "staff-tunings";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffTuning;
    };
}, {
    type: "optional";
    value: typeof Capo;
}, {
    type: "optional";
    value: typeof StaffSize;
}]
Readonly name: "staff-details"

Methods

getCapo

getCapo(): null | Capo
Gets

Returns null | Capo
- Defined in generated/elements.ts:50017

getLines

getLines(): null | [StaffLines, LineDetail[]]
Gets

Returns null | [StaffLines, LineDetail[]]
- Defined in generated/elements.ts:49999

getNumber

getNumber(): null | number
Gets

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

getPrintObject

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

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

getPrintSpacing

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

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

getShowFrets

getShowFrets(): null | "letters" | "numbers"
Gets

Returns null | "letters" | "numbers"
- Defined in generated/elements.ts:49981

getStaffSize

getStaffSize(): null | StaffSize
Gets

Returns null | StaffSize
- Defined in generated/elements.ts:50026

getStaffTunings

getStaffTunings(): StaffTuning[]
Gets

Returns StaffTuning[]
- Defined in generated/elements.ts:50008

getStaffType

getStaffType(): null | StaffType
Gets

Returns null | StaffType
- Defined in generated/elements.ts:49990

setCapo

setCapo(capo): StaffDetails
Sets
Parameters
- capo: null | Capo
Returns StaffDetails
- Defined in generated/elements.ts:50021

setLines

setLines(lines): StaffDetails
Sets
Parameters
- lines: null | [StaffLines, LineDetail[]]
Returns StaffDetails
- Defined in generated/elements.ts:50003

setNumber

setNumber(number): StaffDetails
Sets
Parameters
- number: null | number
Returns StaffDetails
- Defined in generated/elements.ts:49958

setPrintObject

setPrintObject(printObject): StaffDetails
Sets
Parameters
- printObject: null | "yes" | "no"
Returns StaffDetails
- Defined in generated/elements.ts:49967

setPrintSpacing

setPrintSpacing(printSpacing): StaffDetails
Sets
Parameters
- printSpacing: null | "yes" | "no"
Returns StaffDetails
- Defined in generated/elements.ts:49976

setShowFrets

setShowFrets(showFrets): StaffDetails
Sets
Parameters
- showFrets: null | "letters" | "numbers"
Returns StaffDetails
- Defined in generated/elements.ts:49985

setStaffSize

setStaffSize(staffSize): StaffDetails
Sets
Parameters
- staffSize: null | StaffSize
Returns StaffDetails
- Defined in generated/elements.ts:50030

setStaffTunings

setStaffTunings(staffTunings): StaffDetails
Sets
Parameters
- staffTunings: StaffTuning[]
Returns StaffDetails
- Defined in generated/elements.ts:50012

setStaffType

setStaffType(staffType): StaffDetails
Sets
Parameters
- staffType: null | StaffType
Returns StaffDetails
- Defined in generated/elements.ts:49994

Class StaffDetails

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<StaffDetailsAttributes>; contents?: StaffDetailsContents; }

Optional attributes?: Partial<StaffDetailsAttributes>

Optional contents?: StaffDetailsContents

Returns StaffDetails

Properties

attributes

contents

Readonly schema

Type declaration

Readonly number: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }

Readonly type: "optional"

Readonly value: { max: number; min: 1; type: "int"; }

Readonly max: number

Readonly min: 1

Readonly type: "int"

Readonly print-object: { 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 print-spacing: { 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 show-frets: { type: "optional"; value: { choices: readonly ["letters", "numbers"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["letters", "numbers"]; type: "choices"; }

Readonly choices: readonly ["letters", "numbers"]

Readonly type: "choices"

Readonly name: "staff-details"

Static Readonly schema

Type declaration

Readonly number: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }

Readonly type: "optional"

Readonly value: { max: number; min: 1; type: "int"; }

Readonly max: number

Readonly min: 1

Readonly type: "int"

Readonly print-object: { 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 print-spacing: { 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 show-frets: { type: "optional"; value: { choices: readonly ["letters", "numbers"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["letters", "numbers"]; type: "choices"; }

Readonly choices: readonly ["letters", "numbers"]

Readonly type: "choices"

Readonly name: "staff-details"

Methods

getCapo

Returns null | Capo

getLines

Returns null | [StaffLines, LineDetail[]]

getNumber

Returns null | number

getPrintObject

Returns null | "yes" | "no"

getPrintSpacing

Returns null | "yes" | "no"

getShowFrets

Returns null | "letters" | "numbers"

getStaffSize

Returns null | StaffSize

`Optional` opts: {
attributes?: Partial<StaffDetailsAttributes>;
contents?: StaffDetailsContents;
}

`Optional` attributes?: Partial<StaffDetailsAttributes>

`Optional` contents?: StaffDetailsContents

`Readonly` schema

`Readonly` number: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: number;
min: 1;
type: "int";
}

`Readonly` max: number

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` print-object: {
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` print-spacing: {
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` show-frets: {
type: "optional";
value: {
choices: readonly ["letters", "numbers"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["letters", "numbers"];
type: "choices";
}

`Readonly` choices: readonly ["letters", "numbers"]

`Readonly` type: "choices"

`Readonly` name: "staff-details"

`Static` `Readonly` schema

`Readonly` number: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: number;
min: 1;
type: "int";
}

`Readonly` max: number

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` print-object: {
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` print-spacing: {
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` show-frets: {
type: "optional";
value: {
choices: readonly ["letters", "numbers"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["letters", "numbers"];
type: "choices";
}

`Readonly` choices: readonly ["letters", "numbers"]

`Readonly` type: "choices"

`Readonly` name: "staff-details"