Class CreditImage

The <credit-image> element

Parent element: <credit>

The <credit-image> element is similar to the <image> element for a <direction>. However, since the <credit> is not part of a measure, the default-x and default-y attributes adjust the origin relative to the bottom left-hand corner of the page.

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

Hierarchy

CreditImage

Implements

XMLElement<"credit-image", CreditImageAttributes, CreditImageContents>

Index

Constructors

constructor

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

Properties

attributes

attributes: CreditImageAttributes

contents: []

`Readonly` schema

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";
                };
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        height: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        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";
                };
            };
        };
        source: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        type: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [];
    name: "credit-image";
} = CreditImage.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";
            };
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    height: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    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";
            };
        };
    };
    source: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    type: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom"];
            type: "choices";
        };
    };
    width: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}
- 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 halign: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - Readonly type: "choices"
- Readonly height: {
      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 id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- 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 source: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly type: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom"]
    - Readonly type: "choices"
- Readonly width: {
      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 contents: readonly []
Readonly name: "credit-image"

`Static` `Readonly` 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";
            };
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    height: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    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";
            };
        };
    };
    source: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    type: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom"];
            type: "choices";
        };
    };
    width: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}
- 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 halign: {
      type: "optional";
      value: {
          choices: readonly ["left", "center", "right"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["left", "center", "right"];
    type: "choices";
    }
    - Readonly choices: readonly ["left", "center", "right"]
    - Readonly type: "choices"
- Readonly height: {
      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 id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- 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 source: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly type: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom"]
    - Readonly type: "choices"
- Readonly width: {
      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 contents: readonly []
Readonly name: "credit-image"

Methods

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getHalign

getHalign(): null | "left" | "center" | "right"
Gets

Returns null | "left" | "center" | "right"
- Defined in generated/elements.ts:3695

getHeight

getHeight(): null | number
Gets

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSource

getSource(): null | string
Gets

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

getType

getType(): null | string
Gets

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

getValign

getValign(): null | "top" | "middle" | "bottom"
Gets

Returns null | "top" | "middle" | "bottom"
- Defined in generated/elements.ts:3758

getWidth

getWidth(): null | number
Gets

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

setDefaultX

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

setDefaultY

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

setHalign

setHalign(halign): CreditImage
Sets
Parameters
- halign: null | "left" | "center" | "right"
Returns CreditImage
- Defined in generated/elements.ts:3699

setHeight

setHeight(height): CreditImage
Sets
Parameters
- height: null | number
Returns CreditImage
- Defined in generated/elements.ts:3708

setId

setId(id): CreditImage
Sets
Parameters
- id: null | string
Returns CreditImage
- Defined in generated/elements.ts:3717

setRelativeX

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

setRelativeY

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

setSource

setSource(source): CreditImage
Sets
Parameters
- source: null | string
Returns CreditImage
- Defined in generated/elements.ts:3744

setType

setType(type): CreditImage
Sets
Parameters
- type: null | string
Returns CreditImage
- Defined in generated/elements.ts:3753

setValign

setValign(valign): CreditImage
Sets
Parameters
- valign: null | "top" | "middle" | "bottom"
Returns CreditImage
- Defined in generated/elements.ts:3762

setWidth

setWidth(width): CreditImage
Sets
Parameters
- width: null | number
Returns CreditImage
- Defined in generated/elements.ts:3771

Class CreditImage

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Optional attributes?: Partial<CreditImageAttributes>

Optional contents?: []

Returns CreditImage

Properties

attributes

contents

Readonly schema

Type declaration

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 halign: { type: "optional"; value: { choices: readonly ["left", "center", "right"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["left", "center", "right"]; type: "choices"; }

Readonly choices: readonly ["left", "center", "right"]

Readonly type: "choices"

Readonly height: { 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 id: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "optional"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

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 source: { type: "optional"; value: { type: "string"; }; }

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

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

Readonly type: "optional"

Readonly value: { type: "string"; }

Readonly type: "string"

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

`Optional` attributes?: Partial<CreditImageAttributes>

`Optional` contents?: []

`Readonly` schema

`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` halign: {
type: "optional";
value: {
choices: readonly ["left", "center", "right"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["left", "center", "right"];
type: "choices";
}

`Readonly` choices: readonly ["left", "center", "right"]

`Readonly` type: "choices"

`Readonly` height: {
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` id: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "optional"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`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` source: {
type: "optional";
value: {
type: "string";
};
}

`Readonly` type: "optional"

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

`Readonly` type: "string"

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

`Readonly` type: "optional"

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

`Readonly` type: "string"

`Readonly` valign: {
type: "optional";
value: {
choices: readonly ["top", "middle", "bottom"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["top", "middle", "bottom"];
type: "choices";
}

`Readonly` choices: readonly ["top", "middle", "bottom"]

`Readonly` type: "choices"

`Readonly` width: {
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` contents: readonly []

`Readonly` name: "credit-image"

`Static` `Readonly` schema

`Readonly` default-x: {
label: "default-x";
type: "label";
value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
};
}