Class Transpose

The <transpose> element

Parent element: <attributes>

The <transpose> element represents what must be added to a written pitch to get a correct sounding pitch. It is used for encoding parts for transposing instruments that are in written vs. concert pitch.

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

Hierarchy

Transpose

Implements

XMLElement<"transpose", TransposeAttributes, TransposeContents>

Index

Constructors

constructor

new Transpose(opts?): Transpose
Parameters
- Optional opts: {
  attributes?: Partial<TransposeAttributes>;
  contents?: TransposeContents;
  }
  - Optional attributes?: Partial<TransposeAttributes>
  - Optional contents?: TransposeContents
Returns Transpose
- Defined in generated/elements.ts:50275

Properties

attributes

attributes: TransposeAttributes

contents: TransposeContents

`Readonly` schema

schema: {
    attributes: {
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        number: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof Diatonic;
    }, {
        type: "required";
        value: typeof Chromatic;
    }, {
        type: "optional";
        value: typeof OctaveChange;
    }, {
        type: "optional";
        value: typeof Double;
    }];
    name: "transpose";
} = Transpose.schema

Type declaration

Readonly attributes: {
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}
- 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: number;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 1;
        type: "int";
    }
    - Readonly max: number
    - Readonly min: 1
    - Readonly type: "int"
Readonly contents: readonly [{
    type: "optional";
    value: typeof Diatonic;
}, {
    type: "required";
    value: typeof Chromatic;
}, {
    type: "optional";
    value: typeof OctaveChange;
}, {
    type: "optional";
    value: typeof Double;
}]
Readonly name: "transpose"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    number: {
        type: "optional";
        value: {
            max: number;
            min: 1;
            type: "int";
        };
    };
}
- 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: number;
          min: 1;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 1;
        type: "int";
    }
    - Readonly max: number
    - Readonly min: 1
    - Readonly type: "int"
Readonly contents: readonly [{
    type: "optional";
    value: typeof Diatonic;
}, {
    type: "required";
    value: typeof Chromatic;
}, {
    type: "optional";
    value: typeof OctaveChange;
}, {
    type: "optional";
    value: typeof Double;
}]
Readonly name: "transpose"

Methods

getChromatic

getChromatic(): Chromatic
Gets

Returns Chromatic
- Defined in generated/elements.ts:50307

getDiatonic

getDiatonic(): null | Diatonic
Gets

Returns null | Diatonic
- Defined in generated/elements.ts:50298

getDouble

getDouble(): null | Double
Gets

Returns null | Double
- Defined in generated/elements.ts:50325

getId

getId(): null | string
Gets

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

getNumber

getNumber(): null | number
Gets

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

getOctaveChange

getOctaveChange(): null | OctaveChange
Gets

Returns null | OctaveChange
- Defined in generated/elements.ts:50316

setChromatic

setChromatic(chromatic): Transpose
Sets
Parameters
- chromatic: Chromatic
Returns Transpose
- Defined in generated/elements.ts:50311

setDiatonic

setDiatonic(diatonic): Transpose
Sets
Parameters
- diatonic: null | Diatonic
Returns Transpose
- Defined in generated/elements.ts:50302

setDouble

setDouble(double): Transpose
Sets
Parameters
- double: null | Double
Returns Transpose
- Defined in generated/elements.ts:50329

setId

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

setNumber

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

setOctaveChange

setOctaveChange(octaveChange): Transpose
Sets
Parameters
- octaveChange: null | OctaveChange
Returns Transpose
- Defined in generated/elements.ts:50320

Class Transpose

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<TransposeAttributes>; contents?: TransposeContents; }

Optional attributes?: Partial<TransposeAttributes>

Optional contents?: TransposeContents

Returns Transpose

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; number: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }; }

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: number; min: 1; type: "int"; }; }

Readonly type: "optional"

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

Readonly max: number

Readonly min: 1

Readonly type: "int"

Readonly contents: readonly [{ type: "optional"; value: typeof Diatonic; }, { type: "required"; value: typeof Chromatic; }, { type: "optional"; value: typeof OctaveChange; }, { type: "optional"; value: typeof Double; }]

Readonly name: "transpose"

Static Readonly schema

Type declaration

Readonly attributes: { id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; number: { type: "optional"; value: { max: number; min: 1; type: "int"; }; }; }

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: number; min: 1; type: "int"; }; }

Readonly type: "optional"

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

Readonly max: number

Readonly min: 1

Readonly type: "int"

Readonly contents: readonly [{ type: "optional"; value: typeof Diatonic; }, { type: "required"; value: typeof Chromatic; }, { type: "optional"; value: typeof OctaveChange; }, { type: "optional"; value: typeof Double; }]

Readonly name: "transpose"

Methods

getChromatic

Returns Chromatic

getDiatonic

Returns null | Diatonic

getDouble

Returns null | Double

getId

Returns null | string

getNumber

Returns null | number

getOctaveChange

Returns null | OctaveChange

setChromatic

Parameters

chromatic: Chromatic

Returns Transpose

setDiatonic

Parameters

diatonic: null | Diatonic

Returns Transpose

setDouble

Parameters

double: null | Double

Returns Transpose

setId

Parameters

id: null | string

Returns Transpose

`Optional` opts: {
attributes?: Partial<TransposeAttributes>;
contents?: TransposeContents;
}

`Optional` attributes?: Partial<TransposeAttributes>

`Optional` contents?: TransposeContents

`Readonly` schema

`Readonly` attributes: {
id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
number: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
};
}

`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: number;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

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

`Readonly` max: number

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` contents: readonly [{
type: "optional";
value: typeof Diatonic;
}, {
type: "required";
value: typeof Chromatic;
}, {
type: "optional";
value: typeof OctaveChange;
}, {
type: "optional";
value: typeof Double;
}]

`Readonly` name: "transpose"

`Static` `Readonly` schema

`Readonly` attributes: {
id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
number: {
type: "optional";
value: {
max: number;
min: 1;
type: "int";
};
};
}

`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: number;
min: 1;
type: "int";
};
}

`Readonly` type: "optional"

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

`Readonly` max: number

`Readonly` min: 1

`Readonly` type: "int"

`Readonly` contents: readonly [{
type: "optional";
value: typeof Diatonic;
}, {
type: "required";
value: typeof Chromatic;
}, {
type: "optional";
value: typeof OctaveChange;
}, {
type: "optional";
value: typeof Double;
}]

`Readonly` name: "transpose"