Class PartGroup

The <part-list> element

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

The <part-list> element identifies the different musical parts in this document. Each part has an ID that is used later within the musical data. Since parts may be encoded separately and combined later, identification elements are present at both the score and <score-part> levels.

There must be at least one <score-part>, combined as desired with <part-group> elements that indicate braces and brackets. Parts are ordered from top to bottom in a score based on the order in which they appear in the <part-list>.

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

Hierarchy

PartGroup

Implements

XMLElement<"part-group", PartGroupAttributes, PartGroupContents>

Constructors

constructor

new PartGroup(opts?): PartGroup
Parameters
- Optional opts: {
  attributes?: Partial<PartGroupAttributes>;
  contents?: PartGroupContents;
  }
  - Optional attributes?: Partial<PartGroupAttributes>
  - Optional contents?: PartGroupContents
Returns PartGroup
- Defined in generated/elements.ts:7574

Properties

attributes

attributes: PartGroupAttributes

contents: PartGroupContents

`Readonly` schema

schema: {
    attributes: {
        number: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        type: {
            type: "required";
            value: {
                choices: readonly ["start", "stop"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof GroupName;
    }, {
        type: "optional";
        value: typeof GroupNameDisplay;
    }, {
        type: "optional";
        value: typeof GroupAbbreviation;
    }, {
        type: "optional";
        value: typeof GroupAbbreviationDisplay;
    }, {
        type: "optional";
        value: typeof GroupSymbol;
    }, {
        type: "optional";
        value: typeof GroupBarline;
    }, {
        type: "optional";
        value: typeof GroupTime;
    }, {
        type: "optional";
        value: typeof Footnote;
    }, {
        type: "optional";
        value: typeof Level;
    }];
    name: "part-group";
} = PartGroup.schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: typeof GroupName;
}, {
    type: "optional";
    value: typeof GroupNameDisplay;
}, {
    type: "optional";
    value: typeof GroupAbbreviation;
}, {
    type: "optional";
    value: typeof GroupAbbreviationDisplay;
}, {
    type: "optional";
    value: typeof GroupSymbol;
}, {
    type: "optional";
    value: typeof GroupBarline;
}, {
    type: "optional";
    value: typeof GroupTime;
}, {
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}]
Readonly name: "part-group"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    type: {
        type: "required";
        value: {
            choices: readonly ["start", "stop"];
            type: "choices";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["start", "stop"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["start", "stop"];
    type: "choices";
    }
    - Readonly choices: readonly ["start", "stop"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "optional";
    value: typeof GroupName;
}, {
    type: "optional";
    value: typeof GroupNameDisplay;
}, {
    type: "optional";
    value: typeof GroupAbbreviation;
}, {
    type: "optional";
    value: typeof GroupAbbreviationDisplay;
}, {
    type: "optional";
    value: typeof GroupSymbol;
}, {
    type: "optional";
    value: typeof GroupBarline;
}, {
    type: "optional";
    value: typeof GroupTime;
}, {
    type: "optional";
    value: typeof Footnote;
}, {
    type: "optional";
    value: typeof Level;
}]
Readonly name: "part-group"

Methods

getFootnote

getFootnote(): null | Footnote
Gets

Returns null | Footnote
- Defined in generated/elements.ts:7660

getGroupAbbreviation

getGroupAbbreviation(): null | GroupAbbreviation
Gets

Returns null | GroupAbbreviation
- Defined in generated/elements.ts:7615

getGroupAbbreviationDisplay

getGroupAbbreviationDisplay(): null | GroupAbbreviationDisplay
Gets

Returns null | GroupAbbreviationDisplay
- Defined in generated/elements.ts:7624

getGroupBarline

getGroupBarline(): null | GroupBarline
Gets

Returns null | GroupBarline
- Defined in generated/elements.ts:7642

getGroupName

getGroupName(): null | GroupName
Gets

Returns null | GroupName
- Defined in generated/elements.ts:7597

getGroupNameDisplay

getGroupNameDisplay(): null | GroupNameDisplay
Gets

Returns null | GroupNameDisplay
- Defined in generated/elements.ts:7606

getGroupSymbol

getGroupSymbol(): null | GroupSymbol
Gets

Returns null | GroupSymbol
- Defined in generated/elements.ts:7633

getGroupTime

getGroupTime(): null | GroupTime
Gets

Returns null | GroupTime
- Defined in generated/elements.ts:7651

getLevel

getLevel(): null | Level
Gets

Returns null | Level
- Defined in generated/elements.ts:7669

getNumber

getNumber(): null | string
Gets

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

getType

getType(): "start" | "stop"
Gets

Returns "start" | "stop"
- Defined in generated/elements.ts:7579

setFootnote

setFootnote(footnote): PartGroup
Sets
Parameters
- footnote: null | Footnote
Returns PartGroup
- Defined in generated/elements.ts:7664

setGroupAbbreviation

setGroupAbbreviation(groupAbbreviation): PartGroup
Sets
Parameters
- groupAbbreviation: null | GroupAbbreviation
Returns PartGroup
- Defined in generated/elements.ts:7619

setGroupAbbreviationDisplay

setGroupAbbreviationDisplay(groupAbbreviationDisplay): PartGroup
Sets
Parameters
- groupAbbreviationDisplay: null | GroupAbbreviationDisplay
Returns PartGroup
- Defined in generated/elements.ts:7628

setGroupBarline

setGroupBarline(groupBarline): PartGroup
Sets
Parameters
- groupBarline: null | GroupBarline
Returns PartGroup
- Defined in generated/elements.ts:7646

setGroupName

setGroupName(groupName): PartGroup
Sets
Parameters
- groupName: null | GroupName
Returns PartGroup
- Defined in generated/elements.ts:7601

setGroupNameDisplay

setGroupNameDisplay(groupNameDisplay): PartGroup
Sets
Parameters
- groupNameDisplay: null | GroupNameDisplay
Returns PartGroup
- Defined in generated/elements.ts:7610

setGroupSymbol

setGroupSymbol(groupSymbol): PartGroup
Sets
Parameters
- groupSymbol: null | GroupSymbol
Returns PartGroup
- Defined in generated/elements.ts:7637

setGroupTime

setGroupTime(groupTime): PartGroup
Sets
Parameters
- groupTime: null | GroupTime
Returns PartGroup
- Defined in generated/elements.ts:7655

setLevel

setLevel(level): PartGroup
Sets
Parameters
- level: null | Level
Returns PartGroup
- Defined in generated/elements.ts:7673

setNumber

setNumber(number): PartGroup
Sets
Parameters
- number: null | string
Returns PartGroup
- Defined in generated/elements.ts:7592

setType

setType(type): PartGroup
Sets
Parameters
- type: "start" | "stop"
Returns PartGroup
- Defined in generated/elements.ts:7583

Class PartGroup

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PartGroupAttributes>; contents?: PartGroupContents; }

Optional attributes?: Partial<PartGroupAttributes>

Optional contents?: PartGroupContents

Returns PartGroup

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { number: { type: "optional"; value: { type: "string"; }; }; type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }; }

Readonly number: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["start", "stop"]; type: "choices"; }

Readonly choices: readonly ["start", "stop"]

Readonly type: "choices"

Readonly name: "part-group"

Static Readonly schema

Type declaration

Readonly attributes: { number: { type: "optional"; value: { type: "string"; }; }; type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }; }

Readonly number: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly type: { type: "required"; value: { choices: readonly ["start", "stop"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["start", "stop"]; type: "choices"; }

Readonly choices: readonly ["start", "stop"]

Readonly type: "choices"

Readonly name: "part-group"

Methods

getFootnote

Returns null | Footnote

getGroupAbbreviation

Returns null | GroupAbbreviation

getGroupAbbreviationDisplay

Returns null | GroupAbbreviationDisplay

getGroupBarline

Returns null | GroupBarline

getGroupName

Returns null | GroupName

getGroupNameDisplay

Returns null | GroupNameDisplay

getGroupSymbol

Returns null | GroupSymbol

getGroupTime

Returns null | GroupTime

getLevel

Returns null | Level

getNumber

Returns null | string

getType

Returns "start" | "stop"

setFootnote

Parameters

footnote: null | Footnote

Returns PartGroup

setGroupAbbreviation

Parameters

groupAbbreviation: null | GroupAbbreviation

Returns PartGroup

setGroupAbbreviationDisplay

Parameters

groupAbbreviationDisplay: null | GroupAbbreviationDisplay

Returns PartGroup

setGroupBarline

Parameters

`Optional` opts: {
attributes?: Partial<PartGroupAttributes>;
contents?: PartGroupContents;
}

`Optional` attributes?: Partial<PartGroupAttributes>

`Optional` contents?: PartGroupContents

`Readonly` schema

`Readonly` attributes: {
number: {
type: "optional";
value: {
type: "string";
};
};
type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
};
}

`Readonly` number: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["start", "stop"];
type: "choices";
}

`Readonly` choices: readonly ["start", "stop"]

`Readonly` type: "choices"

`Readonly` name: "part-group"

`Static` `Readonly` schema

`Readonly` attributes: {
number: {
type: "optional";
value: {
type: "string";
};
};
type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
};
}

`Readonly` number: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` type: {
type: "required";
value: {
choices: readonly ["start", "stop"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["start", "stop"];
type: "choices";
}

`Readonly` choices: readonly ["start", "stop"]

`Readonly` type: "choices"

`Readonly` name: "part-group"