Class CreditSymbol

The <credit-symbol> element

Parent element: <credit>

The <credit-symbol> element is similar to the <symbol> 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. The enclosure is none if not specified.

By default, a series of <credit-words> and <credit-symbol> elements within a single <credit> element follow one another in sequence visually. Non-positional formatting attributes are carried over from the previous element by default.

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

Hierarchy

CreditSymbol

Implements

XMLElement<"credit-symbol", CreditSymbolAttributes, CreditSymbolContents>

Constructors

constructor

new CreditSymbol(opts?): CreditSymbol
Parameters
- Optional opts: {
  attributes?: Partial<CreditSymbolAttributes>;
  contents?: CreditSymbolContents;
  }
  - Optional attributes?: Partial<CreditSymbolAttributes>
  - Optional contents?: CreditSymbolContents
Returns CreditSymbol
- Defined in generated/elements.ts:4515

Properties

attributes

attributes: CreditSymbolAttributes

contents: CreditSymbolContents

`Readonly` schema

schema: {
    attributes: {
        color: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "#000000";
            };
        };
        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";
                };
            };
        };
        dir: {
            type: "optional";
            value: {
                choices: readonly ["ltr", "rtl", "lro", "rlo"];
                type: "choices";
            };
        };
        enclosure: {
            type: "optional";
            value: {
                choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
                type: "choices";
            };
        };
        font-family: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: " ";
            };
        };
        font-size: {
            type: "optional";
            value: {
                choices: readonly [{
                    choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                    type: "choices";
                }, {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        font-style: {
            type: "optional";
            value: {
                choices: readonly ["normal", "italic"];
                type: "choices";
            };
        };
        font-weight: {
            type: "optional";
            value: {
                choices: readonly ["normal", "bold"];
                type: "choices";
            };
        };
        halign: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        justify: {
            type: "optional";
            value: {
                choices: readonly ["left", "center", "right"];
                type: "choices";
            };
        };
        letter-spacing: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-height: {
            type: "optional";
            value: {
                choices: readonly ["normal", {
                    max: number;
                    min: number;
                    type: "float";
                }];
                type: "choices";
            };
        };
        line-through: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        overline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                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";
                };
            };
        };
        rotation: {
            type: "optional";
            value: {
                max: 180;
                min: -180;
                type: "float";
            };
        };
        underline: {
            type: "optional";
            value: {
                max: 3;
                min: 0;
                type: "int";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom", "baseline"];
                type: "choices";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: {
            type: "string";
        };
    }];
    name: "credit-symbol";
} = CreditSymbol.schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    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";
            };
        };
    };
    dir: {
        type: "optional";
        value: {
            choices: readonly ["ltr", "rtl", "lro", "rlo"];
            type: "choices";
        };
    };
    enclosure: {
        type: "optional";
        value: {
            choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
            type: "choices";
        };
    };
    font-family: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: " ";
        };
    };
    font-size: {
        type: "optional";
        value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    font-style: {
        type: "optional";
        value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        };
    };
    font-weight: {
        type: "optional";
        value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    justify: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    letter-spacing: {
        type: "optional";
        value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    line-height: {
        type: "optional";
        value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    line-through: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            type: "int";
        };
    };
    overline: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            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";
            };
        };
    };
    rotation: {
        type: "optional";
        value: {
            max: 180;
            min: -180;
            type: "float";
        };
    };
    underline: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            type: "int";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- 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 dir: {
      type: "optional";
      value: {
          choices: readonly ["ltr", "rtl", "lro", "rlo"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["ltr", "rtl", "lro", "rlo"];
    type: "choices";
    }
    - Readonly choices: readonly ["ltr", "rtl", "lro", "rlo"]
    - Readonly type: "choices"
- Readonly enclosure: {
      type: "optional";
      value: {
          choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]
    - Readonly type: "choices"
- Readonly font-family: {
      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 font-size: {
      type: "optional";
      value: {
          choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly [{
            choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
            type: "choices";
        }, {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly [{
          choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
          type: "choices";
      }, {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly font-style: {
      type: "optional";
      value: {
          choices: readonly ["normal", "italic"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["normal", "italic"];
    type: "choices";
    }
    - Readonly choices: readonly ["normal", "italic"]
    - Readonly type: "choices"
- Readonly font-weight: {
      type: "optional";
      value: {
          choices: readonly ["normal", "bold"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["normal", "bold"];
    type: "choices";
    }
    - Readonly choices: readonly ["normal", "bold"]
    - Readonly type: "choices"
- 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 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 justify: {
      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 letter-spacing: {
      type: "optional";
      value: {
          choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly ["normal", {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly ["normal", {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly line-height: {
      type: "optional";
      value: {
          choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly ["normal", {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly ["normal", {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly line-through: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - Readonly type: "int"
- Readonly overline: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - 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 rotation: {
      type: "optional";
      value: {
          max: 180;
          min: -180;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 180;
        min: -180;
        type: "float";
    }
    - Readonly max: 180
    - Readonly min: -180
    - Readonly type: "float"
- Readonly underline: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - Readonly type: "int"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom", "baseline"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom", "baseline"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]
Readonly name: "credit-symbol"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    color: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "#000000";
        };
    };
    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";
            };
        };
    };
    dir: {
        type: "optional";
        value: {
            choices: readonly ["ltr", "rtl", "lro", "rlo"];
            type: "choices";
        };
    };
    enclosure: {
        type: "optional";
        value: {
            choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
            type: "choices";
        };
    };
    font-family: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: " ";
        };
    };
    font-size: {
        type: "optional";
        value: {
            choices: readonly [{
                choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
                type: "choices";
            }, {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    font-style: {
        type: "optional";
        value: {
            choices: readonly ["normal", "italic"];
            type: "choices";
        };
    };
    font-weight: {
        type: "optional";
        value: {
            choices: readonly ["normal", "bold"];
            type: "choices";
        };
    };
    halign: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    justify: {
        type: "optional";
        value: {
            choices: readonly ["left", "center", "right"];
            type: "choices";
        };
    };
    letter-spacing: {
        type: "optional";
        value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    line-height: {
        type: "optional";
        value: {
            choices: readonly ["normal", {
                max: number;
                min: number;
                type: "float";
            }];
            type: "choices";
        };
    };
    line-through: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            type: "int";
        };
    };
    overline: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            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";
            };
        };
    };
    rotation: {
        type: "optional";
        value: {
            max: 180;
            min: -180;
            type: "float";
        };
    };
    underline: {
        type: "optional";
        value: {
            max: 3;
            min: 0;
            type: "int";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom", "baseline"];
            type: "choices";
        };
    };
}
- Readonly color: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "#000000";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "#000000";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "#000000"
- 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 dir: {
      type: "optional";
      value: {
          choices: readonly ["ltr", "rtl", "lro", "rlo"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["ltr", "rtl", "lro", "rlo"];
    type: "choices";
    }
    - Readonly choices: readonly ["ltr", "rtl", "lro", "rlo"]
    - Readonly type: "choices"
- Readonly enclosure: {
      type: "optional";
      value: {
          choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]
    - Readonly type: "choices"
- Readonly font-family: {
      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 font-size: {
      type: "optional";
      value: {
          choices: readonly [{
              choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
              type: "choices";
          }, {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly [{
            choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
            type: "choices";
        }, {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly [{
          choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
          type: "choices";
      }, {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly font-style: {
      type: "optional";
      value: {
          choices: readonly ["normal", "italic"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["normal", "italic"];
    type: "choices";
    }
    - Readonly choices: readonly ["normal", "italic"]
    - Readonly type: "choices"
- Readonly font-weight: {
      type: "optional";
      value: {
          choices: readonly ["normal", "bold"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["normal", "bold"];
    type: "choices";
    }
    - Readonly choices: readonly ["normal", "bold"]
    - Readonly type: "choices"
- 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 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 justify: {
      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 letter-spacing: {
      type: "optional";
      value: {
          choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly ["normal", {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly ["normal", {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly line-height: {
      type: "optional";
      value: {
          choices: readonly ["normal", {
              max: number;
              min: number;
              type: "float";
          }];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        choices: readonly ["normal", {
            max: number;
            min: number;
            type: "float";
        }];
        type: "choices";
    }
    - Readonly choices: readonly ["normal", {
          max: number;
          min: number;
          type: "float";
      }]
    - Readonly type: "choices"
- Readonly line-through: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - Readonly type: "int"
- Readonly overline: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - 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 rotation: {
      type: "optional";
      value: {
          max: 180;
          min: -180;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 180;
        min: -180;
        type: "float";
    }
    - Readonly max: 180
    - Readonly min: -180
    - Readonly type: "float"
- Readonly underline: {
      type: "optional";
      value: {
          max: 3;
          min: 0;
          type: "int";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 3;
        min: 0;
        type: "int";
    }
    - Readonly max: 3
    - Readonly min: 0
    - Readonly type: "int"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom", "baseline"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom", "baseline"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom", "baseline"]
    - Readonly type: "choices"
Readonly contents: readonly [{
    type: "required";
    value: {
        type: "string";
    };
}]
Readonly name: "credit-symbol"

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDir

getDir(): null | "ltr" | "rtl" | "lro" | "rlo"
Gets

Returns null | "ltr" | "rtl" | "lro" | "rlo"
- Defined in generated/elements.ts:4547

getEnclosure

getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Gets

Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
- Defined in generated/elements.ts:4556

getFontFamily

getFontFamily(): null | string
Gets

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

getFontSize

getFontSize(): null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Gets

Returns null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
- Defined in generated/elements.ts:4608

getFontStyle

getFontStyle(): null | "normal" | "italic"
Gets

Returns null | "normal" | "italic"
- Defined in generated/elements.ts:4619

getFontWeight

getFontWeight(): null | "bold" | "normal"
Gets

Returns null | "bold" | "normal"
- Defined in generated/elements.ts:4628

getHalign

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

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

getId

getId(): null | string
Gets

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

getJustify

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

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

getLetterSpacing

getLetterSpacing(): null | number | "normal"
Gets

Returns null | number | "normal"
- Defined in generated/elements.ts:4664

getLineHeight

getLineHeight(): null | number | "normal"
Gets

Returns null | number | "normal"
- Defined in generated/elements.ts:4673

getLineThrough

getLineThrough(): null | number
Gets

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

getOverline

getOverline(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getRotation

getRotation(): null | number
Gets

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

getText

getText(): string
Gets

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

getUnderline

getUnderline(): null | number
Gets

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

getValign

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

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

setColor

setColor(color): CreditSymbol
Sets
Parameters
- color: null | string
Returns CreditSymbol
- Defined in generated/elements.ts:4524

setDefaultX

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

setDefaultY

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

setDir

setDir(dir): CreditSymbol
Sets
Parameters
- dir: null | "ltr" | "rtl" | "lro" | "rlo"
Returns CreditSymbol
- Defined in generated/elements.ts:4551

setEnclosure

setEnclosure(enclosure): CreditSymbol
Sets
Parameters
- enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"
Returns CreditSymbol
- Defined in generated/elements.ts:4576

setFontFamily

setFontFamily(fontFamily): CreditSymbol
Sets
Parameters
- fontFamily: null | string
Returns CreditSymbol
- Defined in generated/elements.ts:4603

setFontSize

setFontSize(fontSize): CreditSymbol
Sets
Parameters
- fontSize: null | number | "small" | "large" | "xx-small" | "x-small" | "medium" | "x-large" | "xx-large"
Returns CreditSymbol
- Defined in generated/elements.ts:4612

setFontStyle

setFontStyle(fontStyle): CreditSymbol
Sets
Parameters
- fontStyle: null | "normal" | "italic"
Returns CreditSymbol
- Defined in generated/elements.ts:4623

setFontWeight

setFontWeight(fontWeight): CreditSymbol
Sets
Parameters
- fontWeight: null | "bold" | "normal"
Returns CreditSymbol
- Defined in generated/elements.ts:4632

setHalign

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

setId

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

setJustify

setJustify(justify): CreditSymbol
Sets
Parameters
- justify: null | "left" | "center" | "right"
Returns CreditSymbol
- Defined in generated/elements.ts:4659

setLetterSpacing

setLetterSpacing(letterSpacing): CreditSymbol
Sets
Parameters
- letterSpacing: null | number | "normal"
Returns CreditSymbol
- Defined in generated/elements.ts:4668

setLineHeight

setLineHeight(lineHeight): CreditSymbol
Sets
Parameters
- lineHeight: null | number | "normal"
Returns CreditSymbol
- Defined in generated/elements.ts:4677

setLineThrough

setLineThrough(lineThrough): CreditSymbol
Sets
Parameters
- lineThrough: null | number
Returns CreditSymbol
- Defined in generated/elements.ts:4686

setOverline

setOverline(overline): CreditSymbol
Sets
Parameters
- overline: null | number
Returns CreditSymbol
- Defined in generated/elements.ts:4695

setRelativeX

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

setRelativeY

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

setRotation

setRotation(rotation): CreditSymbol
Sets
Parameters
- rotation: null | number
Returns CreditSymbol
- Defined in generated/elements.ts:4722

setText

setText(text): CreditSymbol
Sets
Parameters
- text: string
Returns CreditSymbol
- Defined in generated/elements.ts:4749

setUnderline

setUnderline(underline): CreditSymbol
Sets
Parameters
- underline: null | number
Returns CreditSymbol
- Defined in generated/elements.ts:4731

setValign

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

Class CreditSymbol

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<CreditSymbolAttributes>; contents?: CreditSymbolContents; }

Optional attributes?: Partial<CreditSymbolAttributes>

Optional contents?: CreditSymbolContents

Returns CreditSymbol

Properties

attributes

contents

Readonly schema

Type declaration

Readonly color: { type: "optional"; value: { pattern: RegExp; type: "regex"; zero: "#000000"; }; }

Readonly type: "optional"

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

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "#000000"

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 dir: { type: "optional"; value: { choices: readonly ["ltr", "rtl", "lro", "rlo"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["ltr", "rtl", "lro", "rlo"]; type: "choices"; }

Readonly choices: readonly ["ltr", "rtl", "lro", "rlo"]

Readonly type: "choices"

Readonly enclosure: { type: "optional"; value: { choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]; type: "choices"; }

Readonly choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]

Readonly type: "choices"

Readonly font-family: { 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 font-size: { type: "optional"; value: { choices: readonly [{ choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"]; type: "choices"; }, { max: number; min: number; type: "float"; }]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly [{ choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"]; type: "choices"; }, { max: number; min: number; type: "float"; }]; type: "choices"; }

Readonly choices: readonly [{ choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"]; type: "choices"; }, { max: number; min: number; type: "float"; }]

Readonly type: "choices"

Readonly font-style: { type: "optional"; value: { choices: readonly ["normal", "italic"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["normal", "italic"]; type: "choices"; }

Readonly choices: readonly ["normal", "italic"]

Readonly type: "choices"

Readonly font-weight: { type: "optional"; value: { choices: readonly ["normal", "bold"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["normal", "bold"]; type: "choices"; }

Readonly choices: readonly ["normal", "bold"]

Readonly type: "choices"

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

`Optional` opts: {
attributes?: Partial<CreditSymbolAttributes>;
contents?: CreditSymbolContents;
}

`Optional` attributes?: Partial<CreditSymbolAttributes>

`Optional` contents?: CreditSymbolContents

`Readonly` schema

`Readonly` color: {
type: "optional";
value: {
pattern: RegExp;
type: "regex";
zero: "#000000";
};
}

`Readonly` type: "optional"

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

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "#000000"

`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` dir: {
type: "optional";
value: {
choices: readonly ["ltr", "rtl", "lro", "rlo"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["ltr", "rtl", "lro", "rlo"];
type: "choices";
}

`Readonly` choices: readonly ["ltr", "rtl", "lro", "rlo"]

`Readonly` type: "choices"

`Readonly` enclosure: {
type: "optional";
value: {
choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"];
type: "choices";
}

`Readonly` choices: readonly ["none", "rectangle", "square", "oval", "circle", "bracket", "inverted-bracket", "triangle", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "nonagon", "decagon"]

`Readonly` type: "choices"

`Readonly` font-family: {
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` font-size: {
type: "optional";
value: {
choices: readonly [{
choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
type: "choices";
}, {
max: number;
min: number;
type: "float";
}];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly [{
choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
type: "choices";
}, {
max: number;
min: number;
type: "float";
}];
type: "choices";
}

`Readonly` choices: readonly [{
choices: readonly ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"];
type: "choices";
}, {
max: number;
min: number;
type: "float";
}]

`Readonly` type: "choices"

`Readonly` font-style: {
type: "optional";
value: {
choices: readonly ["normal", "italic"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["normal", "italic"];
type: "choices";
}

`Readonly` choices: readonly ["normal", "italic"]

`Readonly` type: "choices"

`Readonly` font-weight: {
type: "optional";
value: {
choices: readonly ["normal", "bold"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["normal", "bold"];
type: "choices";
}

`Readonly` choices: readonly ["normal", "bold"]

`Readonly` type: "choices"

`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` 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` justify: {
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` letter-spacing: {
type: "optional";
value: {
choices: readonly ["normal", {
max: number;
min: number;
type: "float";
}];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["normal", {
max: number;
min: number;
type: "float";
}];
type: "choices";
}

`Readonly` choices: readonly ["normal", {
max: number;
min: number;
type: "float";
}]

`Readonly` type: "choices"