Class Opus

The <opus> element

Parent element: <work>

The <opus> element represents a link to a MusicXML opus document that composes multiple MusicXML scores into a collection.

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

Hierarchy

Opus

Implements

XMLElement<"opus", OpusAttributes, OpusContents>

Index

Constructors

constructor

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

Properties

attributes

attributes: OpusAttributes

contents: []

`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 [];
    name: "opus";
} = Opus.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 []
Readonly name: "opus"

`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 []
Readonly name: "opus"

Methods

getXlinkActuate

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

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

getXlinkHref

getXlinkHref(): string
Gets

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

getXlinkRole

getXlinkRole(): null | string
Gets

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

getXlinkShow

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

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

getXlinkTitle

getXlinkTitle(): null | string
Gets

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

getXlinkType

getXlinkType(): null | "simple"
Gets

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

setXlinkActuate

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

setXlinkHref

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

setXlinkRole

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

setXlinkShow

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

setXlinkTitle

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

setXlinkType

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

Class Opus

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<OpusAttributes>; contents?: []; }

Optional attributes?: Partial<OpusAttributes>

Optional contents?: []

Returns Opus

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 []

Readonly name: "opus"

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 []

Readonly name: "opus"

Methods

`Optional` opts: {
attributes?: Partial<OpusAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<OpusAttributes>

`Optional` contents?: []

`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 []

`Readonly` name: "opus"

`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 []

`Readonly` name: "opus"