Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Clef

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

See tests/clef_tests.ts for usage examples.

Hierarchy

Index

Constructors

  • new Clef(type: string, size?: string, annotation?: string): Clef

Properties

annotation?: ClefAnnotatiomType
clef: ClefType = ...

The attribute clef must be a key from Clef.types

DEBUG: boolean = false

To enable logging for this class, set Vex.Flow.Clef.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
  • Returns string

  • get annotationSmufl(): Record<string, string>
  • Returns Record<string, string>

  • Every clef name is associated with a glyph code from the font file and a default stave line number.

    Returns Record<string, ClefType>

Methods

  • addClass(className: string): Clef
  • Add a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Clef

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

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

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • getStave(): undefined | Stave
  • getWidth(): number
  • getX(): 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
  • placeGlyphOnLine(glyph: Glyph, stave: Stave, line?: number, customShift?: number): void
  • removeClass(className: string): Clef
  • Remove a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Clef

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

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

    Parameters

    • Optional size: string | number

    Returns Clef

  • setPadding(padding: number): Clef
  • setPosition(position: number): Clef
  • setRendered(rendered?: boolean): 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

  • setType(type: string, size?: string, annotation?: string): Clef
  • Set clef type, size and annotation.

    Parameters

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

    Returns Clef

  • setWidth(width: number): Clef
  • setX(x: number): Clef