Class Link

The <link> element.

The link type serves as an outgoing simple XLink. If a relative link is used within a document that is part of a compressed MusicXML file, the link is relative to the root folder of the zip file.

See

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

Hierarchy

Link

Implements

XMLElement<"link", LinkAttributes, LinkContents>

Constructors

constructor

new Link(opts?): Link
Parameters
- Optional opts: {
  attributes?: Partial<LinkAttributes>;
  contents?: [];
  }
  - Optional attributes?: Partial<LinkAttributes>
  - Optional contents?: []
Returns Link
- Defined in generated/elements.ts:2907

Properties

attributes

attributes: LinkAttributes

contents

contents: []

`Readonly` schema

schema: XMLElementSchema<"link"> = Link.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"link"> = schema.Link

Methods

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getElement

getElement(): null | string
Gets

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

getName

getName(): null | string
Gets

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

getPosition

getPosition(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getXlinkActuate

getXlinkActuate(): null | "none" | "onRequest" | "onLoad" | "other"
Gets

Returns null | "none" | "onRequest" | "onLoad" | "other"
- Defined in generated/elements.ts:2975

getXlinkHref

getXlinkHref(): string
Gets

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

getXlinkRole

getXlinkRole(): null | string
Gets

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

getXlinkShow

getXlinkShow(): null | "none" | "other" | "new" | "replace" | "embed"
Gets

Returns null | "none" | "other" | "new" | "replace" | "embed"
- Defined in generated/elements.ts:3002

getXlinkTitle

getXlinkTitle(): null | string
Gets

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

getXlinkType

getXlinkType(): null | "simple"
Gets

Returns null | "simple"
- Defined in generated/elements.ts:3020

setDefaultX

setDefaultX(defaultX): Link
Sets
Parameters
- defaultX: null | number
Returns Link
- Defined in generated/elements.ts:2916

setDefaultY

setDefaultY(defaultY): Link
Sets
Parameters
- defaultY: null | number
Returns Link
- Defined in generated/elements.ts:2925

setElement

setElement(element): Link
Sets
Parameters
- element: null | string
Returns Link
- Defined in generated/elements.ts:2934

setName

setName(name): Link
Sets
Parameters
- name: null | string
Returns Link
- Defined in generated/elements.ts:2943

setPosition

setPosition(position): Link
Sets
Parameters
- position: null | number
Returns Link
- Defined in generated/elements.ts:2952

setRelativeX

setRelativeX(relativeX): Link
Sets
Parameters
- relativeX: null | number
Returns Link
- Defined in generated/elements.ts:2961

setRelativeY

setRelativeY(relativeY): Link
Sets
Parameters
- relativeY: null | number
Returns Link
- Defined in generated/elements.ts:2970

setXlinkActuate

setXlinkActuate(xlinkActuate): Link
Sets
Parameters
- xlinkActuate: null | "none" | "onRequest" | "onLoad" | "other"
Returns Link
- Defined in generated/elements.ts:2979

setXlinkHref

setXlinkHref(xlinkHref): Link
Sets
Parameters
- xlinkHref: string
Returns Link
- Defined in generated/elements.ts:2988

setXlinkRole

setXlinkRole(xlinkRole): Link
Sets
Parameters
- xlinkRole: null | string
Returns Link
- Defined in generated/elements.ts:2997

setXlinkShow

setXlinkShow(xlinkShow): Link
Sets
Parameters
- xlinkShow: null | "none" | "other" | "new" | "replace" | "embed"
Returns Link
- Defined in generated/elements.ts:3006

setXlinkTitle

setXlinkTitle(xlinkTitle): Link
Sets
Parameters
- xlinkTitle: null | string
Returns Link
- Defined in generated/elements.ts:3015

setXlinkType

setXlinkType(xlinkType): Link
Sets
Parameters
- xlinkType: null | "simple"
Returns Link
- Defined in generated/elements.ts:3024

Generated using TypeDoc