Class Credit

The <credit> element

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

The <credit> element represents the appearance of the title, composer, arranger, lyricist, copyright, dedication, and other text, symbols, and graphics that commonly appear on the first page of a score. The <credit-words>, <credit-symbol>, and <credit-image> elements are similar to the <words>, <symbol>, and <image> elements for directions. However, since the credit is not part of a measure, the default-x and default-y attributes adjust the origin relative to the bottom left-hand corner of the page. The enclosure for <credit-words> and <credit-symbol> is none if not specified.

By default, a series of <credit-words> and <credit-symbol> elements within a single <credit> element follow one another in sequence visually. Non-positional formatting attributes are carried over from the previous element by default.

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

Hierarchy

Credit

Implements

XMLElement<"credit", CreditAttributes, CreditContents>

Index

Constructors

constructor

new Credit(opts?): Credit
Parameters
- Optional opts: {
  attributes?: Partial<CreditAttributes>;
  contents?: CreditContents;
  }
  - Optional attributes?: Partial<CreditAttributes>
  - Optional contents?: CreditContents
Returns Credit
- Defined in generated/elements.ts:4837

Properties

attributes

attributes: CreditAttributes

contents: CreditContents

`Readonly` schema

schema: {
    attributes: {
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        page: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    };
    contents: readonly [{
        label: "credit-types";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof CreditType;
        };
    }, {
        label: "links";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Link;
        };
    }, {
        label: "bookmarks";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof Bookmark;
        };
    }, {
        label: "value";
        type: "label";
        value: {
            choices: readonly [typeof CreditImage, {
                label: "credit-token";
                type: "label";
                value: readonly [{
                    choices: readonly [typeof CreditWords, typeof CreditSymbol];
                    type: "choices";
                }, {
                    type: "zeroOrMore";
                    value: readonly [{
                        type: "zeroOrMore";
                        value: typeof Link;
                    }, {
                        type: "zeroOrMore";
                        value: typeof Bookmark;
                    }, {
                        choices: readonly [typeof CreditWords, typeof CreditSymbol];
                        type: "choices";
                    }];
                }];
            }];
            type: "choices";
        };
    }];
    name: "credit";
} = Credit.schema

Type declaration

Readonly attributes: {
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    page: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- Readonly page: {
      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 contents: readonly [{
    label: "credit-types";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof CreditType;
    };
}, {
    label: "links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Link;
    };
}, {
    label: "bookmarks";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Bookmark;
    };
}, {
    label: "value";
    type: "label";
    value: {
        choices: readonly [typeof CreditImage, {
            label: "credit-token";
            type: "label";
            value: readonly [{
                choices: readonly [typeof CreditWords, typeof CreditSymbol];
                type: "choices";
            }, {
                type: "zeroOrMore";
                value: readonly [{
                    type: "zeroOrMore";
                    value: typeof Link;
                }, {
                    type: "zeroOrMore";
                    value: typeof Bookmark;
                }, {
                    choices: readonly [typeof CreditWords, typeof CreditSymbol];
                    type: "choices";
                }];
            }];
        }];
        type: "choices";
    };
}]
Readonly name: "credit"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    page: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- Readonly page: {
      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 contents: readonly [{
    label: "credit-types";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof CreditType;
    };
}, {
    label: "links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Link;
    };
}, {
    label: "bookmarks";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof Bookmark;
    };
}, {
    label: "value";
    type: "label";
    value: {
        choices: readonly [typeof CreditImage, {
            label: "credit-token";
            type: "label";
            value: readonly [{
                choices: readonly [typeof CreditWords, typeof CreditSymbol];
                type: "choices";
            }, {
                type: "zeroOrMore";
                value: readonly [{
                    type: "zeroOrMore";
                    value: typeof Link;
                }, {
                    type: "zeroOrMore";
                    value: typeof Bookmark;
                }, {
                    choices: readonly [typeof CreditWords, typeof CreditSymbol];
                    type: "choices";
                }];
            }];
        }];
        type: "choices";
    };
}]
Readonly name: "credit"

Methods

getBookmarks

getBookmarks(): Bookmark[]
Gets

Returns Bookmark[]
- Defined in generated/elements.ts:4878

getCreditTypes

getCreditTypes(): CreditType[]
Gets

Returns CreditType[]
- Defined in generated/elements.ts:4860

getId

getId(): null | string
Gets

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

getLinks

getLinks(): Link[]
Gets

Returns Link[]
- Defined in generated/elements.ts:4869

getPage

getPage(): null | number
Gets

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

getValue

getValue(): CreditImage | CreditToken
Gets

Returns CreditImage | CreditToken
- Defined in generated/elements.ts:4887

setBookmarks

setBookmarks(bookmarks): Credit
Sets
Parameters
- bookmarks: Bookmark[]
Returns Credit
- Defined in generated/elements.ts:4882

setCreditTypes

setCreditTypes(creditTypes): Credit
Sets
Parameters
- creditTypes: CreditType[]
Returns Credit
- Defined in generated/elements.ts:4864

setId

setId(id): Credit
Sets
Parameters
- id: null | string
Returns Credit
- Defined in generated/elements.ts:4846

setLinks

setLinks(links): Credit
Sets
Parameters
- links: Link[]
Returns Credit
- Defined in generated/elements.ts:4873

setPage

setPage(page): Credit
Sets
Parameters
- page: null | number
Returns Credit
- Defined in generated/elements.ts:4855

setValue

setValue(value): Credit
Sets
Parameters
- value: CreditImage | CreditToken
Returns Credit
- Defined in generated/elements.ts:4891

Class Credit

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<CreditAttributes>; contents?: CreditContents; }

Optional attributes?: Partial<CreditAttributes>

Optional contents?: CreditContents

Returns Credit

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; page: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }; }

Readonly id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly page: { 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 name: "credit"

Static Readonly schema

Type declaration

Readonly attributes: { id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; page: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }; }

Readonly id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly page: { 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 name: "credit"

Methods

getBookmarks

Returns Bookmark[]

getCreditTypes

Returns CreditType[]

getId

Returns null | string

getLinks

Returns Link[]

getPage

Returns null | number

getValue

Returns CreditImage | CreditToken

setBookmarks

Parameters

bookmarks: Bookmark[]

Returns Credit

setCreditTypes

Parameters

creditTypes: CreditType[]

Returns Credit

setId

Parameters

id: null | string

Returns Credit

setLinks

Parameters

links: Link[]

Returns Credit

setPage

Parameters

`Optional` opts: {
attributes?: Partial<CreditAttributes>;
contents?: CreditContents;
}

`Optional` attributes?: Partial<CreditAttributes>

`Optional` contents?: CreditContents

`Readonly` schema

`Readonly` attributes: {
id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
page: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
};
}

`Readonly` id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` page: {
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` name: "credit"

`Static` `Readonly` schema

`Readonly` attributes: {
id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
page: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
};
}

`Readonly` id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` page: {
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` name: "credit"