Defines how a label placement algorithm should place edge labels.
Examples
Used with LayoutExecutor's labelPreferredPlacementPolicy.Keep the current label placement
const layout = new HierarchicLayout({ integratedEdgeLabeling: true })
await new LayoutExecutor({
graphComponent: graphComponent,
graph: graphComponent.graph,
layout: layout,
labelPreferredPlacementPolicy: 'from-parameter'
}).start()Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.layout.LabelPreferredPlacementPolicy
Constants
Edge labels will be placed as defined by their PreferredPlacementDescriptor.
Remarks
The PreferredPlacementDescriptor is defined per-edge on preferredPlacementDescriptor or a similar property on LayoutData for layout algorithms which support automatic label placement.
If no PreferredPlacementDescriptor is assigned edge labels will be placed without any restrictions.
Edge labels will be placed in a way that is supported by the model of their current layoutParameter.
Edge labels will be placed near their current position.
Static Methods
Converts the argument to LabelPreferredPlacementPolicy.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - LabelPreferredPlacementPolicy
- The value to convert to LabelPreferredPlacementPolicy.
Returns
- ↪LabelPreferredPlacementPolicy
- Either
valueif it is already a LabelPreferredPlacementPolicy or an appropriate converted value.