Class Beam

The <beam> element

Parent element: <note>

Beam values include begin, continue, end, forward hook, and backward hook. Each beam in a note is represented with a separate <beam> element with a different number attribute, starting with the eighth note beam using a value of 1.

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

Hierarchy

Beam

Implements

XMLElement<"beam", BeamAttributes, BeamContents>

Index

Constructors

constructor

new Beam(opts?): Beam
Parameters
- Optional opts: {
  attributes?: Partial<BeamAttributes>;
  contents?: BeamContents;
  }
  - Optional attributes?: Partial<BeamAttributes>
  - Optional contents?: BeamContents
Returns Beam
- Defined in generated/elements.ts:12388

Properties

attributes

attributes: BeamAttributes

contents: BeamContents

`Readonly` schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        fan: {
            type: "optional";
            value: {
                choices: readonly ["accel", "none", "rit"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        number: {
            type: "optional";
            value: {
                max: 8;
                min: 1;
                type: "int";
            };
        };
        repeater: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            label: "beam-value";
            type: "label";
            value: {
                choices: readonly ["backward hook", "begin", "continue", "end", "forward hook"];
                type: "choices";
            };
        };
    }];
    name: "beam";
} = Beam.schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    fan: {
        type: "optional";
        value: {
            choices: readonly ["accel", "none", "rit"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: 8;
            min: 1;
            type: "int";
        };
    };
    repeater: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- Readonly fan: {
      type: "optional";
      value: {
          choices: readonly ["accel", "none", "rit"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["accel", "none", "rit"];
    type: "choices";
    }
    - Readonly choices: readonly ["accel", "none", "rit"]
    - Readonly type: "choices"
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- 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 repeater: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
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: "beam"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    fan: {
        type: "optional";
        value: {
            choices: readonly ["accel", "none", "rit"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: 8;
            min: 1;
            type: "int";
        };
    };
    repeater: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- Readonly fan: {
      type: "optional";
      value: {
          choices: readonly ["accel", "none", "rit"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["accel", "none", "rit"];
    type: "choices";
    }
    - Readonly choices: readonly ["accel", "none", "rit"]
    - Readonly type: "choices"
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- 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 repeater: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
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: "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:12438

getColor

getColor(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:12393

getFan

getFan(): null | "none" | "accel" | "rit"
Gets

Returns null | "none" | "accel" | "rit"
- Defined in generated/elements.ts:12402

getId

getId(): null | string
Gets

Returns null | string
- Defined in generated/elements.ts:12411

getNumber

getNumber(): null | number
Gets

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

getRepeater

getRepeater(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:12429

setBeamValue

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

setColor

setColor(color): Beam
Sets
Parameters
- color: null | string
Returns Beam
- Defined in generated/elements.ts:12397

setFan

setFan(fan): Beam
Sets
Parameters
- fan: null | "none" | "accel" | "rit"
Returns Beam
- Defined in generated/elements.ts:12406

setId

setId(id): Beam
Sets
Parameters
- id: null | string
Returns Beam
- Defined in generated/elements.ts:12415

setNumber

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

setRepeater

setRepeater(repeater): Beam
Sets
Parameters
- repeater: null | "yes" | "no"
Returns Beam
- Defined in generated/elements.ts:12433

Class Beam

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<BeamAttributes>; contents?: BeamContents; }

Optional attributes?: Partial<BeamAttributes>

Optional contents?: BeamContents

Returns Beam

Properties

attributes

contents

Readonly schema

Type declaration

Readonly color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "#000000"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "#000000"

Readonly fan: { type: "optional"; value: { choices: readonly ["accel", "none", "rit"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["accel", "none", "rit"]; type: "choices"; }

Readonly choices: readonly ["accel", "none", "rit"]

Readonly type: "choices"

Readonly id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

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 repeater: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["yes", "no"]; type: "choices"; }

Readonly choices: readonly ["yes", "no"]

Readonly type: "choices"

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: "beam"

Static Readonly schema

Type declaration

Readonly color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "#000000"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "#000000"

Readonly fan: { type: "optional"; value: { choices: readonly ["accel", "none", "rit"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["accel", "none", "rit"]; type: "choices"; }

Readonly choices: readonly ["accel", "none", "rit"]

Readonly type: "choices"

Readonly id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

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 repeater: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["yes", "no"]; type: "choices"; }

Readonly choices: readonly ["yes", "no"]

Readonly type: "choices"

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

`Optional` opts: {
attributes?: Partial<BeamAttributes>;
contents?: BeamContents;
}

`Optional` attributes?: Partial<BeamAttributes>

`Optional` contents?: BeamContents

`Readonly` schema

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "#000000"

`Readonly` fan: {
type: "optional";
value: {
choices: readonly ["accel", "none", "rit"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["accel", "none", "rit"];
type: "choices";
}

`Readonly` choices: readonly ["accel", "none", "rit"]

`Readonly` type: "choices"

`Readonly` id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`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` repeater: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["yes", "no"];
type: "choices";
}

`Readonly` choices: readonly ["yes", "no"]

`Readonly` type: "choices"

`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: "beam"

`Static` `Readonly` schema

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "#000000"

`Readonly` fan: {
type: "optional";
value: {
choices: readonly ["accel", "none", "rit"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["accel", "none", "rit"];
type: "choices";
}

`Readonly` choices: readonly ["accel", "none", "rit"]

`Readonly` type: "choices"

`Readonly` id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`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` repeater: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["yes", "no"];
type: "choices";
}

`Readonly` choices: readonly ["yes", "no"]

`Readonly` type: "choices"

`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: "beam"