Class MDocument

Document object.

Hierarchy (View Summary)

MusicInterface
- MDocument

Index

Properties

Methods

bindElement getArranger getComposer getDefaultPlayer getMeasures getParent getRows getTitle play unbindElement

Properties

`Readonly`name

name: string

OBject name.

`Static` `Readonly`Name

Name: "Document"

Object name.

Methods

bindElement

bindElement(elem: string | HTMLElement): boolean
Bind this document to custom HTML element.
Parameters
- elem: string | HTMLElement
  HTML element id or element.
Returns boolean
- Boolean whether bind was succesfull.

getArranger

getArranger(): string | undefined
Get arranger.

Returns string | undefined
- Arranger string or undefined.

getComposer

getComposer(): string | undefined
Get composer.

Returns string | undefined
- Composer string or undefined.

getDefaultPlayer

getDefaultPlayer(): Player
Get default player.

Returns Player
- Player.

getMeasures

getMeasures(): readonly MMeasure[]
Get measures.

Returns readonly MMeasure[]
- Array of measures.

getParent

getParent(): MusicInterface | undefined
Get parent object.

Returns MusicInterface | undefined
- Parent object or undefined.
Inherited from MusicInterface.getParent

getRows

getRows(): readonly MScoreRow[]
Get score rows.

Returns readonly MScoreRow[]
- Array or score rows.

getTitle

getTitle(): string | undefined
Get title.

Returns string | undefined
- Title string or undefined.

play

play(playStateChangeListener?: PlayStateChangeListener): Player
Play this document.
Parameters
- OptionalplayStateChangeListener: PlayStateChangeListener
  Play state change listener function or undefined.
Returns Player
- Player instance.

unbindElement

unbindElement(elem: string | HTMLElement): boolean
Unbind this document from custom HTML element.
Parameters
- elem: string | HTMLElement
  HTML element id or element.
Returns boolean
- Boolean whether unbind was succesfull.