com.yworks.yfiles.layout.radial

Enum CenterNodesPolicy

java.lang.Object

java.lang.Enum<CenterNodesPolicy>

com.yworks.yfiles.layout.radial.CenterNodesPolicy

All Implemented Interfaces:

Serializable, Comparable<CenterNodesPolicy>

public enum CenterNodesPolicy
extends Enum<CenterNodesPolicy>

See Also:

RadialLayout.getCenterNodesPolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTRALITY Specifier for a center nodes policy which chooses the node with the highest centrality as center node.
CUSTOM Specifier for a center nodes policy which uses center nodes specified by the user.
DIRECTED Specifier for a center nodes policy which chooses all nodes with in-degree equal to 0 as center nodes.
WEIGHTED_CENTRALITY Specifier for a center nodes policy which chooses the node with the highest weighted centrality as center node.

Method Summary

Modifier and Type	Method and Description
static CenterNodesPolicy	fromOrdinal(int ordinal)
int	value()
static CenterNodesPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static CenterNodesPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CENTRALITY

public static final CenterNodesPolicy CENTRALITY

Specifier for a center nodes policy which chooses the node with the highest centrality as center node.

See Also:

RadialLayout.getCenterNodesPolicy(), Trees.getCenterRoot(com.yworks.yfiles.algorithms.Graph)

CUSTOM

public static final CenterNodesPolicy CUSTOM

Specifier for a center nodes policy which uses center nodes specified by the user. The center nodes have to be specified using a IDataProvider registered with the according key. The IDataProvider returns true for nodes that should be placed in the center.

If there exists more than one center node, they will be placed on the innermost circle while the center position stays empty.

See Also:

RadialLayout.getCenterNodesPolicy(), RadialLayout.getCenterNodesDpKey()

DIRECTED

public static final CenterNodesPolicy DIRECTED

Specifier for a center nodes policy which chooses all nodes with in-degree equal to 0 as center nodes. If no node with this property is present, an arbitrary node will be selected.

See Also:

RadialLayout.getCenterNodesPolicy(), Trees.getRoot(com.yworks.yfiles.algorithms.Graph)

WEIGHTED_CENTRALITY

public static final CenterNodesPolicy WEIGHTED_CENTRALITY

Specifier for a center nodes policy which chooses the node with the highest weighted centrality as center node.

See Also:

RadialLayout.getCenterNodesPolicy(), Trees.getWeightedCenterNode(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.INodeMap)

Method Detail

fromOrdinal

public static final CenterNodesPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static CenterNodesPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static CenterNodesPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CenterNodesPolicy c : CenterNodesPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared