YFilesView

Labels: :IA_Function:IA_YFilesView
Inherits from: Function and View

The YFilesView Function renders a visualisation of a graph using yFiles diagramming components.

Parameters

Key Description Default value Possible values
autoCompleteStatus Automatically retrieves missing relations between nodes. false true|false 0|1
container.height Sets the view height. 1000 Numeric
container.width Sets the view width. 500 Numeric
generateGroups Simplified parameter for creating groups.* [] Object with, for each key, an array of node objects
groups Array of groups to be visualized. [] Array of group objects
layout Sets the default layout type. organic organic, hierarchic, tree, orthogonal, circular, radial, seriesparallel, partial, singlecycle, recursiveshuffle, compactorthogonal, balloon, classictree, aspectratiotree
layouts Sets the list of the usable style types. undefined organic, hierarchic, tree, orthogonal, circular, radial, seriesparallel, partial, singlecycle, recursiveshuffle, compactorthogonal, balloon, classictree, aspectratiotree
name Name of the view.
nodes The array of nodes to be visualized. [] Array of node objects
relations The array of relations to be visualized. [] Array of relation objects
showOverview Displays overview box false true false
store Sets the default store for the NetworkView. application name of configured Neo4j store
state.selected.nodes Array of nodes that is selected. [] Array of node objects
state.selected.relations Array of relations that is selected. [] Array of relation objects

* The generateGroups parameter will generate group objects that will be set in groups. It is write-only, updated groups from groups will not appear in generateGroups.

Outgoing triggers

Type: nodeClick

Occurrence: When the user clicks a node.

Additional event properties (besides the inherited properties):

Key Description Possible values
data The clicked node. node object
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: nodeDoubleClick

Occurrence: When the user double-clicks a node.

Additional event properties (besides the inherited properties):

Key Description Possible values
data The double-clicked node. node object
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: relationClick

Occurrence: When the user clicks a relation.

Additional event properties (besides the inherited properties):

Key Description Possible values
data The clicked relation relation object
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: relationDoubleClick

Occurrence: When the user double-clicks a relation.

Additional event properties (besides the inherited properties):

Key Description Possible values
data The double-clicked relation. relation object
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: canvasClick

Occurrence: When the user clicks an empty space in the graph.

Additional event properties (besides the inherited properties):

Key Description Possible values
position The clicked position object {x: number, y: number}
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: canvasDoubleClick

Occurrence: When the user double-clicks an empty space in the graph.

Additional event properties (besides the inherited properties):

Key Description Possible values
position The double-clicked position object {x: number, y: number}
keyPressed Map of keys that are pressed during the click. object
keyPressed.ctrl Control button pressed during click. true|false
keyPressed.shift Shift button pressed during click. true|false
keyPressed.meta Meta button (Apple Command or Windows button) pressed during click true|false

Type: context

The following context menus are available from the NetworkView:

Menu Occurs when Target value
node User right-clicks a node Right-clicked node object
relation User right-clicks a relation Right-clicked relation object
canvas User right-clicks an empty space Position object {x: number, y: number}

More info on context menus.