Transformation

transformation.destroy([duration])

Remove the transformation over the specified amount of time. After this methods is called, the transformation is not manipulable anymore (cannot be enabled again for example). Note: the animation will not be played if the transformation is not the last in the transformation stack, because the transformations are sequential

Arguments

• duration(optional) number[=0] Animation duration in ms

Returns

• Promise<void>

transformation.disable([duration])

Disable the transformation over the specified amount of time.

Arguments

• duration(optional) number[=0] Animation duration in ms

Returns

• Promise<void>

transformation.enable([duration])

Enable the transformation over the specified amount of time.

Arguments

• duration(optional) number[=0] Animation duration in ms

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([duration])

Toggle the transformation over the specified amount of time.

Arguments

• duration(optional) number[=0] Animation duration in ms

Returns

• Promise<void>

transformation.whenApplied()

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

Returns

• Promise<void>