Class Modifier

Modifier is an abstract interface for notational elements that modify a Note. Examples of modifiers are Accidental, Annotation, Stroke, etc.

For a Modifier instance to be positioned correctly, it must be part of a ModifierContext. All modifiers in the same context are rendered relative to one another.

Typically, all modifiers to a note are part of the same ModifierContext instance. Also, in multi-voice staves, all modifiers to notes on the same tick are part of the same ModifierContext. This ensures that multiple voices don't trample all over each other.

Hierarchy

Constructors

Properties

TEXT_FONT: Required<FontInfo> = ...

Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames) to customize the font for musical symbols placed on the score.

Accessors

  • get font(): string
  • Returns the CSS compatible font string for the text font.

    Returns string

  • set font(f): void
  • Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied to text (not glyphs).

    Parameters

    • f: string

    Returns void

  • get fontInfo(): Required<FontInfo>
  • Return a copy of the current FontInfo object.

    Returns Required<FontInfo>

  • set fontInfo(fontInfo): void
  • Parameters

    Returns void

  • get fontSize(): string
  • Returns string

    a CSS font-size string (e.g., '18pt', '12px', '1em').

  • set fontSize(size): void
  • The size is 1) a string of the form '10pt' or '16px', compatible with the CSS font-size property. or 2) a number, which is interpreted as a point size (i.e. 12 == '12pt').

    Parameters

    • size: string | number

    Returns void

  • get fontSizeInPixels(): number
  • Returns number

    the font size in px.

  • get fontSizeInPoints(): number
  • Returns number

    the font size in pt.

  • get fontStyle(): string
  • Returns string

    a CSS font-style string (e.g., 'italic').

  • set fontStyle(style): void
  • Parameters

    • style: string

    Returns void

  • get fontWeight(): string
  • Returns string

    a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.

  • set fontWeight(weight): void
  • Parameters

    • weight: string | number

    Returns void

  • get CATEGORY(): string
  • Modifiers category string. Every modifier has a different category. The ModifierContext uses this to determine the type and order of the modifiers.

    Returns string

  • get PositionString(): Record<string, number>
  • Returns Record<string, number>

Methods

  • Adds a child Element to the Element, which lets it inherit the same style as the parent when setGroupStyle() is called.

    Examples of children are noteheads and stems. Modifiers such as Accidentals are generally not set as children.

    Note that StaveNote calls setGroupStyle() when setStyle() is called.

    Parameters

    Returns Modifier

  • Add a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Modifier

  • Parameters

    Returns void

  • Used in draw() to check and get the attached note (StaveNote, TabNote, etc.). Also verifies that the index is valid.

    Returns Note

  • Check and get note index, which is a specific note in a chord.

    Returns number

  • Render the modifier onto the canvas.

    Returns void

  • Draw the element and all its sub-elements (ie.: Modifiers in a Stave) with the element's style (see getStyle() and setStyle())

    Returns void

  • Return an attribute, such as 'id', 'type' or 'class'.

    Parameters

    • name: string

    Returns any

  • Get the css string describing this Element's text font. e.g., 'bold 10pt Arial'.

    Returns string

  • Returns string

    a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.

  • Get note index, which is a specific note in a chord.

    Returns undefined | number

  • Get attached note (StaveNote, TabNote, etc.)

    Returns Note

  • Get position.

    Returns number

  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • Get spacing from next modifier.

    Returns number

  • Get modifier widths.

    Returns number

  • Get shift modifier x

    Returns number

  • Check if it has a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns boolean

  • Return the rendered status.

    Returns boolean

  • Remove a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Modifier

  • Reset the text font to the style indicated by the static TEXT_FONT property. Subclasses can call this to initialize textFont for the first time.

    Returns void

  • Set an attribute such as 'id', 'class', or 'type'.

    Parameters

    • name: string
    • value: undefined | string

    Returns Modifier

  • Set the element's text font family, size, weight, style (e.g., Arial, 10pt, bold, italic).

    This attribute does not determine the font used for musical Glyphs like treble clefs.

    Parameters

    • Optional font: string | FontInfo

      is 1) a FontInfo object or 2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or 3) a string representing the font family (at least one of size, weight, or style must also be provided).

    • Optional size: string | number

      a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').

    • Optional weight: string | number

      is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).

    • Optional style: string

      is a string (e.g., 'italic', 'normal'). If no arguments are provided, then the font is set to the default font. Each Element subclass may specify its own default by overriding the static TEXT_FONT property.

    Returns Modifier

  • Change the font size, while keeping everything else the same.

    Parameters

    • Optional size: string | number

    Returns Modifier

  • Set note index, which is a specific note in a chord.

    Parameters

    • index: number

    Returns Modifier

  • Set attached note.

    Parameters

    • note: Note

      (StaveNote, TabNote, etc.)

    Returns Modifier

  • Set position.

    Parameters

    • position: string | number

      CENTER | LEFT | RIGHT | ABOVE | BELOW

    Returns Modifier

  • Set spacing from next modifier.

    Parameters

    • x: number

    Returns void

  • Set the element style used to render.

    Example:

    element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
    element.draw();

    Note: If the element draws additional sub-elements (ie.: Modifiers in a Stave), the style can be applied to all of them by means of the context:

    element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
    element.getContext().setFillStyle('red');
    element.getContext().setStrokeStyle('red');
    element.draw();

    or using drawWithStyle:

    element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
    element.drawWithStyle();

    Parameters

    Returns Modifier

  • Set the text_line for the modifier.

    Parameters

    • line: number

    Returns Modifier

  • Set modifier widths.

    Parameters

    • width: number

    Returns Modifier

  • Shift modifier x pixels in the direction of the modifier. Negative values shift reverse.

    Parameters

    • x: number

    Returns Modifier

  • Shift modifier down y pixels. Negative values shift up.

    Parameters

    • y: number

    Returns Modifier