Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Articulation

Articulations and Accents are modifiers that can be attached to notes. The complete list of articulations is available in tables.ts under Vex.Flow.articulationCodes.

See tests/articulation_tests.ts for usage examples.

Hierarchy

Index

Constructors

  • Create a new articulation.

    Parameters

    • type: string

      entry in Vex.Flow.articulationCodes in tables.ts or Glyph code.

      Notes (by default):

      • Glyph codes ending with 'Above' will be positioned ABOVE
      • Glyph codes ending with 'Below' will be positioned BELOW

    Returns Articulation

Properties

render_options: { font_scale: number }

Type declaration

  • font_scale: number
type: string

Articulation code provided to the constructor.

DEBUG: boolean = false

To enable logging for this class. Set Vex.Flow.Articulation.DEBUG to true.

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
  • 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

  • Return a copy of the current FontInfo object.

    Returns Required<FontInfo>

  • Return a copy of the current FontInfo object.

    Parameters

    Returns void

  • 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

  • get fontSizeInPixels(): number
  • Returns number

    the font size in px.

  • get fontSizeInPoints(): number
  • Returns number

    the font size in pt.

  • 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').

  • 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.

  • get CATEGORY(): string
  • Articulations category string.

    Returns string

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

    Returns typeof ModifierPosition

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

Methods

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

    Parameters

    • className: string

    Returns Articulation

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

    Returns Note

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

    Returns number

  • draw(): void
  • Render articulation in position next to note.

    Returns void

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

    Returns void

  • getAttribute(name: string): any
  • getCategory(): string
  • getFont(): string
  • 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(): undefined | number
  • Get note index, which is a specific note in a chord.

    Returns undefined | number

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

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

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

    Parameters

    • className: string

    Returns boolean

  • isRendered(): boolean
  • 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

  • setAttribute(name: string, value: undefined | string): Articulation
  • Set if articulation should be rendered between lines.

    Parameters

    • betweenLines: boolean = true

    Returns Articulation

  • setFont(font?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): Articulation
  • 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 Articulation

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

    Parameters

    • Optional size: string | number

    Returns Articulation

  • setSpacingFromNextModifier(x: number): 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 Articulation

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

    Parameters

    • x: number

    Returns Articulation

  • easyScoreHook(__namedParameters: { articulations: string }, note: StemmableNote, builder: Builder): void
  • Parameters

    • __namedParameters: { articulations: string }
      • articulations: string
    • note: StemmableNote
    • builder: Builder

    Returns void

  • FIXME: Most of the complex formatting logic (ie: snapping to space) is actually done in .render(). But that logic belongs in this method.

    Unfortunately, this isn't possible because, by this point, stem lengths have not yet been finalized. Finalized stem lengths are required to determine the initial position of any stem-side articulation.

    This indicates that all objects should have their stave set before being formatted. It can't be an optional if you want accurate vertical positioning. Consistently positioned articulations that play nice with other modifiers won't be possible until we stop relying on render-time formatting.

    Ideally, when this function has completed, the vertical articulation positions should be ready to render without further adjustment. But the current state is far from this ideal.

    Parameters

    Returns boolean