Class Shake

constructor

• new Shake(opts?): Shake

• Parameters

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

    • Optional attributes?: Partial<ShakeAttributes>

    • Optional contents?: []

  Returns Shake

attributes

contents

Readonly schema

Static Readonly schema

getAccelerate

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

• Gets

  Returns null | "yes" | "no"

getBeats

• getBeats(): null | number

• Gets

  Returns null | number

getColor

• getColor(): null | string

• Gets

  Returns null | string

getDefaultX

• getDefaultX(): null | number

• Gets

  Returns null | number

getDefaultY

• getDefaultY(): null | number

• Gets

  Returns null | number

getFontFamily

• getFontFamily(): null | string

• Gets

  Returns null | string

getFontSize

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

• Gets

  Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

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

• Gets

  Returns null | "normal" | "italic"

getFontWeight

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

• Gets

  Returns null | "normal" | "bold"

getLastBeat

• getLastBeat(): null | number

• Gets

  Returns null | number

getPlacement

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

• Gets

  Returns null | "above" | "below"

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getSecondBeat

• getSecondBeat(): null | number

• Gets

  Returns null | number

getStartNote

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

• Gets

  Returns null | "below" | "upper" | "main"

getTrillStep

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

• Gets

  Returns null | "whole" | "half" | "unison"

getTwoNoteTurn

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

• Gets

  Returns null | "none" | "whole" | "half"

setAccelerate

• setAccelerate(accelerate): Shake

• Sets

  Parameters

  • accelerate: null | "yes" | "no"

  Returns Shake

setBeats

• setBeats(beats): Shake

• Sets

  Parameters

  • beats: null | number

  Returns Shake

setColor

• setColor(color): Shake

• Sets

  Parameters

  • color: null | string

  Returns Shake

setDefaultX

• setDefaultX(defaultX): Shake

• Sets

  Parameters

  • defaultX: null | number

  Returns Shake

setDefaultY

• setDefaultY(defaultY): Shake

• Sets

  Parameters

  • defaultY: null | number

  Returns Shake

setFontFamily

• setFontFamily(fontFamily): Shake

• Sets

  Parameters

  • fontFamily: null | string

  Returns Shake

setFontSize

• setFontSize(fontSize): Shake

• Sets

  Parameters

  • fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

  Returns Shake

setFontStyle

• setFontStyle(fontStyle): Shake

• Sets

  Parameters

  • fontStyle: null | "normal" | "italic"

  Returns Shake

setFontWeight

• setFontWeight(fontWeight): Shake

• Sets

  Parameters

  • fontWeight: null | "normal" | "bold"

  Returns Shake

setLastBeat

• setLastBeat(lastBeat): Shake

• Sets

  Parameters

  • lastBeat: null | number

  Returns Shake

setPlacement

• setPlacement(placement): Shake

• Sets

  Parameters

  • placement: null | "above" | "below"

  Returns Shake

setRelativeX

• setRelativeX(relativeX): Shake

• Sets

  Parameters

  • relativeX: null | number

  Returns Shake

setRelativeY

• setRelativeY(relativeY): Shake

• Sets

  Parameters

  • relativeY: null | number

  Returns Shake

setSecondBeat

• setSecondBeat(secondBeat): Shake

• Sets

  Parameters

  • secondBeat: null | number

  Returns Shake

setStartNote

• setStartNote(startNote): Shake

• Sets

  Parameters

  • startNote: null | "below" | "upper" | "main"

  Returns Shake

setTrillStep

• setTrillStep(trillStep): Shake

• Sets

  Parameters

  • trillStep: null | "whole" | "half" | "unison"

  Returns Shake

setTwoNoteTurn

• setTwoNoteTurn(twoNoteTurn): Shake

• Sets

  Parameters

  • twoNoteTurn: null | "none" | "whole" | "half"

  Returns Shake