Class HoleShape

The <hole-shape> element

Parent element: <hole>

The <hole-shape> element indicates the shape of the hole symbol. It is a circle if not specified.

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

Hierarchy

HoleShape

Implements

XMLElement<"hole-shape", HoleShapeAttributes, HoleShapeContents>

Index

Constructors

constructor

new HoleShape(opts?): HoleShape
Parameters
- Optional opts: {
  attributes?: Partial<HoleShapeAttributes>;
  contents?: HoleShapeContents;
  }
  - Optional attributes?: Partial<HoleShapeAttributes>
  - Optional contents?: HoleShapeContents
Returns HoleShape
- Defined in generated/elements.ts:24639

Properties

attributes

attributes: HoleShapeAttributes

contents: HoleShapeContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            type: "string";
        };
    }];
    name: "hole-shape";
} = HoleShape.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]
Readonly name: "hole-shape"

`Static` `Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            type: "string";
        };
    }];
    name: "hole-shape";
} = ...

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]
Readonly name: "hole-shape"

Methods

getText

getText(): string
Gets

Returns string
- Defined in generated/elements.ts:24645

setText

setText(text): HoleShape
Sets
Parameters
- text: string
Returns HoleShape
- Defined in generated/elements.ts:24649

Class HoleShape

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<HoleShapeAttributes>;
contents?: HoleShapeContents;
}

`Optional` attributes?: Partial<HoleShapeAttributes>

`Optional` contents?: HoleShapeContents

Returns HoleShape

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]

`Readonly` name: "hole-shape"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]

`Readonly` name: "hole-shape"

Methods

getText

Returns string

setText

Parameters

text: string

Returns HoleShape

Settings

Theme

On This Page

Class HoleShape

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<HoleShapeAttributes>; contents?: HoleShapeContents; }

Optional attributes?: Partial<HoleShapeAttributes>

Optional contents?: HoleShapeContents

Returns HoleShape

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { type: "string"; }; }]

Readonly name: "hole-shape"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "required"; value: { type: "string"; }; }]

Readonly name: "hole-shape"

Methods

getText

Returns string

setText

Parameters

text: string

Returns HoleShape

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<HoleShapeAttributes>;
contents?: HoleShapeContents;
}

`Optional` attributes?: Partial<HoleShapeAttributes>

`Optional` contents?: HoleShapeContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
type: "string";
};
}]

`Readonly` name: "hole-shape"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "required";
value: {
type: "string";
};
}]

`Readonly` name: "hole-shape"