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 detail:

// mode is either an instance of GraphEditorInputMode or GraphViewerInputMode

// enable expanding and collapsing group nodes
mode.navigationInputMode.allowCollapseGroup = true
mode.navigationInputMode.allowExpandGroup = true
// do not 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.addEventListener('group-expanding', (evt) => {
  const node = evt.item
  // do something with the node before it will be expanded
})
mode.navigationInputMode.addEventListener('group-expanded', (evt) => {
  const node = evt.item
  // do something with the node after it has been expanded
})
mode.navigationInputMode.addEventListener('group-collapsing', () => {
  /* same for collapse operations */
})
mode.navigationInputMode.addEventListener('group-collapsed', () => {
  /* same for collapse operations */
})

Type Details

yFiles module: view

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 either sets the value directly or recursively sets properties to the instance of 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.

enterGroupPredicate - function(INode):boolean

A predicate that is queried to determine whether it is allowed to enter the specific group node. This option sets the enterGroupPredicate property on the created object.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

collapseGroupPredicate - function(INode):boolean

A predicate that is queried to determine whether it is allowed to collapse the specific group node. This option sets the collapseGroupPredicate property on the created object.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

expandGroupPredicate - function(INode):boolean

A predicate that is queried to determine whether it is allowed to expand the specific group node. This option sets the expandGroupPredicate property on the created object.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

exitGroupPredicate - function(INode):boolean

A predicate that is queried to determine whether it is allowed to exit the specific group node. This option sets the exitGroupPredicate property on the created object.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

toggleExpansionStatePredicate - function(INode):boolean

A predicate that is queried to determine whether it is allowed to toggle the collapsed state of the given group node. This option sets the toggleExpansionStatePredicate property on the created object.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

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.

navigablePredicate - function(IModelItem):boolean

A predicate that is queried to determine whether an item should be navigated to. This option sets the navigablePredicate property on the created object.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

selectablePredicate - function(IModelItem):boolean

A predicate that is queried to determine whether an item can be selected. This option sets the selectablePredicate property on the created object.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

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.

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: InteriorNodeLabelModel.TOP_RIGHT,
})

availableCommands

: ICollection<Command>

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

collapseGroupPredicate

: function(INode):boolean

Gets or sets a predicate that is queried to determine whether it is allowed to collapse the specific group node.

Remarks

The default value returns the result of the allowCollapseGroup property.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

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

enterGroupPredicate

: function(INode):boolean

Gets or sets a predicate that is queried to determine whether it is allowed to enter the specific group node.

Remarks

The default value returns the result of the allowEnterGroup property.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, 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.

exitGroupPredicate

: function(INode):boolean

Gets or sets a predicate that is queried to determine whether it is allowed to exit the specific group node.

Remarks

The default value returns the result of the allowExitGroup property.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

expandGroupPredicate

: function(INode):boolean

Gets or sets a predicate that is queried to determine whether it is allowed to expand the specific group node.

Remarks

The default value returns the result of the allowExpandGroup property.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

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.

Property Value

The graph.

graphComponent

: GraphComponent?

Gets or sets the graphComponent this mode acts on.

Property Value

The graphComponent.

graphSelection

: IGraphSelection?

Gets or sets the IGraphSelection this mode operates on.

Property Value

The graph selection.

navigableItems

: GraphItemTypes

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

Remarks

Since NavigationInputMode navigates using its parent input mode - either GraphEditorInputMode or GraphViewerInputMode - it is necessary to set additional properties when changing the value of this property:

focusableItems on GraphEditorInputMode or GraphViewerInputMode
selectableItems on GraphEditorInputMode or GraphViewerInputMode
selectableItems on this input mode.

Property Value

The navigable items.

Examples

Setting nodes and edges as navigable items:

Enabling navigation along nodes and edges

graphComponent.inputMode = new GraphEditorInputMode({
  focusableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  selectableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  navigationInputMode: {
    selectableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
    navigableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  },
})

To navigate along the same item type you started with, set the navigablePredicate as follows:

Enabling navigation along edges

mode.navigationInputMode.navigablePredicate = (item) =>
  GraphItemTypes.getItemType(graphComponent.currentItem) ==
  GraphItemTypes.getItemType(item)

navigablePredicate

: function(IModelItem):boolean

Gets or sets a predicate that is queried to determine whether an item should be navigated to.

Remarks

The default value returns the result of the navigableItems property for the given item.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

Examples

This predicate can also be used to navigate along items of the same type as the current item.

Enabling navigation along edges

mode.navigationInputMode.navigablePredicate = (item) =>
  GraphItemTypes.getItemType(graphComponent.currentItem) ==
  GraphItemTypes.getItemType(item)

parentInputModeContext

: IInputModeContext?

Retrieves the IInputModeContext this mode has been installed in.

Remarks

The value will be null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.

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 CanvasComponent. The lower the priority value, the earlier it will be installed. If two modes are using the same priority value, the first one to be registered 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.

To modify the items selectable by this mode, you also need to configure the navigableItems accordingly.

Examples

Setting nodes and edges as navigable items:

Enabling navigation along nodes and edges

graphComponent.inputMode = new GraphEditorInputMode({
  focusableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  selectableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  navigationInputMode: {
    selectableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
    navigableItems: GraphItemTypes.NODE | GraphItemTypes.EDGE,
  },
})

selectablePredicate

: function(IModelItem):boolean

Gets or sets a predicate that is queried to determine whether an item can be selected.

Remarks

The default value returns the result of the selectableItems property for the given item.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

toggleExpansionStatePredicate

: function(INode):boolean

Gets or sets a predicate that is queried to determine whether it is allowed to toggle the collapsed state of the given group node.

Remarks

The default value returns the result of the expandGroupPredicate respectively collapseGroupPredicate.

Signature Details

function(obj: INode) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - INode: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

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:

Property Value

true if the current item should be used as a fallback; false otherwise, which is the default.

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 true.

Methods

adjustContentBounds

()

Adjusts the contentBounds to encompass all elements.

Remarks

This implementation will try to delegate to adjustContentBounds if it can find the GraphEditorInputMode in the parentInputModeContext, otherwise updateContentBounds 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

()

Will be called to unconditionally cancel all ongoing edits.

Remarks

This will be called prior to the uninstalling of this instance and when other input modes temporarily acquire the mutex.

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 nodes.

createInputModeContext

() : IInputModeContext

Returns the input mode context that will be passed to implementations that are called by this instance and require a context.

Returns

↪IInputModeContext: A context to use for the implementations that are called by this instance.

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 nodes.

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 nodes.

extendSelectionTo

(direction: MoveFocusDirection)

Moves the focus in 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, startItem: IModelItem, direction: MoveFocusDirection, itemsToCheck: IEnumerable<IModelItem>) : IModelItem

Determines the nearest item in the given direction.

Remarks

The default implementation uses the Euclidean distance from the location of the startItem, 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.
startItem - IModelItem: The currently selected item reference location for the gesture.
direction - MoveFocusDirection: The direction for the move action.
itemsToCheck - IEnumerable<IModelItem>: The items that should be considered. Note that this will include startItem, but obviously this should not normally be returned, when other candidates are better matches.

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 contentBounds.

Remarks

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

getReferenceLocation

(item: IModelItem) : Point

Determines the reference location for a given IModelItem

Remarks

This method is used by findNearestItem to calculate distances between various item candidates.

Parameters

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

item - IModelItem: The item to get a reference location for.

Returns

↪Point: The reference location for the given item.

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 in 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 in 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.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupEntered

(evt: InputModeItemEventArgs<INode>)

Raises the group-entered event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupEntering

(evt: InputModeItemEventArgs<INode>)

Raises the group-entering event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupExited

(evt: InputModeItemEventArgs<INode>)

Raises the group-exited event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupExiting

(evt: InputModeItemEventArgs<INode>)

Raises the group-exiting event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupExpanded

(evt: InputModeItemEventArgs<INode>)

Raises the group-expanded event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> instance containing the event data.

onGroupExpanding

(evt: InputModeItemEventArgs<INode>)

Raises the group-expanding event.

Parameters

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

evt - InputModeItemEventArgs<INode>: The InputModeItemEventArgs<TModelItem> 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 Commands 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.

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.

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

'group-collapsed'

: function(InputModeItemEventArgs<INode>, this):void

Occurs whenever a group has been Collapsed.

'group-collapsing'

: function(InputModeItemEventArgs<INode>, this):void

Occurs before a group will be Collapsed.

'group-entered'

: function(InputModeItemEventArgs<INode>, this):void

Occurs whenever a group has been Entered.

'group-entering'

: function(InputModeItemEventArgs<INode>, this):void

Occurs before a group will be Entered.

'group-exited'

: function(InputModeItemEventArgs<INode>, this):void

Occurs whenever a group has been Exited.

'group-exiting'

: function(InputModeItemEventArgs<INode>, this):void

Occurs before a group will be Exited.

'group-expanded'

: function(InputModeItemEventArgs<INode>, this):void

Occurs whenever a group has been Expanded.

'group-expanding'

: function(InputModeItemEventArgs<INode>, this):void

Occurs before a group will be Expanded.

NavigationInputMode

Remarks

Examples

Type Details

Constructors

NavigationInputMode

ParametersOptions Overload

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

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

collapseGroupPredicate

Remarks

Signature Details

Parameters

Returns

controller

enabled

Remarks

Examples

enterGroupPredicate

Remarks

Signature Details

Parameters

Returns

exclusive

Remarks

exitGroupPredicate

Remarks

Signature Details

Parameters

Returns

expandGroupPredicate

Remarks

Signature Details

Parameters

Returns

fitContentAfterGroupActions

Remarks

graph