Class MDocument

Hierarchy (View Summary)

MusicInterface
- MDocument

Index

Constructors

Properties

Methods

addMeasure getParent getTitle play setHeader updateCursorRect createSimpleScaleArpeggio

Constructors

constructor

new MDocument(
staffKind: StaffKind,
options?: number | DocumentOptions,
): MDocument
Parameters
- staffKind: StaffKind
- Optionaloptions: number | DocumentOptions
Returns MDocument
Overrides MusicInterface.constructor

Properties

`Readonly`name

name: string

`Static` `Readonly`Name

Name: "Document"

Methods

addMeasure

addMeasure(): MMeasure
Returns MMeasure

getParent

getParent(): undefined | MusicInterface
Returns undefined | MusicInterface
Inherited from MusicInterface.getParent

getTitle

getTitle(): undefined | string
Returns undefined | string

play

play(playStateChangeListener?: PlayStateChangeListener): MPlayer
Parameters
- OptionalplayStateChangeListener: PlayStateChangeListener
Returns MPlayer

setHeader

setHeader(title?: string, composer?: string, arranger?: string): void
Parameters
- Optionaltitle: string
- Optionalcomposer: string
- Optionalarranger: string
Returns void

updateCursorRect

updateCursorRect(cursorRect?: DivRect): void
Parameters
- OptionalcursorRect: DivRect
Returns void

`Static`createSimpleScaleArpeggio

createSimpleScaleArpeggio(
    staffKind: StaffKind,
    scale: Scale,
    lowestPitchNote: string,
    numOctaves: number,
): MDocument
Parameters
- staffKind: StaffKind
- scale: Scale
- lowestPitchNote: string
- numOctaves: number
Returns MDocument