Class CircularArrow

The <circular-arrow> element

Parent element: <arrow>

The <circular-arrow> element represents a circular arrow, using Unicode arrow terminology to specify the arrow direction.

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

Hierarchy

CircularArrow

Implements

XMLElement<"circular-arrow", CircularArrowAttributes, CircularArrowContents>

Index

Constructors

constructor

new CircularArrow(opts?): CircularArrow
Parameters
- Optional opts: {
  attributes?: Partial<CircularArrowAttributes>;
  contents?: CircularArrowContents;
  }
  - Optional attributes?: Partial<CircularArrowAttributes>
  - Optional contents?: CircularArrowContents
Returns CircularArrow
- Defined in generated/elements.ts:25114

Properties

attributes

attributes: CircularArrowAttributes

contents: CircularArrowContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            label: "circular-arrow";
            type: "label";
            value: {
                choices: readonly ["anticlockwise", "clockwise"];
                type: "choices";
            };
        };
    }];
    name: "circular-arrow";
} = CircularArrow.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "circular-arrow";
        type: "label";
        value: {
            choices: readonly ["anticlockwise", "clockwise"];
            type: "choices";
        };
    };
}]
Readonly name: "circular-arrow"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        label: "circular-arrow";
        type: "label";
        value: {
            choices: readonly ["anticlockwise", "clockwise"];
            type: "choices";
        };
    };
}]
Readonly name: "circular-arrow"

Methods

getCircularArrow

getCircularArrow(): "anticlockwise" | "clockwise"
Gets

Returns "anticlockwise" | "clockwise"
- Defined in generated/elements.ts:25120

setCircularArrow

setCircularArrow(circularArrow): CircularArrow
Sets
Parameters
- circularArrow: "anticlockwise" | "clockwise"
Returns CircularArrow
- Defined in generated/elements.ts:25124

Class CircularArrow

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<CircularArrowAttributes>;
contents?: CircularArrowContents;
}

`Optional` attributes?: Partial<CircularArrowAttributes>

`Optional` contents?: CircularArrowContents

Returns CircularArrow

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "circular-arrow";
        type: "label";
        value: {
            choices: readonly ["anticlockwise", "clockwise"];
            type: "choices";
        };
    };
}]

`Readonly` name: "circular-arrow"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        label: "circular-arrow";
        type: "label";
        value: {
            choices: readonly ["anticlockwise", "clockwise"];
            type: "choices";
        };
    };
}]

`Readonly` name: "circular-arrow"

Methods

getCircularArrow

Returns "anticlockwise" | "clockwise"

setCircularArrow

Parameters

circularArrow: "anticlockwise" | "clockwise"

Returns CircularArrow

Settings

Theme

On This Page

Class CircularArrow

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<CircularArrowAttributes>; contents?: CircularArrowContents; }

Optional attributes?: Partial<CircularArrowAttributes>

Optional contents?: CircularArrowContents

Returns CircularArrow

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "circular-arrow"; type: "label"; value: { choices: readonly ["anticlockwise", "clockwise"]; type: "choices"; }; }; }]

Readonly name: "circular-arrow"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { label: "circular-arrow"; type: "label"; value: { choices: readonly ["anticlockwise", "clockwise"]; type: "choices"; }; }; }]

Readonly name: "circular-arrow"

Methods

getCircularArrow

Returns "anticlockwise" | "clockwise"

setCircularArrow

Parameters

circularArrow: "anticlockwise" | "clockwise"

Returns CircularArrow

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<CircularArrowAttributes>;
contents?: CircularArrowContents;
}

`Optional` attributes?: Partial<CircularArrowAttributes>

`Optional` contents?: CircularArrowContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "circular-arrow";
type: "label";
value: {
choices: readonly ["anticlockwise", "clockwise"];
type: "choices";
};
};
}]

`Readonly` name: "circular-arrow"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
label: "circular-arrow";
type: "label";
value: {
choices: readonly ["anticlockwise", "clockwise"];
type: "choices";
};
};
}]

`Readonly` name: "circular-arrow"