Web SDK documentation
  1. Injectables
  2. AssetSelectorService

File

assets-navigator/asset-selector/asset-selector.service.ts

Extends

AssetNodeService

Index

Properties
Methods

Methods

getIndexOfSelected
getIndexOfSelected(selected: Array> | Partial, selectedMo: IIdentified)

Returns the index of the currently selected item.

Parameters :
Name Type Optional Description
selected Array<Partial<IIdentified>> | Partial<IIdentified> No

All selected items
selectedMo IIdentified No

The new selected item-
Returns : any

An index, or -1 if not found.
isNodeSelectable
isNodeSelectable(node: GroupNode)

Checks if the node is selectable.

Parameters :
Name Type Optional Description
node GroupNode No

The node to check.
Returns : boolean
normalizeValue
normalizeValue(obj: Partial, modelMode: "simple" | "full")

Simplifies the object model based on the selected mode.

Parameters :
Name Type Optional Description
obj Partial<IManagedObject> No

The selected asset.
modelMode "simple" | "full" No
Returns : Partial | IIdentified
setIsNodeSelectable
setIsNodeSelectable(fn: boolean | )

Sets the function that will decide if the node is selectable.

Parameters :
Name Type Optional Description
fn boolean | No

A boolean or a function that will decide if the node is selectable.
Returns : void
simplifyModel
simplifyModel(model: Partial | IIdentified[], mode: "simple" | "full")
Parameters :
Name Type Optional
model Partial<IManagedObject> | IIdentified[] No
mode "simple" | "full" No
Returns : Partial | IIdentified
canDropNode
canDropNode(dropOnRoot: boolean)

Check if it is possible to drop a node after dragging.

Parameters :
Name Type Optional Description
dropOnRoot boolean No

Is the drop performed on the root node
Returns : boolean
createAssetNode
createAssetNode(config: Partial<AssetNode>)
Parameters :
Name Type Optional
config Partial<AssetNode> No
Returns : any
createChildNode
createChildNode(managedObject, config: Partial<AssetNode>)
Parameters :
Name Type Optional
managedObject No
config Partial<AssetNode> No
Returns : any
createDynamicGroupNode
createDynamicGroupNode(config)
Parameters :
Name Optional
config No
Returns : any
Protected createFilter
createFilter(extraParams: any)
Parameters :
Name Type Optional Default value
extraParams any No {}
Returns : any
createRootNode
createRootNode(config: NavigatorNodeData)
Parameters :
Name Type Optional Default value
config NavigatorNodeData No {}
Returns : AssetNode
expandAll
expandAll(node: AssetNode, ids: string[])

Expands all the given ids recursively. Stops if it does not find any.

Parameters :
Name Type Optional Description
node AssetNode No

The node where the expanding should be started
ids string[] No

The ids that should be expanded.
Returns : void
Async expandNodesOnStart
expandNodesOnStart(snapshot: ActivatedRouteSnapshot)

Expands the navigator nodes on first navigation.

Parameters :
Name Type Optional Description
snapshot ActivatedRouteSnapshot No

The current navigation snapshot.
Returns : Promise<void>
getAllInventories
getAllInventories(customFilter?: any)
Parameters :
Name Type Optional
customFilter any Yes
Returns : Promise<any>
getDeviceChildren
getDeviceChildren(moId: string, extraFilter: object, filterQuery: string, withChildren)
Parameters :
Name Type Optional Default value
moId string No
extraFilter object No {}
filterQuery string No ''
withChildren No false
Returns : any
getDynamicGroupItems
getDynamicGroupItems(groupQuery: string, filterObj: any)
Parameters :
Name Type Optional Default value
groupQuery string No
filterObj any No {}
Returns : any
getGroupItems
getGroupItems(moId: string, extraFilter: object, withChildren, filterQuery: string)
Parameters :
Name Type Optional Default value
moId string No
extraFilter object No {}
withChildren No false
filterQuery string No ''
Returns : any
getRootNodes
getRootNodes(customFilter?: any)
Parameters :
Name Type Optional
customFilter any Yes
Returns : Promise<any>
getUnassignedDevices
getUnassignedDevices(withChildren, filterQuery: string)
Parameters :
Name Type Optional Default value
withChildren No false
filterQuery string No ''
Returns : any
getUnassignedDevicesQueryStr
getUnassignedDevicesQueryStr(filterQuery)
Parameters :
Name Optional
filterQuery No
Returns : string
groupQueryFilter
groupQueryFilter(moId: string, filterQuery?: string)
Parameters :
Name Type Optional
moId string No
filterQuery string Yes
Returns : string
icon
icon(mo: IManagedObject, open?: boolean)
Parameters :
Name Type Optional
mo IManagedObject No
open boolean Yes
Returns : Promise<string>
isAnyGroup
isAnyGroup(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isAsset
isAsset(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isDataBroker
isDataBroker(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isDataBrokerActive
isDataBrokerActive(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isDevice
isDevice(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isDynamicGroup
isDynamicGroup(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isGroup
isGroup(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : any
isNewManagedObjectRoot
isNewManagedObjectRoot(response: Partial>)
Parameters :
Name Type Optional Default value
response Partial<IResult<IManagedObject>> No {}
Returns : boolean
label
label(mo: IManagedObject)
Parameters :
Name Type Optional
mo IManagedObject No
Returns : string
navRootQueryFilter
navRootQueryFilter()
Returns : { __filter: { type: any; __has?: undefined; }; __orderby: {}; } | { __filter: { __has: any; type?: undefined; }; __orderby: {}; }
onUpdate
onUpdate(undefined)
Parameters :
Name Optional
No
Returns : any
preferBreadcrumb
preferBreadcrumb(parents: NavigatorNode[])

There could be multiple breadcrumbs for devices, so we set a preferred one on click on a device.

Parameters :
Name Type Optional Description
parents NavigatorNode[] No

The parent nodes of the device to select the prefered one.
Returns : void
rootQueryFilter
rootQueryFilter()
Returns : { __filter: { type: any; __has?: undefined; }; __orderby: {}; } | { __filter: { __has: any; type?: undefined; }; __orderby: {}; }

Properties

alert
Default value : inject(AlertService)
apiService
Default value : inject(ApiService)
Protected appState
Default value : inject(AppStateService)
Protected breadcrumbService
Default value : inject(BreadcrumbService)
Protected deviceGroupService
Default value : inject(DeviceGroupService)
draggedData
Type : AssetNode
firstUrl
Default value : true
inventory
Default value : inject(InventoryService)
modal
Default value : inject(ModalService)
moduleConfig
Type : AssetNavigatorConfig
Protected optionsService
Default value : inject(OptionsService)
Protected PAGE_SIZE
Type : number
Default value : 20
queriesUtil
Type : QueriesUtil
rootNode
Type : AssetNode
Protected router
Default value : inject(Router)
translateService
Default value : inject(TranslateService)
Protected user
Default value : inject(UserService)

results matching ""

    No results matching ""