All versions of this documentation
X

Ogma

Ogma.transformations

Transformations allow to change the structure of the graph based on rules. For example, a grouping transformation can group together nodes that share the same country data property: nodes that compose the groups are virtually removed from the graph (they can still be manipulated via the API but are not visible anymore) and new nodes, which represent the groups, are added to the graph. These new nodes can be manipulated like regular nodes but cannot be removed. Nodes and edges that are created this way are called "virtual".

There are currently two types of transformations: groups and filters. Filters hide nodes/edges based on a criteria.

Multiple transformations can be applied at once, in which case they are applied one after another. For example you can filter, group and then filter again based on the result of the grouping.

Transformations are automatically updated in the following cases:

When transformations are updated, all transformations are undone and then run again. Transformation updates are batched, making sure multiple events that trigger an update will only result in one single update.

Ogma.events

Ogma.export

Ogma.generate

Ogma.geo

Ogma.keyboard

Ogma.layouts

Ogma.parse

Ogma.pathfinding

Ogma.rules

Ogma.schema

Ogma.styles

Ogma.tools

Ogma.tools.brand

Ogma.tools.connectNodes

Ogma.tools.lasso

Ogma.tools.legend

Ogma.tools.rectangleSelect

Ogma.tools.resize

Ogma.tools.rewire

Ogma.tools.snapping

Ogma.tools.tooltip

Ogma.view

Node

Edge

NodeList

EdgeList

NodeRule

Retrieved from ogma.styles.addNodeRule.

EdgeRule

Retrieved from ogma.styles.addEdgeRule.

Transformation

PropertyInformation

Retrieved from watcher.getPropertyInfo().

ObjectPropertyWatcher

Retrieved from ogma.schema.watchNodeProperties() or ogma.schema.watchEdgeProperties().

NonObjectPropertyWatcher

Retrieved from ogma.schema.watchNodeNonObjectProperty() or ogma.schema.watchEdgeNonObjectProperty().

Other types