Class StaveNote

Note implements an abstract interface for notes and chords that are rendered on a stave. Notes have some common properties: All of them have a value (e.g., pitch, fret, etc.) and a duration (quarter, half, etc.)

Some notes have stems, heads, dots, etc. Most notational elements that surround a note are called modifiers, and every note has an associated array of them. All notes also have a rendering context and belong to a stave.

Hierarchy

Constructors

Properties

Accessors

Methods

addChildElement addClass addModifier addStroke addToModifierContext applyStyle applyTickMultiplier autoStem buildFlag buildNoteHeads buildStem calcNoteDisplacements calculateKeyProps calculateOptimalStemDirection checkBeam checkContext checkModifierContext checkStave checkStem checkTickContext draw drawFlag drawLedgerLines drawModifiers drawNoteHeads drawStem drawWithStyle getAbsoluteX getAttribute getAttributes getBaseCustomNoteHeadGlyphProps getBeam getBeamCount getBoundingBox getCategory getCenterGlyphX getCenterXShift getContext getDuration getFirstDotPx getFlagStyle getFont getFontScale getFontSize getFormatterMetrics getGlyphProps getGlyphWidth getHeight getIntrinsicTicks getKeyLine getKeyProps getKeys getLedgerLineStyle getLeftDisplacedHeadPx getLeftParenthesisPx getLineForRest getLineNumber getMetrics getModifierContext getModifierStartXY getModifiers getModifiersByType getNoteHeadBeginX getNoteHeadBounds getNoteHeadEndX getNoteType getPlayNote getRightDisplacedHeadPx getRightParenthesisPx getSVGElement getStave getStem getStemDirection getStemExtension getStemExtents getStemLength getStemMinimumLength getStemStyle getStemX getStyle getText getTextMetrics getTickContext getTickMultiplier getTicks getTieLeftX getTieRightX getTuplet getTupletStack getVoice getVoiceShiftWidth getWidth getX getXShift getY getYForBottomText getYForTopText getYShift getYs hasBeam hasClass hasFlag hasStem isCenterAligned isChord isDisplaced isDotted isRendered isRest measureText onRegister postFormat preFormat removeClass renderText reset resetTuplet restoreStyle setAttribute setBeam setCenterAlignment setCenterXShift setContext setDuration setFlagStyle setFont setFontSize setGroupStyle setIgnoreTicks setIntrinsicTicks setKeyLine setKeyStyle setLedgerLineStyle setLeftDisplacedHeadPx setModifierContext setNoteDisplaced setOrigin setOriginX setOriginY setPlayNote setRendered setRightDisplacedHeadPx setStave setStem setStemDirection setStemLength setStemStyle setStyle setText setTickContext setTuplet setVoice setWidth setX setXShift setY setYShift setYs shouldDrawFlag shouldIgnoreTicks format getGlyphProps getTextMeasurementCanvas measureWidth plotMetrics postFormat setTextMeasurementCanvas

Constructors

Properties

glyphProps: GlyphProps
keyProps: KeyProps[]
keys: string[]
maxLine: number = 0
minLine: number = 0
renderOptions: {
    annotationSpacing: number;
    draw?: boolean;
    drawDots?: boolean;
    drawStem?: boolean;
    drawStemThroughStave?: boolean;
    extendLeft?: number;
    extendRight?: number;
    strokePx: number;
    yShift: number;
}

Type declaration

  • annotationSpacing: number
  • Optional draw?: boolean
  • Optional drawDots?: boolean
  • Optional drawStem?: boolean
  • Optional drawStemThroughStave?: boolean
  • Optional extendLeft?: number
  • Optional extendRight?: number
  • strokePx: number
  • yShift: number
stem?: Stem
stemDirection?: number
DEBUG: boolean = false

Accessors

  • get font(): string
  • Returns the CSS compatible font string for the text font.

    Returns string

  • set font(f): 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 fontInfo(): Required<FontInfo>
  • Return a copy of the current FontInfo object.

    Returns Required<FontInfo>

  • set fontInfo(fontInfo): void
  • Set the current FontInfo object.

    Parameters

    Returns void

  • get fontSize(): string
  • Returns string

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

  • set fontSize(size): 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): 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): void
  • Set the font weight.

    Parameters

    • weight: string | number

    Returns void

  • get height(): number
  • Returns number

  • set height(height): void
  • Parameters

    • height: number

    Returns void

  • get postFormatted(): boolean
  • Returns boolean

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

    Parameters

    • value: boolean

    Returns void

  • get preFormatted(): boolean
  • Returns boolean

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

    Parameters

    • value: boolean

    Returns void

  • get text(): string
  • Returns string

  • set text(text): void
  • Parameters

    • text: string

    Returns void

  • get textMetrics(): TextMetrics
  • Returns TextMetrics

  • get width(): number
  • Returns number

  • set width(width): void
  • Parameters

    • width: number

    Returns void

  • get CATEGORY(): string
  • Returns string

  • get LEDGER_LINE_OFFSET(): number
  • Returns number

  • get minNoteheadPadding(): number
  • Returns number

Methods

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

  • Apply a tick multiplier.

    Parameters

    • numerator: number
    • denominator: number

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns number

  • Returns void

  • Returns void

  • Parameters

    Returns void

  • Returns void

  • Draw the element and all its sub-elements (ie.: Modifiers in a Stave) with the element's style (see getStyle() and setStyle())

    Returns void

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

    Returns number

  • Return an attribute, such as 'id', 'type' or 'class'.

    Parameters

    • name: string

    Returns any

  • Get the css string describing this Element's text font. e.g., 'bold 10pt Arial'.

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

  • Parameters

    • index: number

    Returns number

  • Get the stave line number for the note.

    Parameters

    • Optional isTopNote: boolean

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

  • Returns number

  • Get the play note, which is arbitrary data that can be used by an audio player.

    Returns undefined | Note

  • Return associated SVGElement.

    Parameters

    • suffix: string = ''

    Returns undefined | SVGElement

  • Override stemmablenote stem extension to adjust for distance from middle line.

    Returns number

  • Get the top and bottom y values of the stem.

    Returns {
        baseY: number;
        topY: number;
    }

    • baseY: number
    • topY: number
  • Returns number

  • Get width of note. Used by the formatter for positioning.

    Returns number

  • Get x position of this tick context.

    Returns number

  • Gets the y value for the bottom modifiers at a specific textLine.

    Parameters

    • textLine: number

    Returns number

  • Gets the y value for the top modifiers at a specific textLine.

    Parameters

    • textLine: number

    Returns number

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

    Returns number[]

  • Check if it has a class label (An element can have multiple class labels).

    Parameters

    • className: string

    Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

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

  • Measure the text using the textFont.

    Returns TextMetrics

  • 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

  • Parameters

    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

    • 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

  • Set the intrinsic ticks.

    Parameters

    • intrinsicTicks: number

    Returns void

  • Parameters

    Returns void

  • 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

  • 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

  • Returns boolean

  • True if this note has no duration (e.g., bar notes, spacers, etc.).

    Returns boolean

  • Measure the text using the FontInfo related with key.

    Parameters

    • text: string
    • key: string = ''

    Returns number

  • Parameters

    Returns boolean