Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Voice

Voice is mainly a container object to group Tickables for formatting.

Hierarchy

Index

Constructors

Properties

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

  • Modes allow the addition of ticks in three different ways:

    • STRICT: This is the default. Ticks must fill the voice.
    • SOFT: Ticks can be added without restrictions.
    • FULL: Ticks do not need to fill the voice, but can't exceed the maximum tick length.

    Returns typeof VoiceMode

Methods

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

    Parameters

    • className: string

    Returns Voice

  • Add a tickable to the voice.

    Parameters

    Returns Voice

  • Add an array of tickables to the voice.

    Parameters

    Returns Voice

  • Render the voice onto the canvas context and an optional stave. If stave is omitted, it is expected that the notes have staves already set.

    This method also calculates the voice's boundingBox while drawing the notes. Note the similarities with this.getBoundingBox().

    Parameters

    Returns void

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

    Returns void

  • getActualResolution(): number
  • Get the actual tick resolution for the voice.

    Returns number

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

  • getLargestTickWidth(): number
  • Get the largest width of all the tickables.

    Returns number

  • getMode(): number
  • Get the voice mode.

    Returns number

  • getResolutionMultiplier(): number
  • Get the resolution multiplier for the voice.

    Returns number

  • getSVGElement(suffix?: string): undefined | SVGElement
  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • Get the tick count for the shortest tickable

    Returns Fraction

  • getStave(): undefined | Stave
  • Returns undefined | Stave

  • Get the tickables in the voice.

    Returns Tickable[]

  • Get the total ticks used in the voice by all the tickables.

    Returns Fraction

  • Get the total ticks in the voice.

    Returns Fraction

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

    Parameters

    • className: string

    Returns boolean

  • isComplete(): boolean
  • Determine if the voice is complete according to the voice mode.

    Returns boolean

  • isRendered(): boolean
  • Preformat the voice by applying the voice's stave to each note.

    Returns Voice

  • removeClass(className: string): Voice
  • Remove a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Voice

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

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

    Parameters

    • Optional size: string | number

    Returns Voice

  • setMode(mode: number): Voice
  • Set the voice mode.

    Parameters

    • mode: number

      value from VoiceMode

    Returns Voice

  • setRendered(rendered?: boolean): Voice
  • setSoftmaxFactor(factor: number): Voice
  • We use softmax to layout the tickables proportional to the exponent of their duration. The softmax factor is used to determine the 'linearness' of the layout.

    The softmax of all the tickables in this voice should sum to 1.

    Parameters

    • factor: number

    Returns Voice

  • Set the voice's stave.

    Parameters

    Returns Voice

  • setStrict(strict: boolean): Voice
  • Set the voice mode to strict or soft.

    Parameters

    • strict: boolean

    Returns Voice

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

  • softmax(tickValue: number): number
  • Get the softmax-scaled value of a tick duration. 'tickValue' is a number.

    Parameters

    • tickValue: number

    Returns number