File

core/stepper/stepper.service.ts

Description

A service which defines the steps in a stepper component. A stepper hook needs an certain outlet which has an matching id to display the steps.

Extends

ExtensionPointForPlugins

Index

Properties
Methods
Accessors

Constructor

constructor(rootInjector: Injector, router: Router, translateService: TranslateService, plugins: PluginsResolveService)
Parameters :
Name Type Optional
rootInjector Injector No
router Router No
translateService TranslateService No
plugins PluginsResolveService No

Methods

add
add(item: Step)

Adds a new item to tabs and emits state change

Parameters :
Name Type Optional Description
item Step No

The item to add.

Returns : void
getById$
getById$(id)

Returns the component by it's asssigned stepper id as an observable.

Parameters :
Name Optional Description
id No

The id of the stepper to hook into.

Returns : any
remove
remove(item: Step)

Removes a step and emits a state change.

Parameters :
Name Type Optional Description
item Step No

The item to remove.

Returns : void
Protected setupItemsObservable
setupItemsObservable()
Returns : Observable<Step[]>
sortSteps
sortSteps(steps: Step[])
Parameters :
Name Type Optional
steps Step[] No
Returns : any
refresh
refresh()

Refresh the extension factories

Returns : void
Protected emitNewState
emitNewState()

Emits a new state.

Returns : void
map
map(mappedProperty: (undefined) => void)

Maps to a property and just returns that property.

Parameters :
Name Type Optional Description
mappedProperty function No

The property to map to.

Returns : Observable<any>

Properties

factories
Type : ExtensionFactory<T>[]
Default value : []
Protected injectors
Type : Injector[]

All injectors to search for an extension.

items$
Type : Observable<T[]>
Readonly refresh$
Type : Observable<void>
Readonly state$
Default value : new BehaviorSubject<Set<T>>(new Set<T>())

Accessors

state
getstate()

Returns the current state.

Returns : Set<Step>

results matching ""

    No results matching ""