Web SDK documentation
  1. Classes
  2. GroupNode

File

assets-navigator/asset-selector/group-node.ts

Extends

AssetNode

Index

Properties
Methods

Constructor

constructor(service: GroupNodeService, config: GroupNodeConfig)

Creates a new node which shows only groups.

Parameters :
Name Type Optional Description
service GroupNodeService No

The service to use.
config GroupNodeConfig No

The default configuration of the node.

Properties

children
Type : GroupNode[]
Default value : []

Group node children (subentries).
groupsOnly
Type : unknown
Default value : false

Set this true, if only groups should be shown.
groupsSelectable
Type : unknown
Default value : false

Set this true, if it groups are also selectable.
Static NAME
Type : string
Default value : 'GroupNode'
showChildDevices
Type : unknown
Default value : false

Devices with children can be selected to show their child devices.
events
Type : Subject<AssetsNavigatorAction>
filterQuery$
Type : unknown
Default value : new BehaviorSubject<string>('')
hideDevices
Type : unknown
Default value : false
Protected loadMoreNode
Type : LoadMoreNode
mo
Type : any
nodesFetched
Type : Subject<void>
Default value : new Subject()
Protected paging
Type : Paging<AssetNodeMo>
root
Type : boolean
Optional breadcrumb
Type : string

The breadcrumb of the node, displaying the "path", but supports multiple levels. e.g. (Groups > Level 1 > Level 2)
Optional component
Type : Type<any>

Custom component to use.
confirm
Type : PopoverConfirmComponent
Default value : undefined

Confirmation popover displayed at the end of the process of moving the navigator menu item.
draggable
Type : unknown
Default value : false

Indicates that the navigator node is draggable.
dragged
Type : unknown
Default value : false

Indicates that the navigator node is dragged.
draggedHover
Type : unknown
Default value : false

Indicates that currently something is dragged over the node.
droppable
Type : unknown
Default value : false

Indicates that the navigator node is droppable.
Optional featureId
Type : string

Id to identify specific feature node.
hidden
Type : unknown
Default value : false

Indicates that the navigator node is visible/hidden.
icon
Type : SupportedIconsSuggestions

Navigator node icon.
Optional iconComponent
Type : Type<any>

Custom icon component.
iconOpen
Type : string

Navigator node icon when expanded.
Optional iconTemplate
Type : TemplateRef<any>

Custom icon template.
Optional injector
Type : Injector

Used to load the providers for the components. If not provided, default injector us used.
label
Type : string

Label to be displayed in the navigator node.
Optional loading
Type : boolean

Loading state indicator.
open
Type : unknown
Default value : false

Indicates that the navigator node is expanded/collapsed.
parents
Type : NavigatorNode[]
Default value : []

Navigator node parent nodes.
path
Type : string

The path to which the UI will be redirected after clicking the navigator node.
Optional refreshCallback
Type : function

A callback function that will be called when the node needs to be refreshed.
routerLinkExact
Type : unknown
Default value : true

Indicates whether the navigator node should be active based on matching the node path and the URL path. To match the URL exactly, set this option to true.

routerLinkExact set to true: When the URL path is set to /a/b/c and the node path to /a/b then the node will not be set active.

routerLinkExact set to false: When the URL path is set to /a/b/c and the node path to /a/b then the node will be set active.
translateLabel
Type : unknown
Default value : true

Whether to pass label through translate pipe when being displayed.

Methods

addManagedObject
addManagedObject(mo: unknown)

Adds the MO as a child node.

Parameters :
Name Type Optional Description
mo unknown No

ManagedObject
Returns : void
countChildren
countChildren()

Counts the number of children for the current node (with the exception of the UnassignedDevicesNode).

Returns : number
empty
empty()

Removes all child nodes except the UnassignedDevicesNode.

Returns : void
fetch
fetch()
Returns : any
isGroup
isGroup()
Returns : any
toString
toString()
Returns : string
Protected addNodes
addNodes(res: unknown)
Parameters :
Name Type Optional
res unknown No
Returns : void
click
click(options: ClickOptions)
Parameters :
Name Type Optional Default value
options ClickOptions No {}
Returns : void
destroy
destroy()
Returns : void
dragEnd
dragEnd($event: unknown)
Parameters :
Name Type Optional
$event unknown No
Returns : void
dragStart
dragStart($event: unknown)
Parameters :
Name Type Optional
$event unknown No
Returns : void
Async drop
drop($event: unknown)
Parameters :
Name Type Optional
$event unknown No
Returns : any
getPath
getPath()
Returns : any
Protected Async handleEvent
handleEvent(evt: AssetsNavigatorAction)
Parameters :
Name Type Optional
evt AssetsNavigatorAction No
Returns : any
hasChildDevices
hasChildDevices()

Checks if the current node has child devices.

Returns : boolean
hookEvents
hookEvents()
Returns : void
isChildAddition
isChildAddition(childAdditions: unknown, mo: unknown)
Parameters :
Name Type Optional
childAdditions unknown No
mo unknown No
Returns : any
refresh
refresh(mo: any, method: string)
Parameters :
Name Type Optional Default value
mo any No {}
method string No 'GET'
Returns : void
setLabel
setLabel()
Returns : void
sort
sort()
Returns : void
Protected toggleLoadMore
toggleLoadMore(show: boolean)
Parameters :
Name Type Optional
show boolean No
Returns : void
Protected Async updateIcon
updateIcon(open: unknown)
Parameters :
Name Type Optional
open unknown No
Returns : any
add
add(node: NavigatorNode)

Adds a child navigator node to the node.

Parameters :
Name Type Optional Description
node NavigatorNode No

Child node.
Returns : void
dragEnter
dragEnter($event: unknown)

This event is fired when a dragged element enters a valid drop target.

Parameters :
Name Type Optional Description
$event unknown No

DOM event.
Returns : void
dragLeave
dragLeave($event: unknown)

This event is fired when a dragged element leaves a valid drop target.

Parameters :
Name Type Optional Description
$event unknown No

DOM event.
Returns : void
expand
expand()

Expands the navigator node if it is collapsed.

Returns : void
find
find(predicate: unknown, findBy: unknown)

Returns a child navigator node based on the predicate.

Example :
// The function will compare the labels to the string and return a matching result.
// The capitalization of the characters does not matter (case insensitive).
const predicate = 'group1';
const childNode = parentNode.find(predicate);
// Check: [lodash matches](https://lodash.com/docs/4.17.15#matches)
const predicate = { label: 'group2' };
const childNode = parentNode.find(predicate);
Parameters :
Name Type Optional Default value Description
predicate unknown No

Filter criteria.
findBy unknown No 'label'

NavigatorNode field name to compare.
Returns : any
remove
remove(node: NavigatorNode)

Removes the child navigator node from the node.

Parameters :
Name Type Optional Description
node NavigatorNode No

Child node.
Returns : void
traverse
traverse(callback: unknown)

Performs a callback function recursively on each of the navigator node's children down the hierarchy.

Example :
const expandChild = (childNode) => childNode.expand();
parentNode.traverse(expandChild);
Parameters :
Name Type Optional Description
callback unknown No

Function to be called.
Returns : void
update
update(data?: NavigatorNodeData)

Updates the navigator node.

Parameters :
Name Type Optional Description
data NavigatorNodeData Yes

Data to be updated.
Returns : void
Protected updateChildren
updateChildren()

Updates the navigator node by sorting its children and also checking their visibility.

Returns : void
Protected updateHidden
updateHidden()

Checks if the navigator node should be hidden based on the visibility of its child nodes.

Returns : void

results matching ""

    No results matching ""