A handle for an edge when using InteractiveOrganicLayout in interactive use cases.
Inheritance Hierarchy
InteractiveOrganicEdgeHandle
Remarks
Before the layout starts, it uses the values of the handle as input for the edges, i.e. their preferred length. When the layout quits, it writes back the preferred length that the algorithm used to this instance. This might be important for the scenario that a layout is stopped and is resumed later.
Instances of InteractiveOrganicEdgeHandle can be queried via layout data property edgeHandles. Alternatively, when working only with the LayoutGraph API, see EDGE_HANDLE_DATA_KEY.
Type Details
- yFiles module
- algorithms
Properties
Gets or updates the preferred length of the given edge.
Remarks
This property can be used while layout calculation is in progress (interactive layout scenarios). However, the change will not directly be applied to the graph itself. To make sure that the layout algorithm is active, it can be woken up after scheduling this update.
Property Value
the preferred edge length