Class HistoryService<C>

Type parameters

C: Component

Hierarchy

ComponentManagerService<C, HistoryManager<C>>
- HistoryService

Callable

HistoryService(): HistoryManager<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:28
Returns HistoryManager<C>

Index

Constructors

constructor

Properties

Accessors

historyState

Methods

Constructors

constructor

new HistoryService<C>(owner: C, serviceName: undefined | string): HistoryService<C>

Inherited from ComponentManagerService.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:66
Type parameters
- C: Component<C>
Parameters
- owner: C
- serviceName: undefined | string
Returns HistoryService<C>

Properties

Readonly inherit

inherit: string | boolean

Readonly manager

manager: HistoryManager<C>

Readonly name

name: string

Optional observe

observe: boolean

Readonly ownManager

ownManager: undefined | HistoryManager<C>

Readonly owner

owner: C

Readonly serviceFlags

serviceFlags: number

Readonly superManager

superManager: undefined | HistoryManager<C>

Readonly superName

superName: undefined | string

Readonly superService

superService: null | ComponentService<Component, HistoryManager<C>>

Optional Readonly type

type: unknown

Static InheritedFlag

InheritedFlag: number

Accessors

historyState

get historyState(): HistoryState

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/HistoryService.d.ts:6
Returns HistoryState

Methods

bindSuperService

bindSuperService(): void

Inherited from ComponentManagerService.bindSuperService
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:39
Returns void

getManager

getManager(): HistoryManager<C>

Inherited from ComponentManagerService.getManager
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:44
Returns HistoryManager<C>

getManagerOr

getManagerOr<E>(elseManager: E): HistoryManager<C> | E

Inherited from ComponentManagerService.getManagerOr
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:45
Type parameters
- E
Parameters
- elseManager: E
Returns HistoryManager<C> | E

initManager

initManager(): HistoryManager<C>

Overrides ComponentManagerService.initManager
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/HistoryService.d.ts:9
Returns HistoryManager<C>

isInherited

isInherited(): boolean

Inherited from ComponentManagerService.isInherited
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:34
Returns boolean

mount

mount(): void

Inherited from ComponentManagerService.mount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentManagerService.d.ts:5
Returns void

pushHistory

pushHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/HistoryService.d.ts:7
Parameters
- deltaState: HistoryStateInit
Returns void

replaceHistory

replaceHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/HistoryService.d.ts:8
Parameters
- deltaState: HistoryStateInit
Returns void

setInherit

setInherit(inherit: string | boolean): void

Inherited from ComponentManagerService.setInherit
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:33
Parameters
- inherit: string | boolean
Returns void

setServiceFlags

setServiceFlags(serviceFlags: number): void

Inherited from ComponentManagerService.setServiceFlags
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:36
Parameters
- serviceFlags: number
Returns void

unbindSuperService

unbindSuperService(): void

Inherited from ComponentManagerService.unbindSuperService
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:40
Returns void

unmount

unmount(): void

Inherited from ComponentManagerService.unmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentManagerService.d.ts:6
Returns void

Static define

define<C_7, T_7, I_1>(descriptor: ComponentServiceDescriptorExtends<C_7, T_7, I_1>): ComponentServiceConstructor<C_7, T_7, I_1>
define<C_8, T_8>(descriptor: ComponentServiceDescriptor<C_8, T_8, {}>): ComponentServiceConstructor<C_8, T_8, {}>

Inherited from ComponentManagerService.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:70
Type parameters
- C_7: Component<C_7>
- T_7
- I_1 = {}
Parameters
- descriptor: ComponentServiceDescriptorExtends<C_7, T_7, I_1>
Returns ComponentServiceConstructor<C_7, T_7, I_1>
Inherited from ComponentManagerService.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:71
Type parameters
- C_8: Component<C_8>
- T_8
Parameters
- descriptor: ComponentServiceDescriptor<C_8, T_8, {}>
Returns ComponentServiceConstructor<C_8, T_8, {}>

Static getClass

getClass(type: unknown): null | ComponentServiceClass

Inherited from ComponentManagerService.getClass
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:69
Parameters
- type: unknown
Returns null | ComponentServiceClass

Generated using TypeDoc