Class ModifierContext

Index

Constructors

Properties

formatted members postFormatted preFormatted spacing state width DEBUG

Methods

addMember addModifier getLeftShift getMembers getMetrics getModifiers getRightShift getState getWidth postFormat preFormat

Constructors

constructor

new ModifierContext(): ModifierContext
Returns ModifierContext

Properties

`Protected`formatted

formatted: boolean = false

`Protected`members

members: Record<string, ModifierContextMember[]> = {}

`Protected`postFormatted

postFormatted: boolean = false

`Protected`preFormatted

preFormatted: boolean = false

`Protected`spacing

spacing: number = 0

`Protected`state

state: ModifierContextState = ...

`Protected`width

width: number = 0

`Static`DEBUG

DEBUG: boolean = false

Methods

addMember

addMember(member: ModifierContextMember): this
this.members maps CATEGORY strings to arrays of Tickable | Modifier | StaveNote | TabNote. Here we add a new member to this.members, and create a new array if needed.
Parameters
- member: ModifierContextMember
Returns this
this
- Defined in vexflow/src/modifiercontext.ts:88

addModifier

addModifier(member: ModifierContextMember): this
Parameters
- member: ModifierContextMember
Returns this
- Defined in vexflow/src/modifiercontext.ts:77

getLeftShift

getLeftShift(): number
Returns number
- Defined in vexflow/src/modifiercontext.ts:118

getMembers

getMembers(category: string): ModifierContextMember[]
Parameters
- category: string
Returns ModifierContextMember[]
- Defined in vexflow/src/modifiercontext.ts:107

getMetrics

getMetrics(): ModifierContextMetrics
Returns ModifierContextMetrics
- Defined in vexflow/src/modifiercontext.ts:130

getModifiers

getModifiers(category: string): ModifierContextMember[]
Parameters
- category: string
Returns ModifierContextMember[]
Deprecated
- Defined in vexflow/src/modifiercontext.ts:102

getRightShift

getRightShift(): number
Returns number
- Defined in vexflow/src/modifiercontext.ts:122

getState

getState(): ModifierContextState
Returns ModifierContextState
- Defined in vexflow/src/modifiercontext.ts:126

getWidth

getWidth(): number
Get the width of the entire

Returns number
- Defined in vexflow/src/modifiercontext.ts:114

postFormat

postFormat(): void
Returns void
- Defined in vexflow/src/modifiercontext.ts:170

preFormat

preFormat(): void
Returns void
- Defined in vexflow/src/modifiercontext.ts:141