Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Properties

Static TEXT_FONT

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

font

  • get font(): string
  • set font(f: string): void
  • Returns the CSS compatible font string.

    Returns string

  • Provide a CSS compatible font string (e.g., 'bold 16px Arial').

    Parameters

    • f: string

    Returns void

fontInfo

  • Return a copy of the current FontInfo object.

    Returns Required<FontInfo>

  • Return a copy of the current FontInfo object.

    Parameters

    Returns void

fontSize

  • get fontSize(): string
  • set fontSize(size: string | number): 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').

    Returns string

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

  • 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

fontSizeInPixels

  • get fontSizeInPixels(): number
  • Returns number

    the font size in px.

fontSizeInPoints

  • get fontSizeInPoints(): number
  • Returns number

    the font size in pt.

fontStyle

  • get fontStyle(): string
  • set fontStyle(style: string): void
  • Returns string

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

  • Parameters

    • style: string

    Returns void

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

fontWeight

  • get fontWeight(): string
  • set fontWeight(weight: string | number): void
  • 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.

  • Parameters

    • weight: string | number

    Returns void

    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.

Static CATEGORY

  • 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

Static Position

  • Modifiers can be positioned almost anywhere, relative to a note.

    Returns typeof ModifierPosition

Static PositionString

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

Methods

addChildElement

addClass

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

    Parameters

    • className: string

    Returns Modifier

alignSubNotesWithNote

  • alignSubNotesWithNote(subNotes: Note[], note: Note): void
  • Parameters

    Returns void

applyStyle

checkAttachedNote

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

    Returns Note

checkContext

checkIndex

  • checkIndex(): number
  • Check and get note index, which is a specific note in a chord.

    Returns number

checkModifierContext

draw

  • draw(): void
  • Render the modifier onto the canvas.

    Returns void

drawWithStyle

  • drawWithStyle(): void
  • Draw the element and all its sub-elements (ie.: Modifiers in a Stave) with the element style.

    Returns void

getAttribute

  • getAttribute(name: string): any

getAttributes

getBoundingBox

getCategory

  • getCategory(): string

getContext

getFont

  • getFont(): string

getFontSize

  • getFontSize(): 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.

getIndex

  • getIndex(): undefined | number
  • Get note index, which is a specific note in a chord.

    Returns undefined | number

getModifierContext

getNote

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

    Returns Note

getPosition

  • getPosition(): number
  • Get position.

    Returns number

getSVGElement

  • getSVGElement(suffix?: string): undefined | SVGElement
  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

getSpacingFromNextModifier

  • getSpacingFromNextModifier(): number
  • Get spacing from next modifier.

    Returns number

getStyle

getWidth

  • getWidth(): number
  • Get modifier widths.

    Returns number

getXShift

  • getXShift(): number
  • Get shift modifier x

    Returns number

hasClass

  • hasClass(className: string): boolean
  • Check if it has a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns boolean

isRendered

  • isRendered(): boolean

onRegister

removeClass

  • removeClass(className: string): Modifier
  • Remove a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Modifier

resetFont

  • resetFont(): void
  • 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

restoreStyle

setAttribute

  • setAttribute(name: string, value: any): Modifier

setContext

setFont

  • setFont(font?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): Modifier
  • Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).

    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

setFontSize

  • setFontSize(size?: string | number): Modifier
  • Change the font size, while keeping everything else the same.

    Parameters

    • Optional size: string | number

    Returns Modifier

setGroupStyle

setIndex

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

    Parameters

    • index: number

    Returns Modifier

setModifierContext

setNote

  • Set attached note.

    Parameters

    • note: Note

      (StaveNote, TabNote, etc.)

    Returns Modifier

setPosition

  • setPosition(position: string | number): Modifier
  • Set position.

    Parameters

    • position: string | number

      CENTER | LEFT | RIGHT | ABOVE | BELOW

    Returns Modifier

setRendered

  • setRendered(rendered?: boolean): Modifier

setSpacingFromNextModifier

  • setSpacingFromNextModifier(x: number): void
  • Set spacing from next modifier.

    Parameters

    • x: number

    Returns void

setStyle

  • 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

setTextLine

  • Set the text_line for the modifier.

    Parameters

    • line: number

    Returns Modifier

setWidth

  • Set modifier widths.

    Parameters

    • width: number

    Returns Modifier

setXShift

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

    Parameters

    • x: number

    Returns Modifier

setYShift

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

    Parameters

    • y: number

    Returns Modifier