ToneMatrix | @simplylinn/tonematrix

Main class of ToneMatrix Redux, a pentatonic step sequencer

Type parameters

GridType: IGrid | undefined = undefined
GridRendererType: IGridRenderer | undefined = undefined

Hierarchy

EventEmitter<ToneMatrixEventMap>
- ToneMatrix

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ToneMatrix<GridType, GridRendererType>(options: ToneMatrixOptions<GridType, GridRendererType>): ToneMatrix<GridType, GridRendererType>

Overrides EventEmitter<ToneMatrixEventMap>.constructor
- Defined in src/ToneMatrix.ts:149
Creates a new ToneMatrix Redux instance, and attach it to existing DOM elements

Type parameters
- GridType: undefined | IGrid = undefined
- GridRendererType: undefined | IGridRenderer = undefined
Parameters
- options: ToneMatrixOptions<GridType, GridRendererType>
Returns ToneMatrix<GridType, GridRendererType>

Properties

Private autoPlay

autoPlay: boolean

Private destroyed

destroyed: boolean = false

Readonly grid

grid: GridType extends undefined ? Grid : GridType

The grid connected to the ToneMatrix

readonly

Private internalListeners

internal

Readonly playing

playing: false = false

Readonly renderer

renderer: GridRendererType extends undefined ? GridCanvasRenderer : GridRendererType

The gridrenderer connected to the ToneMatrix

readonly

Static prefixed

prefixed: string | boolean

Accessors

HEIGHT

get HEIGHT(): number

- Defined in src/ToneMatrix.ts:118
The height of the grid, measured in grid tiles

readonly
Returns number

WIDTH

get WIDTH(): number

- Defined in src/ToneMatrix.ts:110
The width of the grid, measured in grid tiles

readonly
Returns number

Methods

addListener

addListener<T>(event: T, fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void, context?: any): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45
Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void
  - - (...args: ArgumentMap<ToneMatrixEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
      Returns void
- Optional context: any
Returns ToneMatrix<GridType, GridRendererType>

clear

clear(): void

- Defined in src/ToneMatrix.ts:298
Clears all notes from the grid and resets the sharing URL.

Returns void

dispose

dispose(): void

- Defined in src/ToneMatrix.ts:401
Cleans up all resources used by this ToneMatrix

Returns void

emit

emit<T>(event: T, ...args: ArgumentMap<ToneMatrixEventMap>[T]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
Returns boolean

eventNames

eventNames(): (keyof GridRendererEventMap | keyof ToneTransportEventMap)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof GridRendererEventMap | keyof ToneTransportEventMap)[]

fromBase64

fromBase64(base64: string, bitsPerNote: number): boolean

- Defined in src/ToneMatrix.ts:350
Loads a savestate from a string into the grid

Parameters
- base64: string
  
  The base64-encoded savestate string
- bitsPerNote: number
Returns boolean

Private listen

listen<P, Args, T>(target: T, event: P, listener: (...args: Args) => void): ToneMatrix<GridType, GridRendererType>

- Defined in src/ToneMatrix.ts:459
Add an event listener to a listenable object and save everything needed for removing it later.

internal
Type parameters
- P: "fullscreenchange" | "fullscreenerror" | "copy" | "cut" | "paste" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "beforeinput" | "blur" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "compositionend" | "compositionstart" | "compositionupdate" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "formdata" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "webkitanimationend" | "webkitanimationiteration" | "webkitanimationstart" | "webkittransitionend" | "wheel" | "tiledown" | "tilemove" | "tileup" | "tileclick" | "start" | "stop" | "loopEnd" | "loopStart" | "loop"
- Args: [ev: Event] | [ev: ClipboardEvent] | [ev: UIEvent] | [ev: AnimationEvent] | [ev: MouseEvent] | [ev: InputEvent] | [ev: FocusEvent] | [ev: CompositionEvent] | [ev: DragEvent] | [ev: ErrorEvent] | [ev: FormDataEvent] | [ev: PointerEvent] | [ev: KeyboardEvent] | [time: number] | [ev: ProgressEvent<EventTarget>] | [ev: SecurityPolicyViolationEvent] | [ev: TouchEvent] | [ev: TransitionEvent] | [ev: WheelEvent] | [x: number, y: number] | [x: number, y: number] | [x: number, y: number] | [false] | [x: number, y: number] | [time: number, offset: number] | [time: number] | [time: number] | [time: number, offset: number] | [time: number] = ListenerEventMaps[P]
- T: AnyEventTarget<ListenerEventMaps, P, Args> = AnyEventTarget<ListenerEventMaps, P, Args>
Parameters
- target: T
- event: P
- listener: (...args: Args) => void
  - - (...args: Args): void
    - Parameters
      - Rest ...args: Args
      Returns void
Returns ToneMatrix<GridType, GridRendererType>

listenerCount

listenerCount(event: keyof GridRendererEventMap | keyof ToneTransportEventMap): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: keyof GridRendererEventMap | keyof ToneTransportEventMap
Returns number

listeners

listeners<T>(event: T): ((...args: ArgumentMap<ToneMatrixEventMap>[T]) => void)[]

Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
Returns ((...args: ArgumentMap<ToneMatrixEventMap>[T]) => void)[]

off

off<T>(event: T, fn?: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void, context?: any, once?: boolean): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69
Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void
  - - (...args: ArgumentMap<ToneMatrixEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
      Returns void
- Optional context: any
- Optional once: boolean
Returns ToneMatrix<GridType, GridRendererType>

on

on<T>(event: T, fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void, context?: any): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.

Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void
  - - (...args: ArgumentMap<ToneMatrixEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
      Returns void
- Optional context: any
Returns ToneMatrix<GridType, GridRendererType>

once

once<T>(event: T, fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void, context?: any): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void
  - - (...args: ArgumentMap<ToneMatrixEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
      Returns void
- Optional context: any
Returns ToneMatrix<GridType, GridRendererType>

pause

pause(): void

- Defined in src/ToneMatrix.ts:282
Pause the playback

Returns void

play

play(): void

- Defined in src/ToneMatrix.ts:270
Start the playback

Returns void

removeAllListeners

removeAllListeners(event?: keyof GridRendererEventMap | keyof ToneTransportEventMap): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: keyof GridRendererEventMap | keyof ToneTransportEventMap
Returns ToneMatrix<GridType, GridRendererType>

removeListener

removeListener<T>(event: T, fn?: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void, context?: any, once?: boolean): ToneMatrix<GridType, GridRendererType>

Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type parameters
- T: keyof GridRendererEventMap | keyof ToneTransportEventMap
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void
  - - (...args: ArgumentMap<ToneMatrixEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]
      Returns void
- Optional context: any
- Optional once: boolean
Returns ToneMatrix<GridType, GridRendererType>

setHeight

setHeight(newHeight: number, noteLength?: number | typeof DEFAULT): void

- Defined in src/ToneMatrix.ts:450
Parameters
- newHeight: number
- Optional noteLength: number | typeof DEFAULT
Returns void

setMuted

setMuted(muted: boolean): void

- Defined in src/ToneMatrix.ts:306
Sets whether the ToneMatrix application is muted.

Parameters
- muted: boolean
  
  True for muted, false for unmuted
Returns void

setSize

setSize(newWidth?: number, newHeight?: number, noteLength?: number | typeof DEFAULT): void

- Defined in src/ToneMatrix.ts:437
Set a new grid size

Parameters
- Optional newWidth: number
  
  New width in tiles
- Optional newHeight: number
  
  New height in tiles
- Optional noteLength: number | typeof DEFAULT
  
  New noteLength. if DEFAULT it will be set to 1 / width if unset will recalculate the default value if using a calcualted default value or keep the currently set value if explicitly set.
Returns void

setWidth

setWidth(newWidth: number, noteLength?: number | typeof DEFAULT): void

- Defined in src/ToneMatrix.ts:446
Parameters
- newWidth: number
- Optional noteLength: number | typeof DEFAULT
Returns void

stop

stop(): void

- Defined in src/ToneMatrix.ts:290
Pause the playback

Returns void

toBase64

toBase64(bitsPerNote: number): string

- Defined in src/ToneMatrix.ts:315
Saves the grid's current state into a savestate string

Parameters
- bitsPerNote: number
Returns string
The base64-encoded savestate string, ready for saving or outputting in a URL

Private unlisten

unlisten<P, Args, T>(target: T, event: P, listener: (...args: Args) => void): ToneMatrix<GridType, GridRendererType>

- Defined in src/ToneMatrix.ts:487
Remove a listener from a listenable object.

internal
Type parameters
- P: "fullscreenchange" | "fullscreenerror" | "copy" | "cut" | "paste" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "beforeinput" | "blur" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "compositionend" | "compositionstart" | "compositionupdate" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "formdata" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "webkitanimationend" | "webkitanimationiteration" | "webkitanimationstart" | "webkittransitionend" | "wheel" | "tiledown" | "tilemove" | "tileup" | "tileclick" | "start" | "stop" | "loopEnd" | "loopStart" | "loop"
- Args: [ev: Event] | [ev: ClipboardEvent] | [ev: UIEvent] | [ev: AnimationEvent] | [ev: MouseEvent] | [ev: InputEvent] | [ev: FocusEvent] | [ev: CompositionEvent] | [ev: DragEvent] | [ev: ErrorEvent] | [ev: FormDataEvent] | [ev: PointerEvent] | [ev: KeyboardEvent] | [time: number] | [ev: ProgressEvent<EventTarget>] | [ev: SecurityPolicyViolationEvent] | [ev: TouchEvent] | [ev: TransitionEvent] | [ev: WheelEvent] | [x: number, y: number] | [x: number, y: number] | [x: number, y: number] | [false] | [x: number, y: number] | [time: number, offset: number] | [time: number] | [time: number] | [time: number, offset: number] | [time: number] = ListenerEventMaps[P]
- T: AnyEventTarget<ListenerEventMaps, P, Args> = AnyEventTarget<ListenerEventMaps, P, Args>
Parameters
- target: T
- event: P
- listener: (...args: Args) => void
  - - (...args: Args): void
    - Parameters
      - Rest ...args: Args
      Returns void
Returns ToneMatrix<GridType, GridRendererType>

Private update

update(): void

- Defined in src/ToneMatrix.ts:262
Updates the state of the app, and draws it to the canvas. Called in requestAnimationFrame.

Returns void

Type parameters

GridType: IGrid | undefined = undefined

GridRendererType: IGridRenderer | undefined = undefined

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

GridType: undefined | IGrid = undefined

GridRendererType: undefined | IGridRenderer = undefined

Parameters

options: ToneMatrixOptions<GridType, GridRendererType>

Returns ToneMatrix<GridType, GridRendererType>

Properties

Private autoPlay

Private destroyed

Readonly grid

Private internalListeners

Readonly playing

Readonly renderer

Static prefixed

Accessors

HEIGHT

Returns number

WIDTH

Returns number

Methods

addListener

Type parameters

T: keyof GridRendererEventMap | keyof ToneTransportEventMap

Parameters

event: T

fn: (...args: ArgumentMap<ToneMatrixEventMap>[T]) => void

Parameters

Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]

Returns void

Optional context: any

Returns ToneMatrix<GridType, GridRendererType>

clear

Returns void

dispose

Returns void

emit

Type parameters

T: keyof GridRendererEventMap | keyof ToneTransportEventMap

Parameters

event: T

Rest ...args: ArgumentMap<ToneMatrixEventMap>[T]

Returns boolean

eventNames

Returns (keyof GridRendererEventMap | keyof ToneTransportEventMap)[]

fromBase64

Parameters

base64: string

bitsPerNote: number

Returns boolean

Private listen

Type parameters

T: AnyEventTarget<ListenerEventMaps, P, Args> = AnyEventTarget<ListenerEventMaps, P, Args>

Parameters

target: T

event: P

listener: (...args: Args) => void

Parameters

Rest ...args: Args

Returns void

Returns ToneMatrix<GridType, GridRendererType>

listenerCount

Parameters

event: keyof GridRendererEventMap | keyof ToneTransportEventMap

Returns number

listeners

Type parameters

T: keyof GridRendererEventMap | keyof ToneTransportEventMap

Parameters

event: T