v5.0.0
    Preparing search index...

    Class PedalMarking

    PedalMarking implements different types of pedal markings. These notation elements indicate to the performer when to depress and release the a pedal.

    In order to create "Sostenuto", and "una corda" markings, you must set custom text for the release/depress pedal markings.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _fontInfo: Required<FontInfo>
    _height: number = 0
    _text: string = ''
    _textMetrics: TextMetrics = ...
    _width: number = 0
    children: Element[] = []
    depressText: string
    fontScale: number
    line: number
    metricsValid: boolean = false
    notes: StaveNote[]
    parent?: Element
    registry?: Registry
    releaseText: string
    rendered: boolean
    renderOptions: {
        bracketHeight: number;
        bracketLineWidth: number;
        color: string;
        textMarginRight: number;
    }
    style: ElementStyle = {}
    type: number
    x: number = 0
    xShift: number = 0
    y: number = 0
    yShift: number = 0
    DEBUG: boolean = false

    To enable logging for this class. Set VexFlow.PedalMarking.DEBUG to true.

    GLYPHS: Record<string, string> = ...

    Glyph data

    ID: number = 1000
    type: { BRACKET: number; MIXED: number; TEXT: number } = ...

    Pedal type as number.

    typeString: Record<string, number> = ...

    Pedal type as string.

    Accessors

    • get font(): string

      Returns the CSS compatible font string for the text font.

      Returns string

    • set font(f: string): 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 fontSize(): string

      Returns string

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

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

      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: string): 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: string | number): void

      Set the font weight.

      Parameters

      • weight: string | number

      Returns void

    Methods

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

    • Draw the text based pedal markings. This defaults to the traditional "Ped" and "*"" symbols if no custom text has been provided.

      Returns void

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

      Returns this

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

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

      Parameters

      • className: string

      Returns boolean

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

      Parameters

      • name: string
      • value: undefined | string

      Returns this

    • Set custom text for the depress/release pedal markings. No text is set if the parameter is falsy.

      Parameters

      • depress: string
      • Optionalrelease: string

      Returns this

    • 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

      • Optionalfont: 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).

      • Optionalsize: string | number

        a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').

      • Optionalweight: string | number

        is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).

      • Optionalstyle: 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 this

    • Change the font size, while keeping everything else the same.

      Parameters

      • Optionalsize: string | number

      Returns this

    • Set the element style used to render.

      Example:

      element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
      element.drawWithStyle();

      Note: If the element draws additional sub-elements (i.e.: 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.drawWithStyle();

      or using drawWithStyle:

      element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
      element.drawWithStyle();

      Parameters

      Returns this

    • Measure the text using the FontInfo related with key.

      Parameters

      • text: string
      • key: string = ''

      Returns number