Class MetronomeBeam

The <metronome-beam> element

Parent element: <metronome-note>

The <metronome-beam> element works like the <beam> element in defining metric relationships, but does not include all the attributes available in the <beam> element.

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

Hierarchy

MetronomeBeam

Implements

XMLElement<"metronome-beam", MetronomeBeamAttributes, MetronomeBeamContents>

Index

Constructors

constructor

new MetronomeBeam(opts?): MetronomeBeam
Parameters
- Optional opts: {
  attributes?: Partial<MetronomeBeamAttributes>;
  contents?: MetronomeBeamContents;
  }
  - Optional attributes?: Partial<MetronomeBeamAttributes>
  - Optional contents?: MetronomeBeamContents
Returns MetronomeBeam
- Defined in generated/elements.ts:39880

Properties

attributes

attributes: MetronomeBeamAttributes

contents: MetronomeBeamContents

`Readonly` schema

schema: {
    attributes: {
        number: {
            type: "optional";
            value: {
                max: 8;
                min: 1;
                type: "int";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "beam-value";
            type: "label";
            value: {
                choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
                type: "choices";
            };
        };
    }];
    name: "metronome-beam";
} = MetronomeBeam.schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            max: 8;
            min: 1;
            type: "int";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          max: 8;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 8;
        min: 1;
        type: "int";
    }
    - Readonly max: 8
    - Readonly min: 1
    - Readonly type: "int"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "beam-value";
        type: "label";
        value: {
            choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
            type: "choices";
        };
    };
}]
Readonly name: "metronome-beam"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    number: {
        type: "optional";
        value: {
            max: 8;
            min: 1;
            type: "int";
        };
    };
}
- Readonly number: {
      type: "optional";
      value: {
          max: 8;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 8;
        min: 1;
        type: "int";
    }
    - Readonly max: 8
    - Readonly min: 1
    - Readonly type: "int"
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "beam-value";
        type: "label";
        value: {
            choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
            type: "choices";
        };
    };
}]
Readonly name: "metronome-beam"

Methods

getBeamValue

getBeamValue(): "backward hook" | "begin" | "continue" | "end" | "forward hook"
Gets

Returns "backward hook" | "begin" | "continue" | "end" | "forward hook"
- Defined in generated/elements.ts:39894

getNumber

getNumber(): null | number
Gets

Returns null | number
- Defined in generated/elements.ts:39885

setBeamValue

setBeamValue(beamValue): MetronomeBeam
Sets
Parameters
- beamValue: "backward hook" | "begin" | "continue" | "end" | "forward hook"
Returns MetronomeBeam
- Defined in generated/elements.ts:39898

setNumber

setNumber(number): MetronomeBeam
Sets
Parameters
- number: null | number
Returns MetronomeBeam
- Defined in generated/elements.ts:39889

Class MetronomeBeam

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MetronomeBeamAttributes>; contents?: MetronomeBeamContents; }

Optional attributes?: Partial<MetronomeBeamAttributes>

Optional contents?: MetronomeBeamContents

Returns MetronomeBeam

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { number: { type: "optional"; value: { max: 8; min: 1; type: "int"; }; }; }

Readonly number: { type: "optional"; value: { max: 8; min: 1; type: "int"; }; }

Readonly type: "optional"

Readonly value: { max: 8; min: 1; type: "int"; }

Readonly max: 8

Readonly min: 1

Readonly type: "int"

Readonly contents: readonly [{ type: "required"; value: { label: "beam-value"; type: "label"; value: { choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"]; type: "choices"; }; }; }]

Readonly name: "metronome-beam"

Static Readonly schema

Type declaration

Readonly attributes: { number: { type: "optional"; value: { max: 8; min: 1; type: "int"; }; }; }

Readonly number: { type: "optional"; value: { max: 8; min: 1; type: "int"; }; }

Readonly type: "optional"

Readonly value: { max: 8; min: 1; type: "int"; }

Readonly max: 8

Readonly min: 1

Readonly type: "int"

Readonly contents: readonly [{ type: "required"; value: { label: "beam-value"; type: "label"; value: { choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"]; type: "choices"; }; }; }]

Readonly name: "metronome-beam"

Methods

getBeamValue

Returns "backward hook" | "begin" | "continue" | "end" | "forward hook"

getNumber

Returns null | number

setBeamValue

Parameters

beamValue: "backward hook" | "begin" | "continue" | "end" | "forward hook"

Returns MetronomeBeam

setNumber

Parameters

number: null | number

Returns MetronomeBeam

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<MetronomeBeamAttributes>;
contents?: MetronomeBeamContents;
}

`Optional` attributes?: Partial<MetronomeBeamAttributes>

`Optional` contents?: MetronomeBeamContents

`Readonly` schema

`Readonly` attributes: {
number: {
type: "optional";
value: {
max: 8;
min: 1;
type: "int";
};
};
}

`Readonly` number: {
type: "optional";
value: {
max: 8;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: 8;
min: 1;
type: "int";
}

`Readonly` max: 8

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` contents: readonly [{
type: "required";
value: {
label: "beam-value";
type: "label";
value: {
choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
type: "choices";
};
};
}]

`Readonly` name: "metronome-beam"

`Static` `Readonly` schema

`Readonly` attributes: {
number: {
type: "optional";
value: {
max: 8;
min: 1;
type: "int";
};
};
}

`Readonly` number: {
type: "optional";
value: {
max: 8;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: 8;
min: 1;
type: "int";
}

`Readonly` max: 8

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` contents: readonly [{
type: "required";
value: {
label: "beam-value";
type: "label";
value: {
choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
type: "choices";
};
};
}]

`Readonly` name: "metronome-beam"