Class ModuleLimit

Module for limiting values. This module has to be first in the list of modules, because otherwise limit won't properly.

Uses .jsr_limit CSS class.

Hierarchy

Module
- ModuleLimit

Index

Constructors

constructor

Methods

Constructors

constructor

new ModuleLimit(settings?: ModuleLimitSettings): ModuleLimit

Overrides Module.constructor
- Defined in modules/ModuleLimit.ts:23
Parameters
- settings: ModuleLimitSettings = {}
Returns ModuleLimit

Methods

changeLimit

changeLimit(command: ChangeStateLimitCommand): void

- Defined in modules/ModuleLimit.ts:38
Dynamically change limit.

Parameters
- command: ChangeStateLimitCommand
  
  limit object, that should be applied as new limit
Returns void

destroy

destroy(): void

Overrides Module.destroy
- Defined in modules/ModuleLimit.ts:29
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/ModuleLimit.ts:52
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

render

render(state: StateDto): VoidFunction

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

Parameters
- state: StateDto
Returns VoidFunction

update

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

Overrides Module.update
- Defined in modules/ModuleLimit.ts:84
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