Class TimeSignature

A TimeSignature is a StaveModifier that can make its appropriate Glyphs directly from a provided "timeSpec" such as "4/4", "C|" (cut time), or even something more advanced such as "3/4(6/8)" or "2/4+5/8".

Hierarchy

Constructors

Properties

bottomLine: number
point: number
topLine: number
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
  • Returns string

  • get glyphs(): Record<string, {
        code: string;
        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 TimeSignature

  • Draw the time signature on a Stave using its RenderContext. Both setStave and setContext must already be run.

    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 the Glyph object used to create the time signature. Numeric time signatures such as 3/8 have a composite Glyph stored as a single Glyph object.

    Returns Glyph

  • Return a boolean on whether this TimeSignature is drawn with one or more numbers (such as 4/4) or not (as in cut time).

    Returns boolean

  • Return the staff line that the TimeSignature sits on. Generally 0 for numerator/ denominator time signatures such as 3/4 and 2 for cut/common.

    Returns number

  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • Return the timeSpec (such as '4/4' or 'C|' or even '2/4+3/8') of the TimeSignature

    Returns string

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

    Parameters

    • className: string

    Returns boolean

  • Returns a new TimeSignatureGlyph (a Glyph subclass that knows how to draw both top and bottom digits along with plus signs etc.)

    Parameters

    • topDigits: string
    • botDigits: string

    Returns TimeSignatureGlyph

  • Return TimeSignatureInfo given a string, consisting of line (number), num (boolean: same as TimeSignature.getIsNumeric()), and glyph (a Glyph or TimeSignatureGlyph object).

    Parameters

    • timeSpec: string

    Returns TimeSignatureInfo

  • Runs setYShift() for the Glyph object so that it matches the position of line for the Stave provided. A customShift can also be given (measured in the same units as setYShift not in lines) and this will be added after all other positions are calculated from the Stave.

    Note that this routine only sets the yShift; it does not actually "place" (meaning draw) the Glyph on the Stave. Call .draw() afterwards to do that.

    Parameters

    • glyph: Glyph
    • stave: Stave
    • Optional line: number
    • customShift: number = 0

    Returns 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

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

  • Set the Glyph object used to draw the time signature, and update the width of the TimeSignature to match. The Glyph must define width in its metrics.

    Parameters

    Returns void

  • Set whether this TimeSignature is drawn with one or more numbers.

    Parameters

    • isNumeric: boolean

    Returns void

  • Set the line number that the TimeSignature sits on. Half-values are acceptable for spaces, etc. Can be altered, for instance, for signatures that sit above the staff in large orchestral scores.

    Parameters

    • line: 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 TimeSignature

  • Set a new time signature specification without changing customPadding, etc.

    The getter for this is getTimeSpec not getTimeSig.

    Parameters

    • timeSpec: string

    Returns TimeSignature