Class Defaults

The <defautls> element

Parent elements: <score-partwise version="4.0">, <score-timewise>

The <defaults> element specifies score-wide defaults for scaling; whether or not the file is a concert score; layout; and default values for the music font, word font, lyric font, and lyric language. Except for the <concert-score> element, if any defaults are missing, the choice of what to use is determined by the application.

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

Hierarchy

Defaults

Implements

XMLElement<"defaults", DefaultsAttributes, DefaultsContents>

Constructors

constructor

new Defaults(opts?): Defaults
Parameters
- Optional opts: {
  attributes?: Partial<DefaultsAttributes>;
  contents?: DefaultsContents;
  }
  - Optional attributes?: Partial<DefaultsAttributes>
  - Optional contents?: DefaultsContents
Returns Defaults
- Defined in generated/elements.ts:3048

Properties

attributes

attributes: DefaultsAttributes

contents: DefaultsContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "optional";
        value: typeof Scaling;
    }, {
        type: "optional";
        value: typeof ConcertScore;
    }, {
        type: "optional";
        value: typeof PageLayout;
    }, {
        type: "optional";
        value: typeof SystemLayout;
    }, {
        label: "staff-layouts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof StaffLayout;
        };
    }, {
        type: "optional";
        value: typeof Appearance;
    }, {
        type: "optional";
        value: typeof MusicFont;
    }, {
        type: "optional";
        value: typeof WordFont;
    }, {
        label: "lyric-fonts";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof LyricFont;
        };
    }, {
        label: "lyric-languages";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof LyricLanguage;
        };
    }];
    name: "defaults";
} = Defaults.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof Scaling;
}, {
    type: "optional";
    value: typeof ConcertScore;
}, {
    type: "optional";
    value: typeof PageLayout;
}, {
    type: "optional";
    value: typeof SystemLayout;
}, {
    label: "staff-layouts";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffLayout;
    };
}, {
    type: "optional";
    value: typeof Appearance;
}, {
    type: "optional";
    value: typeof MusicFont;
}, {
    type: "optional";
    value: typeof WordFont;
}, {
    label: "lyric-fonts";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof LyricFont;
    };
}, {
    label: "lyric-languages";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof LyricLanguage;
    };
}]
Readonly name: "defaults"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof Scaling;
}, {
    type: "optional";
    value: typeof ConcertScore;
}, {
    type: "optional";
    value: typeof PageLayout;
}, {
    type: "optional";
    value: typeof SystemLayout;
}, {
    label: "staff-layouts";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof StaffLayout;
    };
}, {
    type: "optional";
    value: typeof Appearance;
}, {
    type: "optional";
    value: typeof MusicFont;
}, {
    type: "optional";
    value: typeof WordFont;
}, {
    label: "lyric-fonts";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof LyricFont;
    };
}, {
    label: "lyric-languages";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof LyricLanguage;
    };
}]
Readonly name: "defaults"

Methods

getAppearance

getAppearance(): null | Appearance
Gets

Returns null | Appearance
- Defined in generated/elements.ts:3099

getConcertScore

getConcertScore(): null | ConcertScore
Gets

Returns null | ConcertScore
- Defined in generated/elements.ts:3063

getLyricFonts

getLyricFonts(): LyricFont[]
Gets

Returns LyricFont[]
- Defined in generated/elements.ts:3126

getLyricLanguages

getLyricLanguages(): LyricLanguage[]
Gets

Returns LyricLanguage[]
- Defined in generated/elements.ts:3135

getMusicFont

getMusicFont(): null | MusicFont
Gets

Returns null | MusicFont
- Defined in generated/elements.ts:3108

getPageLayout

getPageLayout(): null | PageLayout
Gets

Returns null | PageLayout
- Defined in generated/elements.ts:3072

getScaling

getScaling(): null | Scaling
Gets

Returns null | Scaling
- Defined in generated/elements.ts:3054

getStaffLayouts

getStaffLayouts(): StaffLayout[]
Gets

Returns StaffLayout[]
- Defined in generated/elements.ts:3090

getSystemLayout

getSystemLayout(): null | SystemLayout
Gets

Returns null | SystemLayout
- Defined in generated/elements.ts:3081

getWordFont

getWordFont(): null | WordFont
Gets

Returns null | WordFont
- Defined in generated/elements.ts:3117

setAppearance

setAppearance(appearance): Defaults
Sets
Parameters
- appearance: null | Appearance
Returns Defaults
- Defined in generated/elements.ts:3103

setConcertScore

setConcertScore(concertScore): Defaults
Sets
Parameters
- concertScore: null | ConcertScore
Returns Defaults
- Defined in generated/elements.ts:3067

setLyricFonts

setLyricFonts(lyricFonts): Defaults
Sets
Parameters
- lyricFonts: LyricFont[]
Returns Defaults
- Defined in generated/elements.ts:3130

setLyricLanguages

setLyricLanguages(lyricLanguages): Defaults
Sets
Parameters
- lyricLanguages: LyricLanguage[]
Returns Defaults
- Defined in generated/elements.ts:3139

setMusicFont

setMusicFont(musicFont): Defaults
Sets
Parameters
- musicFont: null | MusicFont
Returns Defaults
- Defined in generated/elements.ts:3112

setPageLayout

setPageLayout(pageLayout): Defaults
Sets
Parameters
- pageLayout: null | PageLayout
Returns Defaults
- Defined in generated/elements.ts:3076

setScaling

setScaling(scaling): Defaults
Sets
Parameters
- scaling: null | Scaling
Returns Defaults
- Defined in generated/elements.ts:3058

setStaffLayouts

setStaffLayouts(staffLayouts): Defaults
Sets
Parameters
- staffLayouts: StaffLayout[]
Returns Defaults
- Defined in generated/elements.ts:3094

setSystemLayout

setSystemLayout(systemLayout): Defaults
Sets
Parameters
- systemLayout: null | SystemLayout
Returns Defaults
- Defined in generated/elements.ts:3085

setWordFont

setWordFont(wordFont): Defaults
Sets
Parameters
- wordFont: null | WordFont
Returns Defaults
- Defined in generated/elements.ts:3121

Class Defaults

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<DefaultsAttributes>; contents?: DefaultsContents; }

Optional attributes?: Partial<DefaultsAttributes>

Optional contents?: DefaultsContents

Returns Defaults

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly name: "defaults"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly name: "defaults"

Methods

getAppearance

Returns null | Appearance

getConcertScore

Returns null | ConcertScore

getLyricFonts

Returns LyricFont[]

getLyricLanguages

Returns LyricLanguage[]

getMusicFont

Returns null | MusicFont

getPageLayout

Returns null | PageLayout

getScaling

Returns null | Scaling

getStaffLayouts

Returns StaffLayout[]

getSystemLayout

Returns null | SystemLayout

getWordFont

Returns null | WordFont

setAppearance

Parameters

appearance: null | Appearance

Returns Defaults

setConcertScore

Parameters

concertScore: null | ConcertScore

Returns Defaults

setLyricFonts

Parameters

lyricFonts: LyricFont[]

Returns Defaults

setLyricLanguages

Parameters

lyricLanguages: LyricLanguage[]

Returns Defaults

setMusicFont

Parameters

musicFont: null | MusicFont

Returns Defaults

setPageLayout

Parameters

pageLayout: null | PageLayout

Returns Defaults

setScaling

Parameters

scaling: null | Scaling

Returns Defaults

setStaffLayouts

Parameters

staffLayouts: StaffLayout[]

Returns Defaults

setSystemLayout

Parameters

`Optional` opts: {
attributes?: Partial<DefaultsAttributes>;
contents?: DefaultsContents;
}

`Optional` attributes?: Partial<DefaultsAttributes>

`Optional` contents?: DefaultsContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` name: "defaults"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` name: "defaults"