OpenSheetMusicDisplay
    Preparing search index...

    Class GraphicalLabel

    The graphical counterpart of a Label

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    AnchoredToPageBottom: boolean = false

    Whether this page label is positioned from the page bottom, i.e. below the last music system, like the copyright (see MusicSheetCalculator.calculatePageLabels()), rather than from the page top like the title block (title, subtitle, composer, lyricist). While an incremental render (OpenSheetMusicDisplay.renderNext()) grows the page, the last system moves down with every batch, so such a label is drawn only with the final batch, once its position is final (#1710).

    boundingBox: BoundingBox
    CenteringXShift: number = 0

    Read-only informational variable only set once by lyrics centering algorithm.

    ColorXML: string
    dataObject: Object
    sourceNote: Note

    The note this label was created for, if any. Set for fingerings (GraphicalStaffEntry.FingeringEntries), which are stacked in the pitch order of their notes rather than the order they were read in, so that the note a fingering belongs to can be told without re-deriving that order. Named like GraphicalNote.sourceNote, which holds the same kind of reference.

    SVGNode: Node

    A reference to the Node in the SVG, if SVGBackend, otherwise undefined. Allows manipulation without re-rendering, e.g. for dynamics, lyrics, etc. For the Canvas backend, this is unfortunately not possible.

    TextLines: { text: string; width: number; xOffset: number }[]

    Accessors

    Methods

    • Calculate GraphicalLabel's Borders according to its Alignment Create also the text-lines and their offsets here

      Returns void