com.yworks.yfiles.layout.organic

Enum InitialPlacement

java.lang.Object

java.lang.Enum<InitialPlacement>

com.yworks.yfiles.layout.organic.InitialPlacement

All Implemented Interfaces:

Serializable, Comparable<InitialPlacement>

public enum InitialPlacement
extends Enum<InitialPlacement>

Enum constants that specify the initial placement for the ClassicOrganicLayout.

See Also:

ClassicOrganicLayout.getInitialPlacement()

Enum Constant Summary

Enum Constants

Enum Constant and Description
AS_IS Initial placement strategy for starting with the node locations as they are in the input graph.
RANDOM Initial placement strategy for starting with randomly chosen node locations.
ZERO Initial placement strategy for starting with all node location coordinates set to 0.

Method Summary

Modifier and Type	Method and Description
static InitialPlacement	fromOrdinal(int ordinal)
int	value()
static InitialPlacement	valueOf(String name) Returns the enum constant of this type with the specified name.
static InitialPlacement[]	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

AS_IS

public static final InitialPlacement AS_IS

Initial placement strategy for starting with the node locations as they are in the input graph.

This strategy is best if the existing layout should change as little as possible.

See Also:

ClassicOrganicLayout.setInitialPlacement(InitialPlacement)

RANDOM

public static final InitialPlacement RANDOM

Initial placement strategy for starting with randomly chosen node locations.

See Also:

ClassicOrganicLayout.setInitialPlacement(InitialPlacement)

ZERO

public static final InitialPlacement ZERO

Initial placement strategy for starting with all node location coordinates set to 0.

This strategy is best if the initial placement should be maximally neutral, ignoring the existing layout of the input graph.

See Also:

ClassicOrganicLayout.setInitialPlacement(InitialPlacement)

Method Detail

fromOrdinal

public static final InitialPlacement fromOrdinal(int ordinal)

value

public int value()

valueOf

public static InitialPlacement 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 InitialPlacement[] 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 (InitialPlacement c : InitialPlacement.values())
    System.out.println(c);

Returns:

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