LabelCandidateDescriptor

Show usages

A mutable implementation of the ILabelCandidateDescriptor interface.

Inheritance Hierarchy

LabelCandidateDescriptor

Implemented Interfaces

ILabelCandidateDescriptor

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.graph.LabelCandidateDescriptor

Constructors

LabelCandidateDescriptor

()

Creates a new instance of a LabelCandidateDescriptor with the default values.

ParametersOptions Overload

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

externalCandidate - boolean
edgeOverlapPenalty - number
nodeOverlapPenalty - number
profit - number

Properties

edgeOverlapPenalty

: number

Gets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.

Remarks

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Implements

ILabelCandidateDescriptor

externalCandidate

: boolean

Gets a value indicating whether this candidate is deemed an external candidate.

Remarks

This is mainly for INode labels that are a visual part of the node's internals. It could be used for edge labels, too, if the edge occupies significant amounts of visual space.

Implements

ILabelCandidateDescriptor

nodeOverlapPenalty

: number

Gets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.

Remarks

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Implements

ILabelCandidateDescriptor

profit

: number

Gets a profit value that is used by labeling algorithms to judge how good this label candidate is.

Remarks

This value must be between 0 and 1 (inclusive). Higher profit means better candidates. Hence, there is a higher probability that the candidate is chosen by a labeling algorithm.

Implements

ILabelCandidateDescriptor

Constants

EXTERNAL_DESCRIPTOR

: ILabelCandidateDescriptor

A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields true for the externalCandidate property.

INTERNAL_DESCRIPTOR

: ILabelCandidateDescriptor

A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields false for the externalCandidate property.