Class GraceNote

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 calcBeamedNotesSlashBBox 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 getFontSize getFormatterMetrics getGlyph getGlyphProps getGlyphWidth getIntrinsicTicks getKeyLine getKeyProps getKeys getLedgerLineStyle getLeftDisplacedHeadPx getLeftParenthesisPx getLineForRest getLineNumber getMetrics getModifierContext getModifierStartXY getModifiers getModifiersByType getNoteHeadBeginX getNoteHeadBounds getNoteHeadEndX getNoteType getPlayNote getRightDisplacedHeadPx getRightParenthesisPx getSVGElement getStave getStaveNoteScale getStem getStemDirection getStemExtension getStemExtents getStemLength getStemMinimumLength getStemStyle getStemX getStyle getTickContext getTickMultiplier getTicks getTieLeftX getTieRightX getTuplet getTupletStack getVoice getVoiceShiftWidth getWidth getX getXShift getYForBottomText getYForTopText getYs hasBeam hasClass hasFlag hasStem isCenterAligned isChord isDisplaced isDotted isRendered isRest onRegister postFormat preFormat removeClass reset resetFont resetTuplet restoreStyle setAttribute setBeam setCenterAlignment setCenterXShift setContext setDuration setFlagStyle setFont setFontSize setGroupStyle setIgnoreTicks setIntrinsicTicks setKeyLine setKeyStyle setLedgerLineStyle setLeftDisplacedHeadPx setModifierContext setNoteDisplaced setPlayNote setRendered setRightDisplacedHeadPx setStave setStem setStemDirection setStemLength setStemStyle setStyle setTickContext setTuplet setVoice setWidth setXShift setYs shouldDrawFlag shouldIgnoreTicks format getPoint plotMetrics postFormat

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

    • weight: string | number

    Returns void

  • get noteHeads(): NoteHead[]
  • Returns NoteHead[]

  • get note_heads(): NoteHead[]
  • Deprecated

    use StaveNote.noteHeads instead.

    Returns NoteHead[]

  • 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 CATEGORY(): string
  • Returns string

  • get LEDGER_LINE_OFFSET(): number
  • Returns number

  • get SCALE(): 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

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

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

    Parameters

    • className: string

    Returns GraceNote

  • Apply a tick multiplier.

    Parameters

    • numerator: number
    • denominator: number

    Returns void

  • Parameters

    • category: string = 'flag'

    Returns void

  • Parameters

    • slashStemOffset: number
    • slashBeamOffset: number
    • protrusions: {
          beam: number;
          stem: number;
      }
      • beam: number
      • stem: number

    Returns Record<string, number>

  • Draw an element.

    Returns void

  • Renders the stem onto the canvas.

    Parameters

    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 x_shift, 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.

  • Deprecated

    Use getGlyphProps() instead.

    Returns any

  • Parameters

    • index: number

    Returns number

  • Get the stave line number for rest.

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

  • Primarily used as the scaling factor for grace notes, GraceNote will return the required scale.

    Returns number

  • 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
  • Get the x coordinate to the left of the note.

    Returns number

  • Get the x coordinate to the right of the note.

    Returns number

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

    Returns number

  • Get x position of this tick context.

    Returns number

  • Get the x displaced pixels of the note.

    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 it has a beam.

    Returns boolean

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

    Parameters

    • className: string

    Returns boolean

  • Accessor to hasStem.

    Returns boolean

  • Accessor to isDotted.

    Returns boolean

  • Return the rendered status.

    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.

  • Preformat the Tickable.

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

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

  • Set the intrinsic ticks.

    Parameters

    • intrinsicTicks: number

    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 GraceNote

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

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

    Returns boolean

  • Get point for notes.

    Parameters

    • Optional size: string

    Returns number

  • Debug helper. Displays various note metrics for the given note.

    Parameters

    Returns void