Search this API

y.layout
Interface LabelLayoutConstants

All Known Subinterfaces:
EdgeLabelLayout
All Known Implementing Classes:
EdgeLabel, EdgeLabelLayoutImpl, LabelLayoutData, PreferredPlacementDescriptor

public interface LabelLayoutConstants

LabelLayoutConstants defines options relevant for the automatic labeling process. It provides specifiers which define

The combination of several LabelLayoutConstants using a logical or-operation describes multiple valid locations for an edge label.

See Also:
PreferredPlacementDescriptor
 

Field Summary
static byte PLACE_ANYWHERE
          Preferred placement specifier for edge labels which expresses that the label can be placed anywhere along the edge or on any side of the edge.
static byte PLACE_AT_CENTER
          Preferred placement specifier for edge labels which expresses that the label should be placed near the center of the edge path.
static byte PLACE_AT_SOURCE
          Preferred placement specifier for edge labels which expresses that the label should be placed near the source node of an edge.
static byte PLACE_AT_SOURCE_PORT
          Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.
static byte PLACE_AT_TARGET
          Preferred placement specifier for edge labels which expresses that the label should be placed near the target node of an edge.
static byte PLACE_AT_TARGET_PORT
          Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.
static byte PLACE_LEFT_OF_EDGE
          Preferred placement specifier for edge labels which expresses that the label should be placed on the left hand side of the edge path.
static byte PLACE_ON_EDGE
          Preferred placement specifier for edge labels which expresses that the label should be placed on the path of the edge.
static byte PLACE_RIGHT_OF_EDGE
          Preferred placement specifier for edge labels which expresses that the label should be placed on the right hand side of the edge path.
static byte PLACEMENT_ALONG_EDGE_MASK
          Placement specifier mask that masks all placement specifiers that describe the placement along the edge.
static byte PLACEMENT_ON_SIDE_OF_EDGE_MASK
          Placement specifier mask that masks all placement specifiers that describe the side of the edge.
 

Field Detail

PLACE_AT_SOURCE

static final byte PLACE_AT_SOURCE
Preferred placement specifier for edge labels which expresses that the label should be placed near the source node of an edge.

See Also:
Constant Field Values
Sample Graph:

PLACE_AT_TARGET

static final byte PLACE_AT_TARGET
Preferred placement specifier for edge labels which expresses that the label should be placed near the target node of an edge.

See Also:
Constant Field Values
Sample Graph:

PLACE_AT_CENTER

static final byte PLACE_AT_CENTER
Preferred placement specifier for edge labels which expresses that the label should be placed near the center of the edge path.

See Also:
Constant Field Values
Sample Graph:

PLACE_AT_SOURCE_PORT

static final byte PLACE_AT_SOURCE_PORT
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.

 
Placement at the source port is currently only supported by IncrementalHierarchicLayouter when enabling integrated edge labeling.
See Also:
Constant Field Values
Sample Graph:

Source port label right of the edge

PLACE_AT_TARGET_PORT

static final byte PLACE_AT_TARGET_PORT
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.

 
Placement at the target port is currently only supported by IncrementalHierarchicLayouter when enabling integrated edge labeling.
See Also:
Constant Field Values
Sample Graph:

Target port label right of the edge

PLACEMENT_ALONG_EDGE_MASK

static final byte PLACEMENT_ALONG_EDGE_MASK
Placement specifier mask that masks all placement specifiers that describe the placement along the edge.

 
To determine the preferred placement along the edge, this mask can be used to hide the side specifiers that may also be encoded in the preferred placement.
See Also:
Constant Field Values

PLACE_ON_EDGE

static final byte PLACE_ON_EDGE
Preferred placement specifier for edge labels which expresses that the label should be placed on the path of the edge.

See Also:
Constant Field Values
Sample Graph:

PLACE_LEFT_OF_EDGE

static final byte PLACE_LEFT_OF_EDGE
Preferred placement specifier for edge labels which expresses that the label should be placed on the left hand side of the edge path.

The side is interpreted relative to the direction of the edge, if no different side reference is defined.

See Also:
Constant Field Values
Sample Graph:

PLACE_RIGHT_OF_EDGE

static final byte PLACE_RIGHT_OF_EDGE
Preferred placement specifier for edge labels which expresses that the label should be placed on the right hand side of the edge path.

The side is interpreted relative to the direction of the edge, if no different side reference is defined.

See Also:
Constant Field Values
Sample Graph:

PLACEMENT_ON_SIDE_OF_EDGE_MASK

static final byte PLACEMENT_ON_SIDE_OF_EDGE_MASK
Placement specifier mask that masks all placement specifiers that describe the side of the edge.

 
To determine the preferred side of the edge, this mask can be used to hide the placement specifiers that may also be encoded in the preferred placement.
See Also:
Constant Field Values

PLACE_ANYWHERE

static final byte PLACE_ANYWHERE
Preferred placement specifier for edge labels which expresses that the label can be placed anywhere along the edge or on any side of the edge.

See Also:
Constant Field Values

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.