File

core/wizard/wizard.service.ts

Extends

StateService

Index

Properties
Methods
Accessors

Constructor

constructor(bsModalService: BsModalService, injector: Injector, router: Router)
Parameters :
Name Type Optional
bsModalService BsModalService No
injector Injector No
router Router No

Methods

add
add(entry: WizardEntry)

Adds a new entry in the wizard.

Parameters :
Name Type Optional Description
entry WizardEntry No

Wizard entry to add.

Returns : void
getEntriesListById
getEntriesListById(id: string)

List of wizard entries matching the given id.

Parameters :
Name Type Optional
id string No
Returns : Observable<WizardEntry[]>

observable with list of wizard entries.

refresh
refresh()

Refresh the extension factories.

Returns : void
remove
remove(entry: WizardEntry)

Removes entry from the wizard.

Parameters :
Name Type Optional Description
entry WizardEntry No

Wizard entry to remove.

Returns : void
show
show(modalOptions: ModalOptions)

Shows a wizard modal.

Parameters :
Name Type Optional Default value Description
modalOptions ModalOptions No {}

Modal options.

a reference to the modal.

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

Readonly bodyTemplate$
Type : Subject<literal type>
Default value : new Subject()

Wizard body subject. It emits body template.

factories
Type : WizardExtension[]
Default value : []

Additional factories that can be added by plugins.

Readonly footerTemplate$
Type : Subject<literal type>
Default value : new Subject()

Wizard footer subject. It emits footer template.

Readonly headerTemplate$
Type : Subject<literal type>
Default value : new Subject()

Wizard header subject. It emits header template.

Readonly items$
Type : Observable<WizardEntry[]>

Wizard list observable. It emits the current list of the wizard entries.

Readonly refreshTrigger
Default value : new Subject()

Refresh the extension factories subject.

Protected Abstract state$
Type : BehaviorSubject<any> | any

Saves the state. Should not be accessible directly. Use map or the getter to access the state. Use functions in the implementation to change the state.

Accessors

state
getstate()

Returns the current state.

Returns : Set<WizardEntry>

results matching ""

    No results matching ""