NavigationInputMode

Show usages

An IInputMode that can navigate an IGraph displayed in a graphComponent.

Inheritance Hierarchy

NavigationInputMode

Implemented Interfaces

IInputMode

Remarks

This mode is exclusive by default.

Examples

Typically the NavigationInputMode is installed as child mode of a GraphEditorInputMode or GraphViewerInputMode and can be retrieved from the navigationInputMode property.

const navigationInputMode = mode.navigationInputMode

The NavigationInputMode supports e.g. opening and closing group nodes. These actions can be configured in details:

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// don't fit the content after expand/collapse
mode.navigationInputMode.fitContentAfterGroupActions = false
// expand/collapse group nodes in a way that their
// top right corner stays at its current coordinates
mode.navigationInputMode.autoGroupNodeAlignmentPolicy =
  NodeAlignmentPolicy.TOP_RIGHT

It also reports when groups are opened or collapsed interactively by raising the following events:

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode
mode.navigationInputMode.addGroupExpandingListener((sender, args) => {
  const node = args.item
  // do something with the node before it will be expanded
})
mode.navigationInputMode.addGroupExpandedListener((sender, args) => {
  const node = args.item
  // do something with the node after it has been expanded
})
mode.navigationInputMode.addGroupCollapsingListener((sender, args) => {
  /* same for collapse operations */
})
mode.navigationInputMode.addGroupCollapsedListener((sender, args) => {
  /* same for collapse operations */
})

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.input.NavigationInputMode

Constructors

NavigationInputMode

()

Initializes a new instance of the NavigationInputMode class.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

priority - number
exclusive - boolean: A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.
enabled - boolean: The enabled state of this input mode. This option sets the enabled property on the created object.
navigableItems - GraphItemTypes: The item types that can be navigated to by this mode. This option sets the navigableItems property on the created object.
selectableItems - GraphItemTypes: The types of the items that should be selectable by this instance. This option sets the selectableItems property on the created object.
autoGroupNodeAlignmentPolicy - NodeAlignmentPolicy: The location that should be kept fixed if toggling a group node state. This option sets the autoGroupNodeAlignmentPolicy property on the created object.
graphComponent - GraphComponent: The graphComponent this mode acts on. This option sets the graphComponent property on the created object.
useCurrentItemForCommands - boolean: A value indicating whether to use the currentItem as a fallback for the commands if no item is provided in the parameter and the current selection is empty. This option sets the useCurrentItemForCommands property on the created object.
allowEnterGroup - boolean: A value that determines whether it is allowed to enter group nodes via the ENTER_GROUP. This option sets the allowEnterGroup property on the created object.
allowCollapseGroup - boolean: A value that determines whether it is allowed to collapse group nodes via the COLLAPSE_GROUP. This option sets the allowCollapseGroup property on the created object.
allowExpandGroup - boolean: A value that determines whether it is allowed to expand group nodes via the EXPAND_GROUP. This option sets the allowExpandGroup property on the created object.
allowExitGroup - boolean: A value that determines whether it is allowed to exit the current group node via the EXIT_GROUP. This option sets the allowExitGroup property on the created object.
fitContentAfterGroupActions - boolean: A value that determines whether fitContent or the FIT_CONTENT should be triggered after a group navigation action. This option sets the fitContentAfterGroupActions property on the created object.
scrollToSelection - boolean: A value determining whether a node that has been focused or selected with a keyboard gesture should be made visible by adjusting the viewport. This option sets the scrollToSelection property on the created object.
useViewCoordinates - boolean: A value indicating whether navigating the graph with the arrow keys interprets the direction in view coordinates. This option sets the useViewCoordinates property on the created object.

Properties

allowCollapseGroup

: boolean

Gets or sets a value that determines whether it is allowed to collapse group nodes via the COLLAPSE_GROUP.

Remarks

The default value is true.

Examples

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// don't fit the content after expand/collapse
mode.navigationInputMode.fitContentAfterGroupActions = false
// expand/collapse group nodes in a way that their
// top right corner stays at its current coordinates
mode.navigationInputMode.autoGroupNodeAlignmentPolicy =
  NodeAlignmentPolicy.TOP_RIGHT

allowEnterGroup

: boolean

Gets or sets a value that determines whether it is allowed to enter group nodes via the ENTER_GROUP.

Remarks

The default value is true.

Examples

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// don't fit the content after expand/collapse
mode.navigationInputMode.fitContentAfterGroupActions = false
// expand/collapse group nodes in a way that their
// top right corner stays at its current coordinates
mode.navigationInputMode.autoGroupNodeAlignmentPolicy =
  NodeAlignmentPolicy.TOP_RIGHT

allowExitGroup

: boolean

Gets or sets a value that determines whether it is allowed to exit the current group node via the EXIT_GROUP.

Remarks

The default value is true.

Examples

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// don't fit the content after expand/collapse
mode.navigationInputMode.fitContentAfterGroupActions = false
// expand/collapse group nodes in a way that their
// top right corner stays at its current coordinates
mode.navigationInputMode.autoGroupNodeAlignmentPolicy =
  NodeAlignmentPolicy.TOP_RIGHT

allowExpandGroup

: boolean

Gets or sets a value that determines whether it is allowed to expand group nodes via the EXPAND_GROUP.

Remarks

The default value is true.

Examples

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// don't fit the content after expand/collapse
mode.navigationInputMode.fitContentAfterGroupActions = false
// expand/collapse group nodes in a way that their
// top right corner stays at its current coordinates
mode.navigationInputMode.autoGroupNodeAlignmentPolicy =
  NodeAlignmentPolicy.TOP_RIGHT

autoGroupNodeAlignmentPolicy

: NodeAlignmentPolicy

Gets or sets the location that should be kept fixed if toggling a group node state.

Remarks

Default value is NONE

Examples

This property can be used to synchronize the fixed location with the button location of a CollapsibleNodeStyleDecorator:

navigationMode.autoGroupNodeAlignmentPolicy = NodeAlignmentPolicy.TOP_RIGHT
graph.groupNodeDefaults.style = new CollapsibleNodeStyleDecorator({
  buttonPlacement: InteriorLabelModel.NORTH_EAST
})

availableCommands

: ICollection<ICommand>

Gets the list of commands that are available in this instance.

Remarks

By default, all supported commands are available

Removing commands from this collection also removes the command bindings registered by this instance.

Add supported commands to make them available in this instance.

Supported commands are

controller

: ConcurrencyController

Gets the installed controller.

enabled

: boolean

Gets or sets the enabled state of this input mode.

Remarks

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed controller so a disabled instance should never try to acquire the input mutex.

Examples

Disabling the NavigationInputMode on its parent input mode

mode.navigationInputMode.enabled = false

exclusive

: boolean

Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.

Remarks

The value of this property will be delegated to the exclusive property of the controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.

fitContentAfterGroupActions

: boolean

Gets or sets a value that determines whether fitContent or the FIT_CONTENT should be triggered after a group navigation action.

Remarks

Note that collapseGroup and expandGroup only fit the content when autoGroupNodeAlignmentPolicy is NONE.

The default value is false.

graph

: IGraph

Gets or sets the graph this mode operates on.

graphComponent

: GraphComponent

Gets or sets the graphComponent this mode acts on.

graphSelection

: IGraphSelection

Gets or sets the IGraphSelection this mode operates on.

inputModeContext

: IInputModeContext

Gets the context instance this mode is currently installed in or null if this instance is not installed.

Remarks

Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the parentInputMode should be used.

Implements

IInputMode

navigableItems

: GraphItemTypes

Gets or sets the item types that can be navigated to by this mode.

priority

: number

Gets the priority of this input mode.

Remarks

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Implements

IInputMode

scrollToSelection

: boolean

Gets or sets a value determining whether a node that has been focused or selected with a keyboard gesture should be made visible by adjusting the viewport.

Remarks

The default value is true.

selectableItems

: GraphItemTypes

Gets the types of the items that should be selectable by this instance.

Remarks

The selectable items. The default value is NODE.

useCurrentItemForCommands

: boolean

Gets or sets a value indicating whether to use the currentItem as a fallback for the commands if no item is provided in the parameter and the current selection is empty.

Remarks

This applies to the following commands:

useViewCoordinates

: boolean

Gets or sets a value indicating whether navigating the graph with the arrow keys interprets the direction in view coordinates.

Remarks

If set to true, the direction is interpreted in view coordinates.

Default is false.

Methods

adjustContentRect

()

Adjusts the contentRect to encompass all elements.

Remarks

This implementation will try to delegate to adjustContentRect if it can find the GraphEditorInputMode in the inputModeContext, otherwise updateContentRect is called.

adjustGroupNodeLocation

(collapse: boolean, groupNode: INode, expandedSize?: Rect)

Adjust the group node location according to the value of autoGroupNodeAlignmentPolicy.

Parameters

options - Object
A map of options to pass to the method.

collapse - boolean: true iff the node has just been collapsed.
groupNode - INode: The node that has changed its state.
expandedSize - Rect: The size of the group node when it is expanded.

cancel

()

Called by the client to unconditionally cancel all editing.

Remarks

This will be called prior to the uninstalling of this instance.

In order to stop an active input mode manually, client code should use the following idiom:

if (!mode.tryStop()) {
  mode.cancel()
}

Implements

IInputMode

clearSelection

()

Clears the selection in the graphComponent.

collapseGroup

(groupNode: INode)

Collapses the given group node to hide the contents of the group node from this IFoldingView.

Parameters

options - Object
A map of options to pass to the method.

groupNode - INode: The group node to collapse.

collapseSelection

()

Performs collapseGroup for all selectedNodes.

enterGroup

(node: INode)

This method allows for entering a group node so that the currently displayed IFoldingView's localRoot will be reset to the provided node.

Remarks

It is possible to both use a local group node that is part of the currently displayed graph as the node argument, as well as an item that belongs to the masterGraph to allow for switching to group nodes which are currently not being displayed in this view.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node that needs to be either part of the current graph, or part of the masterGraph.

enterSelectedGroup

()

Performs enterGroup for the first valid selectedNodes.

exitGroup

()

Exits the current localRoot of the currently displayed view and shows the contents of the parent container.

Remarks

This method will also clear the selection and select the exited group node.

expandGroup

(groupNode: INode)

Expands the given group node to show the contents of the collapsed group node in this IFoldingView.

Parameters

options - Object
A map of options to pass to the method.

groupNode - INode: The group node to expand

expandSelection

()

Performs expandGroup for all selectedNodes.

extendSelectionTo

(direction: MoveFocusDirection)

Moves the focus into the given direction, extending the selection to the new element.

Parameters

options - Object
A map of options to pass to the method.

direction - MoveFocusDirection: The direction to move the focus and extend the selection.

findNearestItem

(context: IInputModeContext, startLocation: Point, direction: MoveFocusDirection, itemsToCheck: IEnumerable<IModelItem>) : IModelItem

Determines the nearest item in the given direction.

Remarks

The default implementation uses the euclidean distance from startLocation which is additionally weighted to prefer items in the geometric direction. This method is called by the default implementation of findNextItem when MoveFocusDirection corresponds to an actual direction in the geometric sense. The method will be called at most twice by the default implementation of findNextItem. If it returns null the first time with a smaller set of possible candidates, the default implementation will call it again with more possible candidates.

Note that the default implementation ignores any projection and treats directions to be in world coordinates unless useViewCoordinates is set.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The current input mode context.
startLocation - Point: The reference location for the gesture.
direction - MoveFocusDirection: The direction for the move action.
itemsToCheck - IEnumerable<IModelItem>: The items that should be considered.

Returns

↪IModelItem: The nearest item in direction or null if no suitable item can be determined.

findNextItem

(context: IInputModeContext, direction: MoveFocusDirection) : IModelItem

Determines the next item when a navigation command is executed.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The current input mode context.
direction - MoveFocusDirection: The direction of the command.

Returns

↪IModelItem: The next item in direction, or null.

fitContent

()

Adjusts the viewport to fully encompass the contentRect.

Remarks

This implementation will try to delegate to FIT_CONTENT if it can be executed, otherwise fitContent is called.

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs this mode into the given context that is provided by the canvas.

Remarks

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation, first.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried during the time the mode is installed.
controller - ConcurrencyController: The controller for this mode.

Implements

IInputMode

moveFocusTo

(direction: MoveFocusDirection)

Moves the focus into the given direction, not changing the current selection.

Parameters

options - Object
A map of options to pass to the method.

direction - MoveFocusDirection: The direction to move the focus.

moveTo

(direction: MoveFocusDirection)

Moves the focus into the given direction, setting the selection to the new element.

Parameters

options - Object
A map of options to pass to the method.

direction - MoveFocusDirection: The direction to move the focus and selection.

onCanceled

()

Called after cancel has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been canceled.

This implementation does nothing.

onConcurrencyControllerActivated

()

Called after the active property of the installed ConcurrencyController has been set to true.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been activated.

Overriding implementations should call the base implementation.

onConcurrencyControllerDeactivated

()

Called after the active property of the installed ConcurrencyController has been set to false.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been deactivated.

Overriding implementations should call the base implementation.

onGroupCollapsed

(evt: ItemEventArgs<INode>)

Raises the GroupCollapsed event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupCollapsing

(evt: ItemEventArgs<INode>)

Raises the GroupCollapsing event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupEntered

(evt: ItemEventArgs<INode>)

Raises the GroupEntered event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupEntering

(evt: ItemEventArgs<INode>)

Raises the GroupEntering event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupExited

(evt: ItemEventArgs<INode>)

Raises the GroupExited event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupExiting

(evt: ItemEventArgs<INode>)

Raises the GroupExiting event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupExpanded

(evt: ItemEventArgs<INode>)

Raises the GroupExpanded event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onGroupExpanding

(evt: ItemEventArgs<INode>)

Raises the GroupExpanding event.

Parameters

options - Object
A map of options to pass to the method.

evt - ItemEventArgs<INode>: The ItemEventArgs<T> instance containing the event data.

onSetCurrentItem

(graphComponent: GraphComponent, item: IModelItem) : boolean

Actually sets the current item property.

Parameters

options - Object
A map of options to pass to the method.

graphComponent - GraphComponent: The graphComponent to set the current item of.
item - IModelItem: The item to set.

Returns

↪boolean: Whether the operation was actually performed.

onStopped

()

Called after tryStop has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

selectCurrentItem

()

Selects the currentItem current item.

Remarks

This method delegates to selectItem.

selectItem

(graphComponent: GraphComponent, item: IModelItem, extendSelection: boolean)

Selects the given item.

Parameters

options - Object
A map of options to pass to the method.

graphComponent - GraphComponent: The graphComponent.
item - IModelItem: The item to select.
extendSelection - boolean: if set to true the current selection is extended otherwise it is cleared beforehand.

setCurrentItem

(item: IModelItem)

Sets the "current" item to the given one.

Remarks

The current item will not be set if graphComponent is null.

Parameters

options - Object
A map of options to pass to the method.

item - IModelItem: The item to set as the current item.

setGraphComponent

(graphComponent: GraphComponent)

Sets the graphComponent to use for the various actions.

Remarks

This will register or unregister the ICommands for the control. This method is called in response to install and uninstall.

Parameters

options - Object
A map of options to pass to the method.

graphComponent - GraphComponent: The control to use or null.

shouldCollapseGroup

(groupNode: INode) : boolean

Predicate method that decides whether it is allowed to collapse the given group node.

Remarks

This implementation returns the value of allowCollapseGroup.

Returns

↪boolean: Whether to collapse the given group or not.

shouldEnterGroup

(node: INode) : boolean

Predicate method that decides whether it is allowed to enter the specific group node.

Remarks

This implementation yields the value of allowEnterGroup.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The group node to enter.

Returns

↪boolean: Whether to enter the group or not.

shouldExitGroup

() : boolean

Predicate method that decides whether it is allowed to exit the current group node.

Remarks

This implementation yields the value of allowExitGroup.

Returns

↪boolean: Whether to exit the current group or not.

shouldExpandGroup

(node: INode) : boolean

Predicate method that decides whether it is allowed to expand the given group node.

Remarks

This implementation yields the value of allowExpandGroup.

Returns

↪boolean: Whether to expand the given group or not.

shouldNavigateTo

(item: IModelItem) : boolean

Determines whether a given model item should be navigated to.

Remarks

This implementation uses the navigableItems property to determine whether the item can be navigated to.

Parameters

options - Object
A map of options to pass to the method.

item - IModelItem: The model item.

Returns

↪boolean: Whether the item should be considered for navigational commands.

shouldRequestMutex

() : boolean

Determines whether the input mode should try to request the mutex when a command is executed.

Remarks

This resets the state of any other input mode, unless it currently possesses the mutex.

The value of this method is queried for COLLAPSE_GROUP, EXPAND_GROUP, TOGGLE_EXPANSION_STATE, ENTER_GROUP and EXIT_GROUP.

Returns

↪boolean: whether the input mode should request the mutex.

shouldSelect

(item: IModelItem) : boolean

Determines whether a given model item should be selected.

Remarks

This implementation uses the selectableItems property to determine whether the item should be selected.

Parameters

options - Object
A map of options to pass to the method.

item - IModelItem: The model item.

Returns

↪boolean: Whether the item should be selected by the navigational commands.

shouldToggleExpansionState

(node: INode) : boolean

Predicate method that decides whether it is allowed to toggle the collapsed state of the given group node.

Remarks

This implementation uses shouldExpandGroup and shouldCollapseGroup respectively.

Returns

↪boolean: Whether to expand the given group or not.

toggleExpansionState

(groupNode: INode)

Toggles the expanded/collapsed state for the given group node in the IFoldingView.

Parameters

options - Object
A map of options to pass to the method.

groupNode - INode: The group node to toggle the state for.

tryStop

() : boolean

Overridden to only return true if this instance does not currently have the input mutex.

Returns

↪boolean: true iff this instance does not own the mutex.

Implements

IInputMode

uninstall

(context: IInputModeContext)

Uninstalls this mode from the given context.

Remarks

This code should clean up all changes made to the canvas in the install method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context to deregister from. This is the same instance that had been passed to install during installation.

Implements

IInputMode

Events

GroupCollapsed

Occurs whenever a group has been Collapsed.

Event Registration

addGroupCollapsedListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupCollapsedListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupCollapsing

Occurs before a group will be Collapsed.

Event Registration

addGroupCollapsingListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupCollapsingListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupEntered

Occurs whenever a group has been Entered.

Event Registration

addGroupEnteredListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupEnteredListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupEntering

Occurs before a group will be Entered.

Event Registration

addGroupEnteringListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupEnteringListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupExited

Occurs whenever a group has been Exited.

Event Registration

addGroupExitedListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupExitedListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupExiting

Occurs before a group will be Exited.

Event Registration

addGroupExitingListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupExitingListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupExpanded

Occurs whenever a group has been Expanded.

Event Registration

addGroupExpandedListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupExpandedListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

GroupExpanding

Occurs before a group will be Expanded.

Event Registration

addGroupExpandingListener(function(this, ItemEventArgs<INode>):void)

Event Deregistration

removeGroupExpandingListener(function(this, ItemEventArgs<INode>):void)

Signature Details

function(sender: this, evt: ItemEventArgs<INode>)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - ItemEventArgs<INode>: An object that contains the event data.

NavigationInputMode

Remarks

Examples

Type Details

See Also

Constructors

NavigationInputMode

ParametersOptions Overload

Properties

allowCollapseGroup

Remarks

Examples

See Also

allowEnterGroup

Remarks

Examples

See Also

allowExitGroup

Remarks

Examples

See Also

allowExpandGroup

Remarks

Examples

See Also

autoGroupNodeAlignmentPolicy

Remarks

Examples

See Also

availableCommands

Remarks

See Also

controller

enabled

Remarks

Examples

exclusive

Remarks

fitContentAfterGroupActions

Remarks

graph

graphComponent

graphSelection

inputModeContext

Remarks

Implements

navigableItems

See Also

priority

Remarks

See Also

Implements

scrollToSelection

Remarks

See Also

selectableItems

Remarks

useCurrentItemForCommands

Remarks

useViewCoordinates

Remarks

Methods

adjustContentRect

Remarks

adjustGroupNodeLocation

Parameters

cancel

Remarks

Implements

clearSelection

collapseGroup

Parameters

See Also

collapseSelection

enterGroup

Remarks

Parameters

See Also

enterSelectedGroup

exitGroup