LabelPlacementPolicy

Defines how a label placement algorithm should place labels.

Examples

Used with LayoutExecutor's labelPlacementPolicies.

Keep the current label placement

const layout = new HierarchicalLayout({
  edgeLabelPlacement: EdgeLabelPlacement.INTEGRATED,
})
await new LayoutExecutor({
  graphComponent: graphComponent,
  layout: layout,
  labelPlacementPolicies: LabelPlacementPolicy.PREFER_PARAMETER,
}).start()

Type Details

yFiles module: view-layout-bridge

Constants

KEEP_PARAMETER

: number

Labels will retain their original ILabelModelParameter.

Remarks

If this policy is selected for a label, any changes made to its position by the executed layout are discarded and the label position is instead calculated based on the existing ILabelModelParameter and the updated position of the label's owner.

PREFER_MODEL

: number

Labels will be placed in a way that is supported by the model of their current layoutParameter.

PREFER_PARAMETER

: number

Edge labels will be placed near the position specified by their current layoutParameter.

Remarks

This setting is equivalent to PREFER_MODEL for node labels.

Static Methods

from

(value: LabelPlacementPolicy) : LabelPlacementPolicy

Converts the given argument to an enum constant of this enum type.

Remarks

Most notably, this method can convert an enum constant's name into the enum constant itself.

Parameters

options - Object
A map of options to pass to the method.

value - LabelPlacementPolicy: The value to convert to an enum constant.

Returns

↪LabelPlacementPolicy: The enum constant that corresponds to the given argument.

getName

(value: LabelPlacementPolicy) : string

Returns the name of the given enum constant.

Parameters

options - Object
A map of options to pass to the method.

value - LabelPlacementPolicy: The numeric value of an enum constant.

Returns

↪string: The name of the enum constant.

Throws

Exception({ name: 'Error' }): If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.