Transformation

Controller for an individual transformation on the graph, such as grouping, filtering etc.

transformation.destroy()

Remove the transformation. After this method is called, the transformation is not manipulable anymore (cannot be enabled again for example).

Returns

• Promise<void>

transformation.disable([animate])

Disable the transformation.

Arguments

• animate(optional) boolean Whether to animate this operation

Returns

• Promise<void>

transformation.enable([animate])

Enable the transformation.

Arguments

• animate(optional) boolean Whether to animate this operation

Returns

• Promise<void>

transformation.getId()

Returns the id of the transformation, a unique strictly positive integer.

Returns

• number

transformation.getIndex()

Retrieves the index of the transformation in the pipeline.

Returns

• number

transformation.getName()

Returns the name of the transformation.

Returns

• "node-filter"|"edge-filter"|"node-grouping"|"edge-grouping"

transformation.isEnabled()

Returns true if the transformation is currently enabled

Returns

• boolean

transformation.refresh()

Refresh the transformation.

Returns

• Promise<void>

transformation.setIndex(index)

Set the index of the transformation in the pipeline. The transformation with the lower index is applied first, the one with the higher index is applied last.

Arguments

• index

Returns

• Promise<void>

transformation.setOptions(index)

Set the index of the transformation in the pipeline. The transformation with the lower index is applied first, the one with the higher index is applied last.

Arguments

• index

Returns

• Promise<void>

transformation.toggle([animate])

Toggle the transformation.

Arguments

• animate(optional) boolean Whether to animate this operation

Returns

• Promise<void>

transformation.whenApplied()

Returns a Promise that resolves the first time the transformation is applied.

Returns

• Promise<void>