Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StaveNote

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

glyphProps: GlyphProps
keyProps: KeyProps[]
keys: string[]
maxLine: number = 0
minLine: number = 0
render_options: { annotation_spacing: number; draw?: boolean; draw_dots?: boolean; draw_stem?: boolean; draw_stem_through_stave?: boolean; extend_left?: number; extend_right?: number; font: string; glyph_font_scale: number; glyph_font_size?: number; scale: number; stroke_px: number; y_shift: number }

Type declaration

  • annotation_spacing: number
  • Optional draw?: boolean
  • Optional draw_dots?: boolean
  • Optional draw_stem?: boolean
  • Optional draw_stem_through_stave?: boolean
  • Optional extend_left?: number
  • Optional extend_right?: number
  • font: string
  • glyph_font_scale: number
  • Optional glyph_font_size?: number
  • scale: number
  • stroke_px: number
  • y_shift: number
stem?: Stem
stem_direction?: number
DEBUG: boolean = false
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.

  • deprecated

    use StaveNote.noteHeads instead.

    Returns NoteHead[]

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

    Returns boolean

  • Set postformatted status.

    Parameters

    • value: boolean

    Returns void

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

    Returns boolean

  • Set preformatted status.

    Parameters

    • value: boolean

    Returns void

  • get CATEGORY(): string
  • Returns string

  • get LEDGER_LINE_OFFSET(): number
  • Returns number

  • get STEM_DOWN(): number
  • deprecated

    Use Stem.DOWN.

    Returns number

  • get STEM_UP(): number
  • deprecated

    Use Stem.UP.

    Returns number

  • get minNoteheadPadding(): number
  • Returns number

Methods

  • applyTickMultiplier(numerator: number, denominator: number): void
  • autoStem(): void
  • Returns void

  • buildFlag(category?: string): void
  • buildNoteHeads(): void
  • Returns void

  • calcNoteDisplacements(): void
  • Returns void

  • calculateKeyProps(): void
  • Returns void

  • calculateOptimalStemDirection(): number
  • Returns number

  • draw(): void
  • drawFlag(): void
  • Returns void

  • drawLedgerLines(): void
  • Returns void

  • drawModifiers(noteheadParam: NoteHead): void
  • Parameters

    Returns void

  • drawNoteHeads(): void
  • Returns void

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

    Returns void

  • getAbsoluteX(): number
  • Get the absolute X position of this note's tick context. This excludes x_shift, so you'll need to factor it in if you're looking for the post-formatted x-position.

    Returns number

  • getAttribute(name: string): any
  • getBeam(): undefined | Beam
  • getBeamCount(): number
  • getCategory(): string
  • getCenterGlyphX(): number
  • getCenterXShift(): number
  • getDuration(): string
  • getFirstDotPx(): number
  • 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.

  • getGlyph(): any
  • getGlyphWidth(): number
  • getIntrinsicTicks(): number
  • getKeyLine(index: number): number
  • Parameters

    • index: number

    Returns number

  • getKeys(): string[]
  • getLeftDisplacedHeadPx(): number
  • getLeftParenthesisPx(index: number): number
  • getLineForRest(): number
  • getLineNumber(isTopNote?: boolean): number
  • getModifierStartXY(position: number, index: number, options?: { forceFlagRight?: boolean }): { x: number; y: number }
  • Get the coordinates for where modifiers begin.

    Parameters

    • position: number
    • index: number
    • options: { forceFlagRight?: boolean } = {}
      • Optional forceFlagRight?: boolean

    Returns { x: number; y: number }

    • x: number
    • y: number
  • getModifiersByType(type: string): Modifier[]
  • getNoteHeadBeginX(): number
  • Returns number

  • getNoteHeadEndX(): number
  • Returns number

  • getNoteType(): string
  • getPlayNote(): undefined | Note
  • Get the play note, which is arbitrary data that can be used by an audio player.

    Returns undefined | Note

  • getRightDisplacedHeadPx(): number
  • getRightParenthesisPx(index: number): number
  • getSVGElement(suffix?: string): undefined | SVGElement
  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • getStave(): undefined | Stave
  • getStaveNoteScale(): number
  • Primarily used as the scaling factor for grace notes, GraceNote will return the required scale.

    Returns number

  • getStem(): undefined | Stem
  • getStemDirection(): number
  • getStemExtension(): number
  • getStemExtents(): { baseY: number; topY: number }
  • Get the top and bottom y values of the stem.

    Returns { baseY: number; topY: number }

    • baseY: number
    • topY: number
  • getStemLength(): number
  • getStemMinimumLength(): number
  • getStemX(): number
  • getTieLeftX(): number
  • getTieRightX(): number
  • getTuplet(): undefined | Tuplet
  • getVoiceShiftWidth(): number
  • Returns number

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

    Returns number

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

    Returns number

  • getXShift(): number
  • getYForBottomText(textLine: number): number
  • getYForTopText(textLine: number): number
  • Gets the y value for the top modifiers at a specific textLine.

    Parameters

    • textLine: number

    Returns number

  • getYs(): number[]
  • Get Y positions for this note. Each Y value is associated with an individual pitch/key within the note/chord.

    Returns number[]

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

    Parameters

    • className: string

    Returns boolean

  • hasFlag(): boolean
  • hasStem(): boolean
  • isCenterAligned(): boolean
  • isChord(): boolean
  • Returns boolean

  • isDisplaced(): boolean
  • Returns boolean

  • isDotted(): boolean
  • isRendered(): boolean
  • isRest(): boolean
  • Returns boolean

    true if this note is a type of rest. Rests don't have pitches, but take up space in the score.

  • preFormat(): void
  • 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

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

  • setAttribute(name: string, value: undefined | string): StaveNote
  • setCenterAlignment(align_center: boolean): StaveNote
  • setCenterXShift(centerXShift: number): StaveNote
  • setFont(font?: string | FontInfo, size?: string | number, weight?: string | number, style?: string): StaveNote
  • 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 StaveNote

  • setFontSize(size?: string | number): StaveNote
  • setIntrinsicTicks(intrinsicTicks: number): void
  • setKeyLine(index: number, line: number): StaveNote
  • Parameters

    • index: number
    • line: number

    Returns StaveNote

  • setNoteDisplaced(displaced: boolean): StaveNote
  • Parameters

    • displaced: boolean

    Returns StaveNote

  • setRightDisplacedHeadPx(x: number): StaveNote
  • setStemDirection(direction?: number): StaveNote
  • 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 StaveNote

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

    Parameters

    • width: number

    Returns void

  • Set Y positions for this note. Each Y value is associated with an individual pitch/key within the note/chord.

    Parameters

    • ys: number[]

    Returns StaveNote

  • shouldDrawFlag(): boolean
  • Returns boolean

  • shouldIgnoreTicks(): boolean
  • postFormat(notes: Note[]): boolean
  • Parameters

    Returns boolean