Web SDK documentation
  1. Injectables
  2. RouterService

File

core/router/router.service.ts

Description

A service which defines routes for the application. You can use HOOK_ROUTES or pass

Extends

ExtensionPointWithoutStateForPlugins

Index

Properties
Methods

Constructor

constructor(rootInjector: Injector, router: Router, contextRouteService: ContextRouteService, plugins: PluginsResolveService, options: OptionsService)
Parameters :
Name Type Optional
rootInjector Injector No
router Router No
contextRouteService ContextRouteService No
plugins PluginsResolveService No
options OptionsService No

Methods

addRoute
addRoute(route: Route | Route[])

Add a new route to the router configuration or a context.

Parameters :
Name Type Optional Description
route Route | Route[] No

The route to add
Returns : void
getHref
getHref(groupOrDevice: IManagedObject, prefix: string)

Determines if the given MO is an group or an device and returns the correct href to link correctly to that MO.

Parameters :
Name Type Optional Default value Description
groupOrDevice IManagedObject No

The MO of a group or the device.
prefix string No '#/'

How should the link be prefixed.
Returns : string
refresh
refresh()

Refresh the current context

Returns : void
Protected setupItemsObservable
setupItemsObservable()
Returns : Observable<Route[]>

Properties

Public router
Type : Router
Readonly state
Default value : new Map<string, Route>()
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>

results matching ""

    No results matching ""