Class Symbol

The <symbol> element

Parent element: <direction-type>

The <symbol> element specifies a musical symbol using a canonical SMuFL glyph name. It is used when an occasional musical symbol is interspersed into text. It should not be used in place of semantic markup, such as metronome marks that mix text and symbols. Left justification is used if not specified. Enclosure is none if not specified.

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

Hierarchy

Symbol

Implements

XMLElement<"symbol", SymbolAttributes, SymbolContents>

Constructors

constructor

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

Properties

attributes

attributes: SymbolAttributes

contents: []

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

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getDir

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

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

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:38204

getFontFamily

getFontFamily(): null | string
Gets

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

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:38256

getFontStyle

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

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

getFontWeight

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

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

getHalign

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

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

getId

getId(): null | string
Gets

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

getJustify

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

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

getLetterSpacing

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

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

getLineHeight

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

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

getLineThrough

getLineThrough(): null | number
Gets

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

getOverline

getOverline(): null | number
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getRotation

getRotation(): null | number
Gets

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

getUnderline

getUnderline(): null | number
Gets

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

getValign

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

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

setColor

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

setDefaultX

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

setDefaultY

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

setDir

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

setEnclosure

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setHalign

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

setId

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

setJustify

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

setLetterSpacing

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

setLineHeight

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

setLineThrough

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

setOverline

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

setRelativeX

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

setRelativeY

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

setRotation

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

setUnderline

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

setValign

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

Class Symbol

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Optional attributes?: Partial<SymbolAttributes>

Optional contents?: []

Returns Symbol

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<SymbolAttributes>;
contents?: [];
}

`Optional` attributes?: Partial<SymbolAttributes>

`Optional` contents?: []

`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"