Options
All
  • Public
  • Public/Protected
  • All
Menu

A cursor which can iterate through the music sheet.

Hierarchy

  • Cursor

Index

Constructors

Properties

container: HTMLElement
currentPageNumber: number = 1
cursorElement: HTMLImageElement
cursorElementId: string

a unique id of the cursor's HTMLElement in the document. Should be constant between re-renders and backend changes, but different between different OSMD objects on the same page.

cursorOptions: CursorOptions
cursorOptionsRendered: CursorOptions
hidden: boolean = true
openSheetMusicDisplay: OpenSheetMusicDisplay
skipInvisibleNotes: boolean = true
wantedZIndex: string

The desired zIndex (layer) of the cursor when no background color is set. When a background color is set, using a negative zIndex would make the cursor invisible.

Accessors

  • get Hidden(): boolean
  • get SkipInvisibleNotes(): boolean
  • set SkipInvisibleNotes(value: boolean): void

Methods

  • Dispose(): void
  • adjustToBackgroundColor(): void
  • hide(): void
  • next(): void
  • previous(): void
  • reset(): void
  • resetIterator(): void
  • show(): void
  • update(): void
  • updateCurrentPage(): number
  • Check if there was a change in current page, and attach cursor element to the corresponding HTMLElement (div). This is only necessary if using PageFormat (multiple pages).

    Returns number

  • updateWidthAndStyle(measurePositionAndShape: BoundingBox, x: number, y: number, height: number): void

Generated using TypeDoc