The <link> element

Parent elements: <credit>, <measure> (partwise), <part> (timewise)

The <link> element 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.

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

Hierarchy

  • Link

Implements

Constructors

Properties

attributes: LinkAttributes
contents: []
schema: {
    attributes: {
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        element: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        name: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        position: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        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: "link";
} = Link.schema

Type declaration

  • Readonly attributes: {
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        element: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        name: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        position: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        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 default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly element: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly name: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly position: {
          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 relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • 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: "link"
schema: {
    attributes: {
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        element: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        name: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        position: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        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: "link";
} = ...

Type declaration

  • Readonly attributes: {
        default-x: {
            label: "default-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        default-y: {
            label: "default-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        element: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        name: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        position: {
            type: "optional";
            value: {
                max: number;
                min: 1;
                type: "int";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        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 default-x: {
          label: "default-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly default-y: {
          label: "default-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "default-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly element: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly name: {
          type: "optional";
          value: {
              type: "string";
          };
      }
      • Readonly type: "optional"
      • Readonly value: {
            type: "string";
        }
        • Readonly type: "string"
    • Readonly position: {
          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 relative-x: {
          label: "relative-x";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-x"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • Readonly relative-y: {
          label: "relative-y";
          type: "label";
          value: {
              type: "optional";
              value: {
                  max: number;
                  min: number;
                  type: "float";
              };
          };
      }
      • Readonly label: "relative-y"
      • Readonly type: "label"
      • Readonly value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        }
        • Readonly type: "optional"
        • Readonly value: {
              max: number;
              min: number;
              type: "float";
          }
          • Readonly max: number
          • Readonly min: number
          • Readonly type: "float"
    • 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: "link"

Methods

  • Gets

    Returns null | "none" | "onRequest" | "onLoad" | "other"

  • Gets

    Returns null | "replace" | "none" | "other" | "new" | "embed"

Generated using TypeDoc