Class Beater

The <beater> element

Parent element: <percussion>

The <beater> element represents pictograms for beaters, mallets, and sticks that do not have different materials represented in the pictogram.

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/beater/

Hierarchy

  • Beater

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getBeaterValue getTip setBeaterValue setTip

Constructors

constructor

Properties

attributes

attributes: BeaterAttributes

contents

contents: BeaterContents

Readonly schema

schema: {
    attributes: {
        tip: {
            type: "optional";
            value: {
                choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "beater-value";
            type: "label";
            value: {
                choices: readonly ["bow", "chime hammer", "coin", "drum stick", "finger", "fingernail", "fist", "guiro scraper", "hammer", "hand", "jazz stick", "knitting needle", "metal hammer", "slide brush on gong", "snare stick", "spoon mallet", "superball", "triangle beater", "triangle beater plain", "wire brush"];
                type: "choices";
            };
        };
    }];
    name: "beater";
} = Beater.schema

Type declaration

  • Readonly attributes: {
        tip: {
            type: "optional";
            value: {
                choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
                type: "choices";
            };
        };
    }
    • Readonly tip: {
          type: "optional";
          value: {
              choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
            type: "choices";
        }
        • Readonly choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "beater-value";
            type: "label";
            value: {
                choices: readonly ["bow", "chime hammer", "coin", "drum stick", "finger", "fingernail", "fist", "guiro scraper", "hammer", "hand", "jazz stick", "knitting needle", "metal hammer", "slide brush on gong", "snare stick", "spoon mallet", "superball", "triangle beater", "triangle beater plain", "wire brush"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "beater"

Static Readonly schema

schema: {
    attributes: {
        tip: {
            type: "optional";
            value: {
                choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "beater-value";
            type: "label";
            value: {
                choices: readonly ["bow", "chime hammer", "coin", "drum stick", "finger", "fingernail", "fist", "guiro scraper", "hammer", "hand", "jazz stick", "knitting needle", "metal hammer", "slide brush on gong", "snare stick", "spoon mallet", "superball", "triangle beater", "triangle beater plain", "wire brush"];
                type: "choices";
            };
        };
    }];
    name: "beater";
} = ...

Type declaration

  • Readonly attributes: {
        tip: {
            type: "optional";
            value: {
                choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
                type: "choices";
            };
        };
    }
    • Readonly tip: {
          type: "optional";
          value: {
              choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
              type: "choices";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"];
            type: "choices";
        }
        • Readonly choices: readonly ["down", "left", "northeast", "northwest", "right", "southeast", "southwest", "up"]
        • Readonly type: "choices"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "beater-value";
            type: "label";
            value: {
                choices: readonly ["bow", "chime hammer", "coin", "drum stick", "finger", "fingernail", "fist", "guiro scraper", "hammer", "hand", "jazz stick", "knitting needle", "metal hammer", "slide brush on gong", "snare stick", "spoon mallet", "superball", "triangle beater", "triangle beater plain", "wire brush"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "beater"

Methods

getBeaterValue

  • Gets

    Returns "hand" | "bow" | "chime hammer" | "coin" | "drum stick" | "finger" | "fingernail" | "fist" | "guiro scraper" | "hammer" | "jazz stick" | "knitting needle" | "metal hammer" | "slide brush on gong" | "snare stick" | "spoon mallet" | "superball" | "triangle beater" | "triangle beater plain" | "wire brush"

getTip

  • Gets

    Returns null | "left" | "right" | "down" | "up" | "northeast" | "northwest" | "southeast" | "southwest"

setBeaterValue

  • Sets

    Parameters

    • beaterValue: "hand" | "bow" | "chime hammer" | "coin" | "drum stick" | "finger" | "fingernail" | "fist" | "guiro scraper" | "hammer" | "jazz stick" | "knitting needle" | "metal hammer" | "slide brush on gong" | "snare stick" | "spoon mallet" | "superball" | "triangle beater" | "triangle beater plain" | "wire brush"

    Returns Beater

setTip

Settings

Theme

On This Page

Generated using TypeDoc