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 (View Summary)

Module
- ModuleLimit

Index

Constructors

Methods

changeLimit destroy initView render update

Constructors

constructor

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

Methods

changeLimit

changeLimit(command: ChangeStateLimitCommand): void
Dynamically change limit.
Parameters
- command: ChangeStateLimitCommand
  limit object, that should be applied as new limit
Returns void
- Defined in modules/ModuleLimit.ts:38

destroy

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

initView

initView(): void
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
Overrides Module.initView
- Defined in modules/ModuleLimit.ts:52

render

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

update

update(_config: ConfigDto, state: State, _changelog: Changelog): State
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
Overrides Module.update
- Defined in modules/ModuleLimit.ts:84