Web SDK documentation
  1. Classes
  2. LoadMoreNode

File

assets-navigator/load-more-node.ts

Extends

NavigatorNode

Index

Properties
Methods

Constructor

constructor()

Properties

droppable
Default value : true
icon
Type : string
Default value : 'plus'
label
Default value : gettext('Load more')
Static NAME
Type : string
Default value : 'LoadMoreNode'
Optional breadcrumb
Type : string

The breadcrumb of the node, displaying the "path", but supports multiple levels. e.g. (Groups > Level 1 > Level 2)
children
Type : NavigatorNode[]
Default value : []

Navigator node children (subentries).
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
Default value : false

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

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

Indicates that currently something is dragged over the node.
Optional featureId
Type : string

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

Indicates that the navigator node is visible/hidden.
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.
Optional loading
Type : boolean

Loading state indicator.
open
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.
routerLinkExact
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
Default value : true

Whether to pass label through translate pipe when being displayed.

Methods

isGroup
isGroup()
Returns : boolean
toString
toString()
Returns : string
add
add(node: NavigatorNode)

Adds a child navigator node to the node.

Parameters :
Name Type Optional Description
node NavigatorNode No

Child node.
Returns : void
Protected countChildren
countChildren()

Counts the amount of children nodes.

Returns : any
dragEnd
dragEnd($event)

This event is fired when a drag operation has ended.

Parameters :
Name Optional Description
$event No

DOM event.
Returns : void
dragEnter
dragEnter($event)

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

Parameters :
Name Optional Description
$event No

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

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

Parameters :
Name Optional Description
$event No

DOM event.
Returns : void
dragStart
dragStart($event)

This event is fired when the user starts dragging an element.

Parameters :
Name Optional Description
$event No

DOM event.
Returns : void
drop
drop($event)

This event is fired when an element is dropped on a valid drop target.

Parameters :
Name Optional Description
$event No

DOM event.
Returns : void
empty
empty()

Removes children nodes.

Returns : void
expand
expand()

Expands the navigator node if it is collapsed.

Returns : void
find
find(predicate, findBy)

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 Optional Default value Description
predicate No

Filter criteria.
findBy No 'label'

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

Removes the child navigator node from the node.

Parameters :
Name Type Optional Description
node NavigatorNode No

Child node.
Returns : void
Protected sort
sort()

Sorts the children of the navigator node, by priority and name (ASC). The higher the priority, the higher the position in the hierarchy. For the same priority values, the alphabetical order will take precedence.

Returns : void
traverse
traverse(callback)

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 Optional Description
callback 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 ""