E

LabelPlacementPolicy

Show Usages
Defines how a label placement algorithm should place labels.

Remarks

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()

Members

No filters for this type

Constants

KEEP_PARAMETER

static
Labels will retain their original ILabelModelParameter.
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.
static

PREFER_MODEL

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

PREFER_PARAMETER

static
Edge labels will be placed near the position specified by their current layoutParameter.
This setting is equivalent to PREFER_MODEL for node labels.
static

See Also

Developer's Guide

Static Methods

from

(value: LabelPlacementPolicy): LabelPlacementPolicy
static
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

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

Return Value

LabelPlacementPolicy
The enum constant that corresponds to the given argument.

getName

(value: LabelPlacementPolicy): string
static
Returns the name of the given enum constant.
static

Parameters

value: LabelPlacementPolicy
The numeric value of an enum constant.

Return Value

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.