dev
    Preparing search index...

    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 (View Summary)

    Index

    Constructors

    Properties

    _fontInfo: Required<FontInfo>
    _height: number = 0
    _text: string = ''
    _textMetrics: TextMetrics = ...
    _width: number = 0
    botRenderY: number = 0
    botStartX: number = 0
    botText: Element
    bottomLine: number
    children: Element[] = []
    fontScale: number
    isNumeric: boolean = true
    layoutMetrics?: LayoutMetrics
    line: number = 0
    lineShift: number = 0
    metricsValid: boolean = false
    padding: number
    parent?: Element
    registry?: Registry
    rendered: boolean
    shouldDrawPointerRect: boolean
    stave?: Stave
    style: ElementStyle = {}
    timeSpec: string = '4/4'
    topLine: number
    topRenderY: number = 0
    topStartX: number = 0
    topText: Element
    validateArgs: boolean
    x: number = 0
    xShift: number = 0
    y: number = 0
    yShift: number = 0
    ID: number = 1000

    Accessors

    • get font(): string

      Returns the CSS compatible font string for the text font.

      Returns string

    • set font(f: string): 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 fontSize(): string

      Returns string

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

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

      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: string): 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: string | number): void

      Set the font weight.

      Parameters

      • weight: string | number

      Returns void

    Methods

    • Adds a child 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 this

    • 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 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 the timeSpec (such as '4/4' or 'C|' or even '2/4+3/8') of the TimeSignature

      Returns string

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

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

      • Optionalsize: string | number

        a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').

      • Optionalweight: string | number

        is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).

      • Optionalstyle: 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 this

    • 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.drawWithStyle();

      Note: If the element draws additional sub-elements (i.e.: 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.drawWithStyle();

      or using drawWithStyle:

      element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
      element.drawWithStyle();

      Parameters

      Returns this

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

      The getter for this is getTimeSpec not getTimeSig.

      Parameters

      • timeSpec: string

      Returns this

    • Parameters

      • key: string
      • smallSig: boolean = false

      Returns string