Class Effect

The <effect> element

Parent element: <percussion>

The <effect> element represents pictograms for sound effect percussion instruments.

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

Hierarchy

  • Effect

Implements

Constructors

constructor

Properties

attributes contents schema schema

Methods

getEffectValue getSmufl setEffectValue setSmufl

Constructors

constructor

Properties

attributes

attributes: EffectAttributes

contents

contents: EffectContents

Readonly schema

schema: {
    attributes: {
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "pict";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "effect-value";
            type: "label";
            value: {
                choices: readonly ["anvil", "auto horn", "bird whistle", "cannon", "duck call", "gun shot", "klaxon horn", "lions roar", "lotus flute", "megaphone", "police whistle", "siren", "slide whistle", "thunder sheet", "wind machine", "wind whistle"];
                type: "choices";
            };
        };
    }];
    name: "effect";
} = Effect.schema

Type declaration

  • Readonly attributes: {
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "pict";
            };
        };
    }
    • Readonly smufl: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "pict";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "pict";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "pict"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "effect-value";
            type: "label";
            value: {
                choices: readonly ["anvil", "auto horn", "bird whistle", "cannon", "duck call", "gun shot", "klaxon horn", "lions roar", "lotus flute", "megaphone", "police whistle", "siren", "slide whistle", "thunder sheet", "wind machine", "wind whistle"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "effect"

Static Readonly schema

schema: {
    attributes: {
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "pict";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "effect-value";
            type: "label";
            value: {
                choices: readonly ["anvil", "auto horn", "bird whistle", "cannon", "duck call", "gun shot", "klaxon horn", "lions roar", "lotus flute", "megaphone", "police whistle", "siren", "slide whistle", "thunder sheet", "wind machine", "wind whistle"];
                type: "choices";
            };
        };
    }];
    name: "effect";
} = ...

Type declaration

  • Readonly attributes: {
        smufl: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "pict";
            };
        };
    }
    • Readonly smufl: {
          type: "optional";
          value: {
              pattern: RegExp;
              type: "regex";
              zero: "pict";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            pattern: RegExp;
            type: "regex";
            zero: "pict";
        }
        • Readonly pattern: RegExp
        • Readonly type: "regex"
        • Readonly zero: "pict"
  • Readonly contents: readonly [{
        type: "required";
        value: {
            label: "effect-value";
            type: "label";
            value: {
                choices: readonly ["anvil", "auto horn", "bird whistle", "cannon", "duck call", "gun shot", "klaxon horn", "lions roar", "lotus flute", "megaphone", "police whistle", "siren", "slide whistle", "thunder sheet", "wind machine", "wind whistle"];
                type: "choices";
            };
        };
    }]
  • Readonly name: "effect"

Methods

getEffectValue

  • Gets

    Returns "anvil" | "auto horn" | "bird whistle" | "cannon" | "duck call" | "gun shot" | "klaxon horn" | "lions roar" | "lotus flute" | "megaphone" | "police whistle" | "siren" | "slide whistle" | "thunder sheet" | "wind machine" | "wind whistle"

getSmufl

setEffectValue

  • Sets

    Parameters

    • effectValue: "anvil" | "auto horn" | "bird whistle" | "cannon" | "duck call" | "gun shot" | "klaxon horn" | "lions roar" | "lotus flute" | "megaphone" | "police whistle" | "siren" | "slide whistle" | "thunder sheet" | "wind machine" | "wind whistle"

    Returns Effect

setSmufl

Settings

Theme

On This Page

Generated using TypeDoc