Class Frame

The <frame> element.

The frame type represents a frame or fretboard diagram used together with a chord symbol. The representation is based on the NIFF guitar grid with additional information. The frame type's unplayed attribute indicates what to display above a string that has no associated frame-note element. Typical values are x and the empty string. If the attribute is not present, the display of the unplayed string is application-defined.

See

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

Hierarchy

Frame

Implements

XMLElement<"frame", FrameAttributes, FrameContents>

Constructors

constructor

new Frame(opts?): Frame
Parameters
- Optional opts: {
  attributes?: Partial<FrameAttributes>;
  contents?: FrameContents;
  }
  - Optional attributes?: Partial<FrameAttributes>
  - Optional contents?: FrameContents
Returns Frame
- Defined in generated/elements.ts:38443

Properties

attributes

attributes: FrameAttributes

contents: FrameContents

`Readonly` schema

schema: XMLElementSchema<"frame"> = Frame.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"frame"> = schema.Frame

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFirstFret

getFirstFret(): null | FirstFret
Gets

Returns null | FirstFret
- Defined in generated/elements.ts:38603

getFontFamily

getFontFamily(): null | string
Gets

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

getFontSize

getFontSize(): null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Gets

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
- Defined in generated/elements.ts:38484

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:38495

getFontWeight

getFontWeight(): null | "normal" | "bold"
Gets

Returns null | "normal" | "bold"
- Defined in generated/elements.ts:38504

getFrameFrets

getFrameFrets(): FrameFrets
Gets

Returns FrameFrets
- Defined in generated/elements.ts:38594

getFrameNotes

getFrameNotes(): FrameNote[]
Gets

Returns FrameNote[]
- Defined in generated/elements.ts:38612

getFrameStrings

getFrameStrings(): FrameStrings
Gets

Returns FrameStrings
- Defined in generated/elements.ts:38585

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:38513

getHeight

getHeight(): null | number
Gets

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getUnplayed

getUnplayed(): null | string
Gets

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

getValign

getValign(): null | "top" | "middle" | "bottom"
Gets

Returns null | "top" | "middle" | "bottom"
- Defined in generated/elements.ts:38567

getWidth

getWidth(): null | number
Gets

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

setColor

setColor(color): Frame
Sets
Parameters
- color: null | string
Returns Frame
- Defined in generated/elements.ts:38452

setDefaultX

setDefaultX(defaultX): Frame
Sets
Parameters
- defaultX: null | number
Returns Frame
- Defined in generated/elements.ts:38461

setDefaultY

setDefaultY(defaultY): Frame
Sets
Parameters
- defaultY: null | number
Returns Frame
- Defined in generated/elements.ts:38470

setFirstFret

setFirstFret(firstFret): Frame
Sets
Parameters
- firstFret: null | FirstFret
Returns Frame
- Defined in generated/elements.ts:38607

setFontFamily

setFontFamily(fontFamily): Frame
Sets
Parameters
- fontFamily: null | string
Returns Frame
- Defined in generated/elements.ts:38479

setFontSize

setFontSize(fontSize): Frame
Sets
Parameters
- fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"
Returns Frame
- Defined in generated/elements.ts:38488

setFontStyle

setFontStyle(fontStyle): Frame
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns Frame
- Defined in generated/elements.ts:38499

setFontWeight

setFontWeight(fontWeight): Frame
Sets
Parameters
- fontWeight: null | "normal" | "bold"
Returns Frame
- Defined in generated/elements.ts:38508

setFrameFrets

setFrameFrets(frameFrets): Frame
Sets
Parameters
- frameFrets: FrameFrets
Returns Frame
- Defined in generated/elements.ts:38598

setFrameNotes

setFrameNotes(frameNotes): Frame
Sets
Parameters
- frameNotes: FrameNote[]
Returns Frame
- Defined in generated/elements.ts:38616

setFrameStrings

setFrameStrings(frameStrings): Frame
Sets
Parameters
- frameStrings: FrameStrings
Returns Frame
- Defined in generated/elements.ts:38589

setHalign

setHalign(halign): Frame
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns Frame
- Defined in generated/elements.ts:38517

setHeight

setHeight(height): Frame
Sets
Parameters
- height: null | number
Returns Frame
- Defined in generated/elements.ts:38526

setId

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

setRelativeX

setRelativeX(relativeX): Frame
Sets
Parameters
- relativeX: null | number
Returns Frame
- Defined in generated/elements.ts:38544

setRelativeY

setRelativeY(relativeY): Frame
Sets
Parameters
- relativeY: null | number
Returns Frame
- Defined in generated/elements.ts:38553

setUnplayed

setUnplayed(unplayed): Frame
Sets
Parameters
- unplayed: null | string
Returns Frame
- Defined in generated/elements.ts:38562

setValign

setValign(valign): Frame
Sets
Parameters
- valign: null | "top" | "middle" | "bottom"
Returns Frame
- Defined in generated/elements.ts:38571

setWidth

setWidth(width): Frame
Sets
Parameters
- width: null | number
Returns Frame
- Defined in generated/elements.ts:38580

Class Frame

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<FrameAttributes>; contents?: FrameContents; }

Optional attributes?: Partial<FrameAttributes>

Optional contents?: FrameContents

Returns Frame

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getColor

Returns null | string

getDefaultX

Returns null | number

getDefaultY

Returns null | number

getFirstFret

Returns null | FirstFret

getFontFamily

Returns null | string

getFontSize

Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

Returns null | "normal" | "italic"

getFontWeight

Returns null | "normal" | "bold"

getFrameFrets

Returns FrameFrets

getFrameNotes

Returns FrameNote[]

getFrameStrings

Returns FrameStrings

getHalign

Returns null | "left" | "center" | "right"

getHeight

Returns null | number

getId

Returns null | string

getRelativeX

Returns null | number

getRelativeY

Returns null | number

getUnplayed

Returns null | string

getValign

Returns null | "top" | "middle" | "bottom"

getWidth

Returns null | number

setColor

Parameters

color: null | string

Returns Frame

setDefaultX

Parameters

defaultX: null | number

Returns Frame

setDefaultY

Parameters

defaultY: null | number

Returns Frame

setFirstFret

Parameters

firstFret: null | FirstFret

Returns Frame

setFontFamily

Parameters

fontFamily: null | string

Returns Frame

setFontSize

`Optional` opts: {
attributes?: Partial<FrameAttributes>;
contents?: FrameContents;
}

`Optional` attributes?: Partial<FrameAttributes>

`Optional` contents?: FrameContents

`Readonly` schema

`Static` `Readonly` schema