Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tickable

Tickable represents a element that sit on a score and has a duration, i.e., Tickables occupy space in the musical rendering dimension.

Hierarchy

Index

Constructors

constructor

Properties

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.

postFormatted

  • get postFormatted(): boolean
  • set postFormatted(value: boolean): void
  • Set postformatted status.

    Returns boolean

  • Set postformatted status.

    Parameters

    • value: boolean

    Returns void

preFormatted

  • get preFormatted(): boolean
  • set preFormatted(value: boolean): void
  • Set preformatted status.

    Returns boolean

  • Set preformatted status.

    Parameters

    • value: boolean

    Returns void

Static CATEGORY

  • get CATEGORY(): string
  • Returns string

Methods

addChildElement

addClass

  • Add a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns Tickable

addModifier

  • Optional, if tickable has modifiers, associate a Modifier.

    Parameters

    Returns Tickable

addToModifierContext

  • Add self to the provided ModifierContext mc. If this tickable has modifiers, set modifierContext.

    Parameters

    Returns Tickable

    this

applyStyle

applyTickMultiplier

  • applyTickMultiplier(numerator: number, denominator: number): void
  • Apply a tick multiplier.

    Parameters

    • numerator: number
    • denominator: number

    Returns void

checkContext

checkModifierContext

checkTickContext

  • Parameters

    • message: string = 'Tickable has no tick context.'

    Returns TickContext

Abstract 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

getAbsoluteX

  • getAbsoluteX(): number
  • Returns number

getAttribute

  • getAttribute(name: string): any

getAttributes

getBoundingBox

getCategory

  • getCategory(): string

getCenterXShift

  • getCenterXShift(): number
  • Return the center x shift.

    Returns number

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.

getFormatterMetrics

getIntrinsicTicks

  • getIntrinsicTicks(): number
  • Return the intrinsic ticks.

    Returns number

Abstract getMetrics

  • getMetrics(): any
  • Returns any

getModifierContext

getModifiers

  • Get the list of associated modifiers.

    Returns Modifier[]

getSVGElement

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

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

Abstract getStave

  • getStave(): undefined | Stave
  • Get the target stave.

    Returns undefined | Stave

getStyle

getTickMultiplier

  • Get the tick multiplier.

    Returns Fraction

getTicks

getTuplet

  • getTuplet(): undefined | Tuplet
  • Get the tuplet.

    Returns undefined | Tuplet

getTupletStack

  • Return the intrinsic ticks.

    Returns Tuplet[]

getVoice

  • Return the associated voice. Every tickable must be associated with a voice. This allows formatters and preFormatter to associate them with the right modifierContexts.

    Returns Voice

getWidth

  • getWidth(): number
  • Get width of note. Used by the formatter for positioning.

    Returns number

getX

  • getX(): number
  • Get x position of this tick context.

    Returns number

getXShift

  • getXShift(): number
  • Get the x displaced pixels of the note.

    Returns 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

isCenterAligned

  • isCenterAligned(): boolean
  • Returns boolean

isRendered

  • isRendered(): boolean

onRegister

postFormat

  • Postformat the Tickable.

    Returns Tickable

preFormat

  • preFormat(): void
  • Preformat the Tickable.

    Returns void

removeClass

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

    Parameters

    • className: string

    Returns Tickable

reset

  • Reset the Tickable, this function will be overloaded.

    Returns Tickable

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

resetTuplet

  • Reset the specific Tuplet if this is not provided, all tuplets are reset. Remove any prior tuplets from the tick calculation and reset the intrinsic tick value.

    Parameters

    Returns Tickable

restoreStyle

setAttribute

  • setAttribute(name: string, value: any): Tickable

setCenterAlignment

  • setCenterAlignment(align_center: boolean): Tickable
  • Parameters

    • align_center: boolean

    Returns Tickable

setCenterXShift

  • setCenterXShift(centerXShift: number): Tickable
  • Set the center x shift.

    Parameters

    • centerXShift: number

    Returns Tickable

setContext

setDuration

  • Set the duration.

    Parameters

    Returns void

setFont

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

setFontSize

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

    Parameters

    • Optional size: string | number

    Returns Tickable

setGroupStyle

setIgnoreTicks

  • Ignore the ticks.

    Parameters

    • flag: boolean

    Returns Tickable

setIntrinsicTicks

  • setIntrinsicTicks(intrinsicTicks: number): void
  • Set the intrinsic ticks.

    Parameters

    • intrinsicTicks: number

    Returns void

setModifierContext

setRendered

  • setRendered(rendered?: boolean): Tickable

Abstract 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 Tickable

setTickContext

  • Set the Tick Context.

    Parameters

    Returns void

setTuplet

setVoice

  • setVoice(voice: Voice): void
  • Set the associated voice.

    Parameters

    Returns void

setWidth

  • setWidth(width: number): void
  • Set width of note. Used by the formatter for positioning.

    Parameters

    • width: number

    Returns void

setXShift

  • Displace note by x pixels. Used by the formatter.

    Parameters

    • x: number

    Returns Tickable

shouldIgnoreTicks

  • shouldIgnoreTicks(): boolean
  • Check if it ignores the ticks.

    Returns boolean