Class ModuleGrid

Module showing grid (by default beneath rail) giving overview what values are where.

clickable
uses canvas for rendering, to not pollute DOM

Uses .jsr_grid as grid parent CSS class.

Hierarchy

Module
- ModuleGrid

Index

Constructors

constructor

Methods

Constructors

constructor

new ModuleGrid(settings?: Partial<ModuleGridSettings>): ModuleGrid

Overrides Module.constructor
- Defined in modules/ModuleGrid.ts:58
Parameters
- settings: Partial<ModuleGridSettings> = {}
Returns ModuleGrid

Methods

destroy

destroy(): void

Overrides Module.destroy
- Defined in modules/ModuleGrid.ts:80
Tells, how the module should be destroyed. This usually involves removing all created HTML elements, and event handlers, that were attached to other than removed elements.

Returns void

initView

initView(): void

Overrides Module.initView
- Defined in modules/ModuleGrid.ts:86
Called once, when JSR is ready to append this module to HTML DOM. All element creation and event handler should be bind here.

Returns void

Optional render

render(state: StateDto): VoidFunction

Inherited from Module.render
- Defined in modules/Module.ts:38
Tells, how the module should render. This function is called everytime something changes within the application.

Parameters
- state: StateDto
Returns VoidFunction

Optional update

update(config: ConfigDto, state: State, changelog: Changelog): State

Inherited from Module.update
- Defined in modules/Module.ts:50
Called every time state is updated - any further updates can be applied here, returning new state. See RoundToStep module for example.

Parameters
- config: ConfigDto
- state: State
- changelog: Changelog
Returns State

Generated using TypeDoc