Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimeSignatureGlyph

Hierarchy

Index

Constructors

constructor

  • new TimeSignatureGlyph(timeSignature: TimeSignature, topDigits: string, botDigits: string, code: string, point: number, options?: { category: string }): TimeSignatureGlyph

Properties

bbox

bbox: BoundingBox = ...

botGlyphs

botGlyphs: Glyph[] = []

botStartX

botStartX: number

code

code: string

metrics

metrics: GlyphMetrics

scale

scale: number = 1

timeSignature

timeSignature: TimeSignature

topGlyphs

topGlyphs: Glyph[] = []

topStartX

topStartX: number

width

width: number

xMin

xMin: number

Static CURRENT_CACHE_KEY

CURRENT_CACHE_KEY: string = ''

Static MUSIC_FONT_STACK

MUSIC_FONT_STACK: Font[] = []

Static TEXT_FONT

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

font

  • 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

fontInfo

  • Return a copy of the current FontInfo object.

    Returns Required<FontInfo>

  • Return a copy of the current FontInfo object.

    Parameters

    Returns void

fontSize

  • 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

fontSizeInPixels

  • get fontSizeInPixels(): number
  • Returns number

    the font size in px.

fontSizeInPoints

  • get fontSizeInPoints(): number
  • Returns number

    the font size in pt.

fontStyle

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

fontWeight

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

Static CATEGORY

  • get CATEGORY(): string
  • Returns string

Methods

addClass

applyStyle

checkContext

checkMetrics

checkStave

draw

  • draw(...args: any[]): void
  • Draw an element.

    Parameters

    • Rest ...args: any[]

    Returns void

drawWithStyle

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

    Returns void

getAttribute

  • getAttribute(name: string): any
  • Return an attribute.

    Parameters

    • name: string

    Returns any

getAttributes

getBoundingBox

getCategory

  • getCategory(): string

getCode

  • getCode(): string

getContext

getFont

  • getFont(): string

getFontSize

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

getMetrics

getStyle

getXShift

  • getXShift(): number

getYshift

  • getYshift(): number

hasClass

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

    Parameters

    • className: string

    Returns boolean

isRendered

  • isRendered(): boolean
  • Return the rendered status.

    Returns boolean

onRegister

removeClass

render

renderToStave

  • renderToStave(x: number): void

reset

  • reset(): void

resetFont

  • 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

restoreStyle

setAttribute

setContext

setFont

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

setFontSize

setOptions

  • setOptions(options: any): void

setOrigin

  • setOrigin(x: number, y: number): void
  • Parameters

    • x: number
    • y: number

    Returns void

setOriginX

  • setOriginX(x: number): void

setOriginY

  • setOriginY(y: number): void

setPoint

setRendered

setStave

setStyle

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

setXShift

setYShift

Static getOutlineBoundingBox

  • getOutlineBoundingBox(outline: number[], scale: number, x_pos: number, y_pos: number): BoundingBox

Static getWidth

  • getWidth(code: string, point: number, category?: string): number
  • Parameters

    • code: string
    • point: number
    • Optional category: string

    Returns number

Static loadMetrics

Static lookupFontMetric

  • lookupFontMetric(font: Font, category: string, code: string, key: string, defaultValue: number): number
  • Pass a key of the form glyphs.{category}.{code}.{key} to Font.lookupMetric(). If the initial lookup fails, try again with the path glyphs.{category}.{key}. If the second lookup fails, return the defaultValue.

    Parameters

    • font: Font
    • category: string

      any metric path under 'glyphs', so 'stem.up' could resolve to glyphs.stem.up.shiftX, glyphs.stem.up.shiftY, etc.

    • code: string
    • key: string
    • defaultValue: number

    Returns number

Static lookupGlyph

Static renderGlyph

  • renderGlyph(ctx: RenderContext, x_pos: number, y_pos: number, point: number, code: string, options?: { category?: string; scale?: number }): GlyphMetrics
  • Renders glyphs from the default font stack.

    Parameters

    • ctx: RenderContext

      Canvas or SVG context

    • x_pos: number

      x coordinate

    • y_pos: number

      y coordinate

    • point: number

      the point size of the font

    • code: string

      the glyph code in font.getGlyphs()

    • Optional options: { category?: string; scale?: number }
      • Optional category?: string
      • Optional scale?: number

    Returns GlyphMetrics

Static renderOutline

  • renderOutline(ctx: RenderContext, outline: number[], scale: number, x_pos: number, y_pos: number): void