Class Ipa

The <ipa> element

Parent element: <play>

The <ipa> element represents International Phonetic Alphabet (IPA) sounds for vocal music. String content is limited to IPA 2015 symbols represented in Unicode 13.0.

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

Hierarchy

Implements

XMLElement<"ipa", IpaAttributes, IpaContents>

Index

Constructors

constructor

new Ipa(opts?): Ipa
Parameters
- Optional opts: {
  attributes?: Partial<IpaAttributes>;
  contents?: IpaContents;
  }
  - Optional attributes?: Partial<IpaAttributes>
  - Optional contents?: IpaContents
Returns Ipa
- Defined in generated/elements.ts:35007

Properties

attributes

attributes: IpaAttributes

contents: IpaContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "required";
        value: {
            type: "string";
        };
    }];
    name: "ipa";
} = Ipa.schema

Type declaration

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

`Static` `Readonly` schema

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

Type declaration

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

Methods

getText

getText(): string
Gets

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

setText

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

Class Ipa

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<IpaAttributes>;
contents?: IpaContents;
}

`Optional` attributes?: Partial<IpaAttributes>

`Optional` contents?: IpaContents

Returns Ipa

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

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

`Readonly` name: "ipa"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

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

`Readonly` name: "ipa"

Methods

getText

Returns string

setText

Parameters

text: string

Returns Ipa

Settings

Theme

On This Page

Class Ipa

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<IpaAttributes>; contents?: IpaContents; }

Optional attributes?: Partial<IpaAttributes>

Optional contents?: IpaContents

Returns Ipa

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

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

Readonly name: "ipa"

Static Readonly schema

Type declaration

Readonly attributes: {}

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

Readonly name: "ipa"

Methods

getText

Returns string

setText

Parameters

text: string

Returns Ipa

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<IpaAttributes>;
contents?: IpaContents;
}

`Optional` attributes?: Partial<IpaAttributes>

`Optional` contents?: IpaContents

`Readonly` schema

`Readonly` attributes: {}

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

`Readonly` name: "ipa"

`Static` `Readonly` schema

`Readonly` attributes: {}

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

`Readonly` name: "ipa"