Enum Class LayoutUtil.DefaultLayout

java.lang.Object

java.lang.Enum<LayoutUtil.DefaultLayout>

edu.cmu.tetrad.graph.LayoutUtil.DefaultLayout

All Implemented Interfaces:

Serializable, Comparable<LayoutUtil.DefaultLayout>, Constable

Enclosing class:

LayoutUtil

public static enum LayoutUtil.DefaultLayout
extends Enum<LayoutUtil.DefaultLayout>

The layouts that can serve as the default layout: the ones that need nothing but the graph. See LayoutUtil.setDefaultLayout(DefaultLayout).

Version:

$Id: $Id

Author:

josephramsey

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAUSAL_ORDER	Rows by causal order; see LayoutUtil.layoutByCausalOrder(Graph, NodeSize).
CIRCLE	The circle; see LayoutUtil.circleLayout(Graph, NodeSize).
FRUCHTERMAN_REINGOLD	Fruchterman-Reingold; see LayoutUtil.FruchtermanReingoldLayout.
KAMADA_KAWAI	Kamada-Kawai, with its standard parameters (natural edge length 80, spring constant 0.2, stop energy 1, not randomly initialized); see LayoutUtil.kamadaKawaiLayout(Graph, boolean, double, double, double).
RICHARDS	Richard's layout; see LayoutUtil.richardsLayout(Graph, NodeSize).
SQUARE	The square; see LayoutUtil.squareLayout(Graph).

Method Summary

Modifier and Type	Method	Description
static LayoutUtil.DefaultLayout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LayoutUtil.DefaultLayout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RICHARDS

public static final LayoutUtil.DefaultLayout RICHARDS

Richard's layout; see LayoutUtil.richardsLayout(Graph, NodeSize).

CIRCLE

public static final LayoutUtil.DefaultLayout CIRCLE

The circle; see LayoutUtil.circleLayout(Graph, NodeSize).

SQUARE

public static final LayoutUtil.DefaultLayout SQUARE

The square; see LayoutUtil.squareLayout(Graph).

FRUCHTERMAN_REINGOLD

public static final LayoutUtil.DefaultLayout FRUCHTERMAN_REINGOLD

Fruchterman-Reingold; see LayoutUtil.FruchtermanReingoldLayout.

KAMADA_KAWAI

public static final LayoutUtil.DefaultLayout KAMADA_KAWAI

Kamada-Kawai, with its standard parameters (natural edge length 80, spring constant 0.2, stop energy 1, not randomly initialized); see LayoutUtil.kamadaKawaiLayout(Graph, boolean, double, double, double).

CAUSAL_ORDER

public static final LayoutUtil.DefaultLayout CAUSAL_ORDER

Rows by causal order; see LayoutUtil.layoutByCausalOrder(Graph, NodeSize).

Method Details

values

public static LayoutUtil.DefaultLayout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LayoutUtil.DefaultLayout valueOf(String name)

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null