Class Clef

Clef implements various types of clefs that can be rendered on a stave.

See tests/clef_tests.ts for usage examples.

Hierarchy

Constructors

  • Create a new clef.

    Parameters

    • type: string
    • Optional size: string
    • Optional annotation: string

    Returns Clef

Properties

code: string = ...

The attribute clef must be a key from Clef.types

line: number = ...
DEBUG: boolean = false

To enable logging for this class, set VexFlow.Clef.DEBUG to true.

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
  • Set the current FontInfo object.

    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
  • Set the font style.

    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
  • Set the font weight.

    Parameters

    • weight: string | number

    Returns void

  • get height(): number
  • Returns number

  • set height(height): void
  • Parameters

    • height: number

    Returns void

  • get text(): string
  • Returns string

  • set text(text): void
  • Parameters

    • text: string

    Returns void

  • get textMetrics(): TextMetrics
  • Returns TextMetrics

  • get width(): number
  • Returns number

  • set width(width): void
  • Parameters

    • width: number

    Returns void

  • get CATEGORY(): string
  • Returns string

  • get types(): Record<string, {
        code: string;
        line: number;
    }>
  • Every clef name is associated with a glyph code from the font file and a default stave line number.

    Returns Record<string, {
        code: string;
        line: 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 Clef

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

    Parameters

    • className: string

    Returns Clef

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

  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

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

    Parameters

    • className: string

    Returns boolean

  • Measure the text using the textFont.

    Returns TextMetrics

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

    Parameters

    • className: string

    Returns Clef

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

    Parameters

    • name: string
    • value: undefined | string

    Returns Clef

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

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

    Parameters

    • Optional size: string | number

    Returns Clef

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

  • Set clef type, size and annotation.

    Parameters

    • type: string
    • size: string = 'default'
    • Optional annotation: string

    Returns Clef

  • Set shift element right xShift pixels. Negative values shift left.

    Parameters

    • xShift: number

    Returns Clef

  • Shift element down yShift pixels. Negative values shift up.

    Parameters

    • yShift: number

    Returns Clef

  • Get point for clefs.

    Parameters

    • Optional size: string

    Returns number

  • Measure the text using the FontInfo related with key.

    Parameters

    • text: string
    • key: string = ''

    Returns number