Class Shake

The <shake> element

Parent element: <ornaments>

The <shake> element has a similar appearance to an <inverted-mordent> element.

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

Hierarchy

Shake

Implements

XMLElement<"shake", ShakeAttributes, ShakeContents>

Constructors

constructor

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

Properties

attributes

attributes: ShakeAttributes

contents: []

`Readonly` schema

schema: {
    attributes: {
        accelerate: {
            type: "optional";
            value: {
                choices: readonly ["yes", "no"];
                type: "choices";
            };
        };
        beats: {
            type: "optional";
            value: {
                max: number;
                min: 2;
                type: "float";
            };
        };
        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";
            };
        };
        last-beat: {
            type: "optional";
            value: {
                max: 100;
                min: 0;
                type: "float";
            };
        };
        placement: {
            type: "optional";
            value: {
                choices: readonly ["above", "below"];
                type: "choices";
            };
        };
        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";
                };
            };
        };
        second-beat: {
            type: "optional";
            value: {
                max: 100;
                min: 0;
                type: "float";
            };
        };
        start-note: {
            type: "optional";
            value: {
                choices: readonly ["below", "main", "upper"];
                type: "choices";
            };
        };
        trill-step: {
            type: "optional";
            value: {
                choices: readonly ["unison", "half", "whole"];
                type: "choices";
            };
        };
        two-note-turn: {
            type: "optional";
            value: {
                choices: readonly ["none", "whole", "half"];
                type: "choices";
            };
        };
    };
    contents: readonly [];
    name: "shake";
} = Shake.schema

Type declaration

Readonly attributes: {
    accelerate: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    beats: {
        type: "optional";
        value: {
            max: number;
            min: 2;
            type: "float";
        };
    };
    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";
        };
    };
    last-beat: {
        type: "optional";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
    placement: {
        type: "optional";
        value: {
            choices: readonly ["above", "below"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    second-beat: {
        type: "optional";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
    start-note: {
        type: "optional";
        value: {
            choices: readonly ["below", "main", "upper"];
            type: "choices";
        };
    };
    trill-step: {
        type: "optional";
        value: {
            choices: readonly ["unison", "half", "whole"];
            type: "choices";
        };
    };
    two-note-turn: {
        type: "optional";
        value: {
            choices: readonly ["none", "whole", "half"];
            type: "choices";
        };
    };
}
- Readonly accelerate: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
- Readonly beats: {
      type: "optional";
      value: {
          max: number;
          min: 2;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 2;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: 2
    - Readonly 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 last-beat: {
      type: "optional";
      value: {
          max: 100;
          min: 0;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 100;
        min: 0;
        type: "float";
    }
    - Readonly max: 100
    - Readonly min: 0
    - Readonly type: "float"
- Readonly placement: {
      type: "optional";
      value: {
          choices: readonly ["above", "below"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["above", "below"];
    type: "choices";
    }
    - Readonly choices: readonly ["above", "below"]
    - Readonly type: "choices"
- 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 second-beat: {
      type: "optional";
      value: {
          max: 100;
          min: 0;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 100;
        min: 0;
        type: "float";
    }
    - Readonly max: 100
    - Readonly min: 0
    - Readonly type: "float"
- Readonly start-note: {
      type: "optional";
      value: {
          choices: readonly ["below", "main", "upper"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["below", "main", "upper"];
    type: "choices";
    }
    - Readonly choices: readonly ["below", "main", "upper"]
    - Readonly type: "choices"
- Readonly trill-step: {
      type: "optional";
      value: {
          choices: readonly ["unison", "half", "whole"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["unison", "half", "whole"];
    type: "choices";
    }
    - Readonly choices: readonly ["unison", "half", "whole"]
    - Readonly type: "choices"
- Readonly two-note-turn: {
      type: "optional";
      value: {
          choices: readonly ["none", "whole", "half"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "whole", "half"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "whole", "half"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "shake"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    accelerate: {
        type: "optional";
        value: {
            choices: readonly ["yes", "no"];
            type: "choices";
        };
    };
    beats: {
        type: "optional";
        value: {
            max: number;
            min: 2;
            type: "float";
        };
    };
    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";
        };
    };
    last-beat: {
        type: "optional";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
    placement: {
        type: "optional";
        value: {
            choices: readonly ["above", "below"];
            type: "choices";
        };
    };
    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";
            };
        };
    };
    second-beat: {
        type: "optional";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
    start-note: {
        type: "optional";
        value: {
            choices: readonly ["below", "main", "upper"];
            type: "choices";
        };
    };
    trill-step: {
        type: "optional";
        value: {
            choices: readonly ["unison", "half", "whole"];
            type: "choices";
        };
    };
    two-note-turn: {
        type: "optional";
        value: {
            choices: readonly ["none", "whole", "half"];
            type: "choices";
        };
    };
}
- Readonly accelerate: {
      type: "optional";
      value: {
          choices: readonly ["yes", "no"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["yes", "no"];
    type: "choices";
    }
    - Readonly choices: readonly ["yes", "no"]
    - Readonly type: "choices"
- Readonly beats: {
      type: "optional";
      value: {
          max: number;
          min: 2;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: number;
        min: 2;
        type: "float";
    }
    - Readonly max: number
    - Readonly min: 2
    - Readonly 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 last-beat: {
      type: "optional";
      value: {
          max: 100;
          min: 0;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 100;
        min: 0;
        type: "float";
    }
    - Readonly max: 100
    - Readonly min: 0
    - Readonly type: "float"
- Readonly placement: {
      type: "optional";
      value: {
          choices: readonly ["above", "below"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["above", "below"];
    type: "choices";
    }
    - Readonly choices: readonly ["above", "below"]
    - Readonly type: "choices"
- 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 second-beat: {
      type: "optional";
      value: {
          max: 100;
          min: 0;
          type: "float";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
        max: 100;
        min: 0;
        type: "float";
    }
    - Readonly max: 100
    - Readonly min: 0
    - Readonly type: "float"
- Readonly start-note: {
      type: "optional";
      value: {
          choices: readonly ["below", "main", "upper"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["below", "main", "upper"];
    type: "choices";
    }
    - Readonly choices: readonly ["below", "main", "upper"]
    - Readonly type: "choices"
- Readonly trill-step: {
      type: "optional";
      value: {
          choices: readonly ["unison", "half", "whole"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["unison", "half", "whole"];
    type: "choices";
    }
    - Readonly choices: readonly ["unison", "half", "whole"]
    - Readonly type: "choices"
- Readonly two-note-turn: {
      type: "optional";
      value: {
          choices: readonly ["none", "whole", "half"];
          type: "choices";
      };
  }
  - Readonly type: "optional"
  - Readonly value: {
    choices: readonly ["none", "whole", "half"];
    type: "choices";
    }
    - Readonly choices: readonly ["none", "whole", "half"]
    - Readonly type: "choices"
Readonly contents: readonly []
Readonly name: "shake"

Methods

getAccelerate

getAccelerate(): null | "yes" | "no"
Gets

Returns null | "yes" | "no"
- Defined in generated/elements.ts:16864

getBeats

getBeats(): null | number
Gets

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

getColor

getColor(): null | string
Gets

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

getDefaultX

getDefaultX(): null | number
Gets

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

getDefaultY

getDefaultY(): null | number
Gets

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

getFontFamily

getFontFamily(): null | string
Gets

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

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

getFontStyle

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

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

getFontWeight

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

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

getLastBeat

getLastBeat(): null | number
Gets

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

getPlacement

getPlacement(): null | "above" | "below"
Gets

Returns null | "above" | "below"
- Defined in generated/elements.ts:16956

getRelativeX

getRelativeX(): null | number
Gets

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

getRelativeY

getRelativeY(): null | number
Gets

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

getSecondBeat

getSecondBeat(): null | number
Gets

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

getStartNote

getStartNote(): null | "below" | "main" | "upper"
Gets

Returns null | "below" | "main" | "upper"
- Defined in generated/elements.ts:16992

getTrillStep

getTrillStep(): null | "whole" | "half" | "unison"
Gets

Returns null | "whole" | "half" | "unison"
- Defined in generated/elements.ts:17001

getTwoNoteTurn

getTwoNoteTurn(): null | "none" | "whole" | "half"
Gets

Returns null | "none" | "whole" | "half"
- Defined in generated/elements.ts:17010

setAccelerate

setAccelerate(accelerate): Shake
Sets
Parameters
- accelerate: null | "yes" | "no"
Returns Shake
- Defined in generated/elements.ts:16868

setBeats

setBeats(beats): Shake
Sets
Parameters
- beats: null | number
Returns Shake
- Defined in generated/elements.ts:16877

setColor

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

setDefaultX

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

setDefaultY

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

setFontFamily

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

setFontSize

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

setFontStyle

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

setFontWeight

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

setLastBeat

setLastBeat(lastBeat): Shake
Sets
Parameters
- lastBeat: null | number
Returns Shake
- Defined in generated/elements.ts:16951

setPlacement

setPlacement(placement): Shake
Sets
Parameters
- placement: null | "above" | "below"
Returns Shake
- Defined in generated/elements.ts:16960

setRelativeX

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

setRelativeY

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

setSecondBeat

setSecondBeat(secondBeat): Shake
Sets
Parameters
- secondBeat: null | number
Returns Shake
- Defined in generated/elements.ts:16987

setStartNote

setStartNote(startNote): Shake
Sets
Parameters
- startNote: null | "below" | "main" | "upper"
Returns Shake
- Defined in generated/elements.ts:16996

setTrillStep

setTrillStep(trillStep): Shake
Sets
Parameters
- trillStep: null | "whole" | "half" | "unison"
Returns Shake
- Defined in generated/elements.ts:17005

setTwoNoteTurn

setTwoNoteTurn(twoNoteTurn): Shake
Sets
Parameters
- twoNoteTurn: null | "none" | "whole" | "half"
Returns Shake
- Defined in generated/elements.ts:17014

Class Shake

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Optional attributes?: Partial<ShakeAttributes>

Optional contents?: []

Returns Shake

Properties

attributes

contents

Readonly schema

Type declaration

Readonly accelerate: { type: "optional"; value: { choices: readonly ["yes", "no"]; type: "choices"; }; }

Readonly type: "optional"

Readonly value: { choices: readonly ["yes", "no"]; type: "choices"; }

Readonly choices: readonly ["yes", "no"]

Readonly type: "choices"

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

Readonly type: "optional"

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

Readonly max: number

Readonly min: 2

Readonly 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 last-beat: { type: "optional"; value: { max: 100; min: 0; type: "float"; }; }

Readonly type: "optional"

Readonly value: { max: 100; min: 0; type: "float"; }

Readonly max: 100

Readonly min: 0

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

`Optional` attributes?: Partial<ShakeAttributes>

`Optional` contents?: []

`Readonly` schema

`Readonly` accelerate: {
type: "optional";
value: {
choices: readonly ["yes", "no"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["yes", "no"];
type: "choices";
}

`Readonly` choices: readonly ["yes", "no"]

`Readonly` type: "choices"

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

`Readonly` type: "optional"

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

`Readonly` max: number

`Readonly` min: 2

`Readonly` 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` last-beat: {
type: "optional";
value: {
max: 100;
min: 0;
type: "float";
};
}

`Readonly` type: "optional"

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

`Readonly` max: 100

`Readonly` min: 0

`Readonly` type: "float"

`Readonly` placement: {
type: "optional";
value: {
choices: readonly ["above", "below"];
type: "choices";
};
}

`Readonly` type: "optional"

`Readonly` value: {
choices: readonly ["above", "below"];
type: "choices";
}

`Readonly` choices: readonly ["above", "below"]

`Readonly` type: "choices"

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