Class PartLink

The <part-link> element

Parent element: <score-part>

The <part-link> element allows MusicXML data for both score and parts to be contained within a single compressed MusicXML file. It links a <score-part> from a score document to MusicXML documents that contain parts data. In the case of a single compressed MusicXML file, the link href values are paths that are relative to the root folder of the zip file.

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

Hierarchy

PartLink

Implements

XMLElement<"part-link", PartLinkAttributes, PartLinkContents>

Constructors

constructor

new PartLink(opts?): PartLink
Parameters
- Optional opts: {
  attributes?: Partial<PartLinkAttributes>;
  contents?: PartLinkContents;
  }
  - Optional attributes?: Partial<PartLinkAttributes>
  - Optional contents?: PartLinkContents
Returns PartLink
- Defined in generated/elements.ts:7846

Properties

attributes

attributes: PartLinkAttributes

contents: PartLinkContents

`Readonly` schema

schema: {
    attributes: {
        xlink:actuate: {
            type: "optional";
            value: {
                choices: readonly ["none", "onRequest", "onLoad", "other"];
                type: "choices";
            };
        };
        xlink:href: {
            type: "required";
            value: {
                type: "string";
            };
        };
        xlink:role: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        xlink:show: {
            type: "optional";
            value: {
                choices: readonly ["none", "new", "replace", "embed", "other"];
                type: "choices";
            };
        };
        xlink:title: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        xlink:type: {
            type: "optional";
            value: {
                choices: readonly ["simple"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        label: "instrument-links";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof InstrumentLink;
        };
    }, {
        label: "group-links";
        type: "label";
        value: {
            type: "zeroOrMore";
            value: typeof GroupLink;
        };
    }];
    name: "part-link";
} = PartLink.schema

Type declaration

Readonly attributes: {
    xlink:actuate: {
        type: "optional";
        value: {
            choices: readonly ["none", "onRequest", "onLoad", "other"];
            type: "choices";
        };
    };
    xlink:href: {
        type: "required";
        value: {
            type: "string";
        };
    };
    xlink:role: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    xlink:show: {
        type: "optional";
        value: {
            choices: readonly ["none", "new", "replace", "embed", "other"];
            type: "choices";
        };
    };
    xlink:title: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    xlink:type: {
        type: "optional";
        value: {
            choices: readonly ["simple"];
            type: "choices";
        };
    };
}
- Readonly xlink:actuate: {
      type: "optional";
      value: {
          choices: readonly ["none", "onRequest", "onLoad", "other"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "onRequest", "onLoad", "other"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "onRequest", "onLoad", "other"]
    - Readonly type: "choices"
- Readonly xlink:href: {
      type: "required";
      value: {
          type: "string";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:role: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:show: {
      type: "optional";
      value: {
          choices: readonly ["none", "new", "replace", "embed", "other"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "new", "replace", "embed", "other"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "new", "replace", "embed", "other"]
    - Readonly type: "choices"
- Readonly xlink:title: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:type: {
      type: "optional";
      value: {
          choices: readonly ["simple"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["simple"];
    type: "choices";
    }
    - Readonly choices: readonly ["simple"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "instrument-links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof InstrumentLink;
    };
}, {
    label: "group-links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof GroupLink;
    };
}]
Readonly name: "part-link"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    xlink:actuate: {
        type: "optional";
        value: {
            choices: readonly ["none", "onRequest", "onLoad", "other"];
            type: "choices";
        };
    };
    xlink:href: {
        type: "required";
        value: {
            type: "string";
        };
    };
    xlink:role: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    xlink:show: {
        type: "optional";
        value: {
            choices: readonly ["none", "new", "replace", "embed", "other"];
            type: "choices";
        };
    };
    xlink:title: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    xlink:type: {
        type: "optional";
        value: {
            choices: readonly ["simple"];
            type: "choices";
        };
    };
}
- Readonly xlink:actuate: {
      type: "optional";
      value: {
          choices: readonly ["none", "onRequest", "onLoad", "other"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "onRequest", "onLoad", "other"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "onRequest", "onLoad", "other"]
    - Readonly type: "choices"
- Readonly xlink:href: {
      type: "required";
      value: {
          type: "string";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:role: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:show: {
      type: "optional";
      value: {
          choices: readonly ["none", "new", "replace", "embed", "other"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "new", "replace", "embed", "other"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "new", "replace", "embed", "other"]
    - Readonly type: "choices"
- Readonly xlink:title: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly xlink:type: {
      type: "optional";
      value: {
          choices: readonly ["simple"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["simple"];
    type: "choices";
    }
    - Readonly choices: readonly ["simple"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    label: "instrument-links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof InstrumentLink;
    };
}, {
    label: "group-links";
    type: "label";
    value: {
        type: "zeroOrMore";
        value: typeof GroupLink;
    };
}]
Readonly name: "part-link"

Methods

getGroupLinks

getGroupLinks(): GroupLink[]
Gets

Returns GroupLink[]
- Defined in generated/elements.ts:7914

getInstrumentLinks

getInstrumentLinks(): InstrumentLink[]
Gets

Returns InstrumentLink[]
- Defined in generated/elements.ts:7905

getXlinkActuate

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

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

getXlinkHref

getXlinkHref(): string
Gets

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

getXlinkRole

getXlinkRole(): null | string
Gets

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

getXlinkShow

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

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

getXlinkTitle

getXlinkTitle(): null | string
Gets

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

getXlinkType

getXlinkType(): null | "simple"
Gets

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

setGroupLinks

setGroupLinks(groupLinks): PartLink
Sets
Parameters
- groupLinks: GroupLink[]
Returns PartLink
- Defined in generated/elements.ts:7918

setInstrumentLinks

setInstrumentLinks(instrumentLinks): PartLink
Sets
Parameters
- instrumentLinks: InstrumentLink[]
Returns PartLink
- Defined in generated/elements.ts:7909

setXlinkActuate

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

setXlinkHref

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

setXlinkRole

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

setXlinkShow

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

setXlinkTitle

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

setXlinkType

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

Class PartLink

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<PartLinkAttributes>; contents?: PartLinkContents; }

Optional attributes?: Partial<PartLinkAttributes>

Optional contents?: PartLinkContents

Returns PartLink

Properties

attributes

contents

Readonly schema

Type declaration

Readonly xlink:actuate: { type: "optional"; value: { choices: readonly ["none", "onRequest", "onLoad", "other"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["none", "onRequest", "onLoad", "other"]; type: "choices"; }

Readonly choices: readonly ["none", "onRequest", "onLoad", "other"]

Readonly type: "choices"

Readonly xlink:href: { type: "required"; value: { type: "string"; }; }

Readonly type: "required"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:role: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:show: { type: "optional"; value: { choices: readonly ["none", "new", "replace", "embed", "other"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["none", "new", "replace", "embed", "other"]; type: "choices"; }

Readonly choices: readonly ["none", "new", "replace", "embed", "other"]

Readonly type: "choices"

Readonly xlink:title: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:type: { type: "optional"; value: { choices: readonly ["simple"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["simple"]; type: "choices"; }

Readonly choices: readonly ["simple"]

Readonly type: "choices"

Readonly contents: readonly [{ label: "instrument-links"; type: "label"; value: { type: "zeroOrMore"; value: typeof InstrumentLink; }; }, { label: "group-links"; type: "label"; value: { type: "zeroOrMore"; value: typeof GroupLink; }; }]

Readonly name: "part-link"

Static Readonly schema

Type declaration

Readonly xlink:actuate: { type: "optional"; value: { choices: readonly ["none", "onRequest", "onLoad", "other"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["none", "onRequest", "onLoad", "other"]; type: "choices"; }

Readonly choices: readonly ["none", "onRequest", "onLoad", "other"]

Readonly type: "choices"

Readonly xlink:href: { type: "required"; value: { type: "string"; }; }

Readonly type: "required"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:role: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:show: { type: "optional"; value: { choices: readonly ["none", "new", "replace", "embed", "other"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["none", "new", "replace", "embed", "other"]; type: "choices"; }

Readonly choices: readonly ["none", "new", "replace", "embed", "other"]

Readonly type: "choices"

Readonly xlink:title: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

Readonly xlink:type: { type: "optional"; value: { choices: readonly ["simple"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["simple"]; type: "choices"; }

Readonly choices: readonly ["simple"]

Readonly type: "choices"

Readonly contents: readonly [{ label: "instrument-links"; type: "label"; value: { type: "zeroOrMore"; value: typeof InstrumentLink; }; }, { label: "group-links"; type: "label"; value: { type: "zeroOrMore"; value: typeof GroupLink; }; }]

Readonly name: "part-link"

Methods

`Optional` opts: {
attributes?: Partial<PartLinkAttributes>;
contents?: PartLinkContents;
}

`Optional` attributes?: Partial<PartLinkAttributes>

`Optional` contents?: PartLinkContents

`Readonly` schema

`Readonly` xlink:actuate: {
type: "optional";
value: {
choices: readonly ["none", "onRequest", "onLoad", "other"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["none", "onRequest", "onLoad", "other"];
type: "choices";
}

`Readonly` choices: readonly ["none", "onRequest", "onLoad", "other"]

`Readonly` type: "choices"

`Readonly` xlink:href: {
type: "required";
value: {
type: "string";
};
}

`Readonly` type: "required"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:role: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:show: {
type: "optional";
value: {
choices: readonly ["none", "new", "replace", "embed", "other"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["none", "new", "replace", "embed", "other"];
type: "choices";
}

`Readonly` choices: readonly ["none", "new", "replace", "embed", "other"]

`Readonly` type: "choices"

`Readonly` xlink:title: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:type: {
type: "optional";
value: {
choices: readonly ["simple"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["simple"];
type: "choices";
}

`Readonly` choices: readonly ["simple"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
label: "instrument-links";
type: "label";
value: {
type: "zeroOrMore";
value: typeof InstrumentLink;
};
}, {
label: "group-links";
type: "label";
value: {
type: "zeroOrMore";
value: typeof GroupLink;
};
}]

`Readonly` name: "part-link"

`Static` `Readonly` schema

`Readonly` xlink:actuate: {
type: "optional";
value: {
choices: readonly ["none", "onRequest", "onLoad", "other"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["none", "onRequest", "onLoad", "other"];
type: "choices";
}

`Readonly` choices: readonly ["none", "onRequest", "onLoad", "other"]

`Readonly` type: "choices"

`Readonly` xlink:href: {
type: "required";
value: {
type: "string";
};
}

`Readonly` type: "required"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:role: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:show: {
type: "optional";
value: {
choices: readonly ["none", "new", "replace", "embed", "other"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["none", "new", "replace", "embed", "other"];
type: "choices";
}

`Readonly` choices: readonly ["none", "new", "replace", "embed", "other"]

`Readonly` type: "choices"

`Readonly` xlink:title: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

`Readonly` value: {
type: "string";
}

`Readonly` type: "string"

`Readonly` xlink:type: {
type: "optional";
value: {
choices: readonly ["simple"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["simple"];
type: "choices";
}

`Readonly` choices: readonly ["simple"]

`Readonly` type: "choices"

`Readonly` contents: readonly [{
label: "instrument-links";
type: "label";
value: {
type: "zeroOrMore";
value: typeof InstrumentLink;
};
}, {
label: "group-links";
type: "label";
value: {
type: "zeroOrMore";
value: typeof GroupLink;
};
}]

`Readonly` name: "part-link"