Class Distance

The <distance> element

Parent element: <appearance>

The <distance> element represents standard distances between notation elements in tenths.

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

Hierarchy

Distance

Implements

XMLElement<"distance", DistanceAttributes, DistanceContents>

Index

Constructors

constructor

new Distance(opts?): Distance
Parameters
- Optional opts: {
  attributes?: Partial<DistanceAttributes>;
  contents?: DistanceContents;
  }
  - Optional attributes?: Partial<DistanceAttributes>
  - Optional contents?: DistanceContents
Returns Distance
- Defined in generated/elements.ts:2298

Properties

attributes

attributes: DistanceAttributes

contents: DistanceContents

`Readonly` schema

schema: {
    attributes: {
        type: {
            type: "required";
            value: {
                choices: readonly ["beam", "hyphen"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "distance";
        type: "label";
        value: {
            type: "required";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    }];
    name: "distance";
} = Distance.schema

Type declaration

Readonly attributes: {
    type: {
        type: "required";
        value: {
            choices: readonly ["beam", "hyphen"];
            type: "choices";
        };
    };
}
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["beam", "hyphen"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["beam", "hyphen"];
    type: "choices";
    }
    - Readonly choices: readonly ["beam", "hyphen"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "distance";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]
Readonly name: "distance"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    type: {
        type: "required";
        value: {
            choices: readonly ["beam", "hyphen"];
            type: "choices";
        };
    };
}
- Readonly type: {
      type: "required";
      value: {
          choices: readonly ["beam", "hyphen"];
          type: "choices";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    choices: readonly ["beam", "hyphen"];
    type: "choices";
    }
    - Readonly choices: readonly ["beam", "hyphen"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "distance";
    type: "label";
    value: {
        type: "required";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}]
Readonly name: "distance"

Methods

getDistance

getDistance(): number
Gets

Returns number
- Defined in generated/elements.ts:2312

getType

getType(): "beam" | "hyphen"
Gets

Returns "beam" | "hyphen"
- Defined in generated/elements.ts:2303

setDistance

setDistance(distance): Distance
Sets
Parameters
- distance: number
Returns Distance
- Defined in generated/elements.ts:2316

setType

setType(type): Distance
Sets
Parameters
- type: "beam" | "hyphen"
Returns Distance
- Defined in generated/elements.ts:2307

Class Distance

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<DistanceAttributes>; contents?: DistanceContents; }

Optional attributes?: Partial<DistanceAttributes>

Optional contents?: DistanceContents

Returns Distance

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: { type: { type: "required"; value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }; }; }

Readonly type: { type: "required"; value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }

Readonly choices: readonly ["beam", "hyphen"]

Readonly type: "choices"

Readonly contents: readonly [{ label: "distance"; type: "label"; value: { type: "required"; value: { max: number; min: number; type: "float"; }; }; }]

Readonly name: "distance"

Static Readonly schema

Type declaration

Readonly attributes: { type: { type: "required"; value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }; }; }

Readonly type: { type: "required"; value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }; }

Readonly type: "required"

Readonly value: { choices: readonly ["beam", "hyphen"]; type: "choices"; }

Readonly choices: readonly ["beam", "hyphen"]

Readonly type: "choices"

Readonly contents: readonly [{ label: "distance"; type: "label"; value: { type: "required"; value: { max: number; min: number; type: "float"; }; }; }]

Readonly name: "distance"

Methods

getDistance

Returns number

getType

Returns "beam" | "hyphen"

setDistance

Parameters

distance: number

Returns Distance

setType

Parameters

type: "beam" | "hyphen"

Returns Distance

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<DistanceAttributes>;
contents?: DistanceContents;
}

`Optional` attributes?: Partial<DistanceAttributes>

`Optional` contents?: DistanceContents

`Readonly` schema

`Readonly` attributes: {
type: {
type: "required";
value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
};
};
}

`Readonly` type: {
type: "required";
value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
}

`Readonly` choices: readonly ["beam", "hyphen"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
label: "distance";
type: "label";
value: {
type: "required";
value: {
max: number;
min: number;
type: "float";
};
};
}]

`Readonly` name: "distance"

`Static` `Readonly` schema

`Readonly` attributes: {
type: {
type: "required";
value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
};
};
}

`Readonly` type: {
type: "required";
value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
};
}

`Readonly` type: "required"

`Readonly` value: {
choices: readonly ["beam", "hyphen"];
type: "choices";
}

`Readonly` choices: readonly ["beam", "hyphen"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
label: "distance";
type: "label";
value: {
type: "required";
value: {
max: number;
min: number;
type: "float";
};
};
}]

`Readonly` name: "distance"