File

src/ui/toolbar/smart-toolbar-registry.service.ts

Index

Properties
Methods

Methods

Public deregisterToolbar
deregisterToolbar(name: string)

Deregisters the toolbar registered under the given name and allows another toolbar to use that name.

Parameters :
Name Type Optional
name string No
Returns : void
Public getToolbar
getToolbar(name: string)

Returns the toolbar registered under the given name, if it exists and has been previously registered.

Parameters :
Name Type Optional
name string No
Returns : any
Public getToolbarAsObservable
getToolbarAsObservable(name: string)

Returns an observable that fires once when the requested Smart Toolbar instance is available

Parameters :
Name Type Optional Description
name string No

the instance or object name of the Smart Toolbar

Returns : Observable<any>
Public registerToolbar
registerToolbar(name: string, toolbar: any)

Registers a Toolbar Component under the given name. Throws an error if a toolbar has already been registered under that name.

Parameters :
Name Type Optional
name string No
toolbar any No
Returns : void

Properties

toolbarRegistered
Type : EventEmitter<SmartToolbarRegistryEventArgs>
Default value : new EventEmitter()

Fires when a Toolbar Component is registered.

result-matching ""

    No results matching ""