File

core/navigator/navigator.service.ts

Description

A service which defines the navigator.

Extends

StateService

Index

Properties
Methods
Accessors

Constructor

constructor(rootInjector: Injector, router: Router)
Parameters :
Name Type Optional
rootInjector Injector No
router Router No

Methods

add
add(node: NavigatorNode)

Adds a new node to the navigator.

Parameters :
Name Type Optional Description
node NavigatorNode No

Navigator node to add.

Returns : void
openOnFirstUrl
openOnFirstUrl(node: NavigatorNode)

Checks whenever a navigator entry associated with the given URL should be expanded.

Parameters :
Name Type Optional Description
node NavigatorNode No

Navigator node.

Returns : any
refresh
refresh()

Refresh the extension factories.

Returns : void
remove
remove(node: NavigatorNode)

Removes a node from the navigator.

Parameters :
Name Type Optional Description
node NavigatorNode No

Navigator node to remove.

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 : NavigatorExtension[]
Default value : []

Additional factories that can be added by plugins.

firstUrl
Default value : true

Indicates whether the menu entry associated with the given URL should be expanded.

injectors
Type : []
Default value : [this.rootInjector]
items$
Type : Observable<NavigatorNode[]>

Navigator menu items observable. It emits the current list of nodes in the navigator.

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<NavigatorNode>

results matching ""

    No results matching ""