Class Frame

The <frame> element

Parent element: <harmony>

The frame type represents a frame or fretboard diagram used together with a chord symbol. The representation is based on the NIFF guitar grid with additional information. The frame type's unplayed attribute indicates what to display above a string that has no associated frame-note element. Typical values are x and the empty string. If the attribute is not present, the display of the unplayed string is application-defined.

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

Hierarchy

Frame

Implements

XMLElement<"frame", FrameAttributes, FrameContents>

Constructors

constructor

new Frame(opts?): Frame
Parameters
- Optional opts: {
  attributes?: Partial<FrameAttributes>;
  contents?: FrameContents;
  }
  - Optional attributes?: Partial<FrameAttributes>
  - Optional contents?: FrameContents
Returns Frame
- Defined in generated/elements.ts:55872

Properties

attributes

attributes: FrameAttributes

contents: FrameContents

`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";
                };
            };
        };
        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";
            };
        };
        height: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
        id: {
            type: "optional";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
        relative-x: {
            label: "relative-x";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        relative-y: {
            label: "relative-y";
            type: "label";
            value: {
                type: "optional";
                value: {
                    max: number;
                    min: number;
                    type: "float";
                };
            };
        };
        unplayed: {
            type: "optional";
            value: {
                type: "string";
            };
        };
        valign: {
            type: "optional";
            value: {
                choices: readonly ["top", "middle", "bottom"];
                type: "choices";
            };
        };
        width: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    contents: readonly [{
        type: "required";
        value: typeof FrameStrings;
    }, {
        type: "required";
        value: typeof FrameFrets;
    }, {
        type: "optional";
        value: typeof FirstFret;
    }, {
        label: "frame-notes";
        type: "label";
        value: {
            type: "oneOrMore";
            value: typeof FrameNote;
        };
    }];
    name: "frame";
} = Frame.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";
            };
        };
    };
    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";
        };
    };
    height: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    relative-x: {
        label: "relative-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    relative-y: {
        label: "relative-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    unplayed: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom"];
            type: "choices";
        };
    };
    width: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}
- Readonly 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 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 height: {
      type: "optional";
      value: {
          max: number;
          min: number;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: number;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: number
    - Readonly type: "float"
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- Readonly relative-x: {
      label: "relative-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-x"
  - Readonly type: "label"
  - Readonly value: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    }
    - Readonly type: "optional"
    - Readonly value: {
          max: number;
          min: number;
          type: "float";
      }
      - Readonly max: number
      - Readonly min: number
      - Readonly type: "float"
- Readonly relative-y: {
      label: "relative-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-y"
  - Readonly type: "label"
  - Readonly value: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    }
    - Readonly type: "optional"
    - Readonly value: {
          max: number;
          min: number;
          type: "float";
      }
      - Readonly max: number
      - Readonly min: number
      - Readonly type: "float"
- Readonly unplayed: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom"]
    - Readonly type: "choices"
- Readonly width: {
      type: "optional";
      value: {
          max: number;
          min: number;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: number;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: number
    - Readonly type: "float"
Readonly contents: readonly [{
    type: "required";
    value: typeof FrameStrings;
}, {
    type: "required";
    value: typeof FrameFrets;
}, {
    type: "optional";
    value: typeof FirstFret;
}, {
    label: "frame-notes";
    type: "label";
    value: {
        type: "oneOrMore";
        value: typeof FrameNote;
    };
}]
Readonly name: "frame"

`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";
            };
        };
    };
    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";
        };
    };
    height: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
    id: {
        type: "optional";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
    relative-x: {
        label: "relative-x";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    relative-y: {
        label: "relative-y";
        type: "label";
        value: {
            type: "optional";
            value: {
                max: number;
                min: number;
                type: "float";
            };
        };
    };
    unplayed: {
        type: "optional";
        value: {
            type: "string";
        };
    };
    valign: {
        type: "optional";
        value: {
            choices: readonly ["top", "middle", "bottom"];
            type: "choices";
        };
    };
    width: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    };
}
- Readonly 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 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 height: {
      type: "optional";
      value: {
          max: number;
          min: number;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: number;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: number
    - Readonly type: "float"
- Readonly id: {
      type: "optional";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
- Readonly relative-x: {
      label: "relative-x";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-x"
  - Readonly type: "label"
  - Readonly value: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    }
    - Readonly type: "optional"
    - Readonly value: {
          max: number;
          min: number;
          type: "float";
      }
      - Readonly max: number
      - Readonly min: number
      - Readonly type: "float"
- Readonly relative-y: {
      label: "relative-y";
      type: "label";
      value: {
          type: "optional";
          value: {
              max: number;
              min: number;
              type: "float";
          };
      };
  }
  - Readonly label: "relative-y"
  - Readonly type: "label"
  - Readonly value: {
        type: "optional";
        value: {
            max: number;
            min: number;
            type: "float";
        };
    }
    - Readonly type: "optional"
    - Readonly value: {
          max: number;
          min: number;
          type: "float";
      }
      - Readonly max: number
      - Readonly min: number
      - Readonly type: "float"
- Readonly unplayed: {
      type: "optional";
      value: {
          type: "string";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    type: "string";
    }
    - Readonly type: "string"
- Readonly valign: {
      type: "optional";
      value: {
          choices: readonly ["top", "middle", "bottom"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["top", "middle", "bottom"];
    type: "choices";
    }
    - Readonly choices: readonly ["top", "middle", "bottom"]
    - Readonly type: "choices"
- Readonly width: {
      type: "optional";
      value: {
          max: number;
          min: number;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: number;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: number
    - Readonly type: "float"
Readonly contents: readonly [{
    type: "required";
    value: typeof FrameStrings;
}, {
    type: "required";
    value: typeof FrameFrets;
}, {
    type: "optional";
    value: typeof FirstFret;
}, {
    label: "frame-notes";
    type: "label";
    value: {
        type: "oneOrMore";
        value: typeof FrameNote;
    };
}]
Readonly name: "frame"

Methods

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFirstFret

getFirstFret(): null | FirstFret
Gets

Returns null | FirstFret
- Defined in generated/elements.ts:56032

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getFrameFrets

getFrameFrets(): FrameFrets
Gets

Returns FrameFrets
- Defined in generated/elements.ts:56023

getFrameNotes

getFrameNotes(): FrameNote[]
Gets

Returns FrameNote[]
- Defined in generated/elements.ts:56041

getFrameStrings

getFrameStrings(): FrameStrings
Gets

Returns FrameStrings
- Defined in generated/elements.ts:56014

getHalign

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

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

getHeight

getHeight(): null | number
Gets

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

getId

getId(): null | string
Gets

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

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getUnplayed

getUnplayed(): null | string
Gets

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

getValign

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

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

getWidth

getWidth(): null | number
Gets

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

setColor

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

setDefaultX

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

setDefaultY

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

setFirstFret

setFirstFret(firstFret): Frame
Sets
Parameters
- firstFret: null | FirstFret
Returns Frame
- Defined in generated/elements.ts:56036

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setFrameFrets

setFrameFrets(frameFrets): Frame
Sets
Parameters
- frameFrets: FrameFrets
Returns Frame
- Defined in generated/elements.ts:56027

setFrameNotes

setFrameNotes(frameNotes): Frame
Sets
Parameters
- frameNotes: FrameNote[]
Returns Frame
- Defined in generated/elements.ts:56045

setFrameStrings

setFrameStrings(frameStrings): Frame
Sets
Parameters
- frameStrings: FrameStrings
Returns Frame
- Defined in generated/elements.ts:56018

setHalign

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

setHeight

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

setId

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

setRelativeX

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

setRelativeY

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

setUnplayed

setUnplayed(unplayed): Frame
Sets
Parameters
- unplayed: null | string
Returns Frame
- Defined in generated/elements.ts:55991

setValign

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

setWidth

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

Class Frame

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<FrameAttributes>; contents?: FrameContents; }

Optional attributes?: Partial<FrameAttributes>

Optional contents?: FrameContents

Returns Frame

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 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 height: { type: "optional"; value: { max: number; min: number; type: "float"; }; }

Readonly type: "optional"

Readonly value: { max: number; min: number; type: "float"; }

Readonly max: number

Readonly min: number

Readonly type: "float"

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

Readonly type: "optional"

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

Readonly pattern: RegExp

Readonly type: "regex"

`Optional` opts: {
attributes?: Partial<FrameAttributes>;
contents?: FrameContents;
}

`Optional` attributes?: Partial<FrameAttributes>

`Optional` contents?: FrameContents

`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` 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` height: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: number;
min: number;
type: "float";
}

`Readonly` max: number

`Readonly` min: number

`Readonly` type: "float"

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

`Readonly` type: "optional"

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

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

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

`Readonly` label: "relative-x"

`Readonly` type: "label"

`Readonly` value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
}

`Readonly` type: "optional"

`Readonly` value: {
max: number;
min: number;
type: "float";
}

`Readonly` max: number

`Readonly` min: number

`Readonly` type: "float"

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

`Readonly` label: "relative-y"

`Readonly` type: "label"

`Readonly` value: {
type: "optional";
value: {
max: number;
min: number;
type: "float";
};
}

`Readonly` type: "optional"