Class ScoreObjectEvent

Score object event for clicking/entering/leaving score object.

Hierarchy (View Summary)

ScoreEvent
- ScoreObjectEvent

Index

Constructors

Properties

objects renderContext type

Accessors

renderer topObject

Methods

Constructors

constructor

new ScoreObjectEvent(
    type: ScoreEventType,
    renderContext: MRenderContext,
    objects: MusicInterface[],
): ScoreObjectEvent
Create new score object event.
Parameters
- type: ScoreEventType
  Score event type.
- renderContext: MRenderContext
  Render context.
- objects: MusicInterface[]
  Array of objects, last object in this array is the top object that was clicked/entered/left, previous objects are it's parent objects.
Returns ScoreObjectEvent
Overrides ScoreEvent.constructor

Properties

`Readonly`objects

objects: MusicInterface[]

Array of objects, last object in this array is the top object that was clicked/entered/left, previous objects are it's parent objects.

`Readonly`renderContext

renderContext: MRenderContext

Render context.

`Readonly`type

type: ScoreEventType

Score event type.

Accessors

renderer

get renderer(): MRenderer
Returns MRenderer
Deprecated
- Provided for legacy support, use renderContext instead.

topObject

get topObject(): MusicInterface
Top object getter.

Returns MusicInterface

Methods

findObject

findObject(fn: (obj: MusicInterface) => boolean): undefined | MusicInterface
Find object.
Parameters
- fn: (obj: MusicInterface) => boolean
  Compare function.
Returns undefined | MusicInterface
- First object that matched compare function, or undefined if no match.