org.cytoscape.view.layout

Interface CyLayoutAlgorithmManager

public interface CyLayoutAlgorithmManager

This class provides access to the available layout algorithms.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: layout-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>layout-api</artifactId>
</dependency>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LAYOUT_NAME The name of the default layout.
static String	DEFAULT_LAYOUT_PROPERTY_NAME The name of the default layout property.

Method Summary

Modifier and Type	Method and Description
Collection<CyLayoutAlgorithm>	getAllLayouts() Returns a collection of all available layouts.
CyLayoutAlgorithm	getDefaultLayout() Returns Cytoscape's default layout.
CyLayoutAlgorithm	getLayout(String name) Returns a layout algorithm of the specified name and null if no algorithm exists with that name.
CyLayoutAlgorithm	setDefaultLayout(CyLayoutAlgorithm layout) Changes Cytoscape's default layout.

Field Detail

DEFAULT_LAYOUT_NAME

static final String DEFAULT_LAYOUT_NAME

The name of the default layout.

See Also:

Constant Field Values

DEFAULT_LAYOUT_PROPERTY_NAME

static final String DEFAULT_LAYOUT_PROPERTY_NAME

The name of the default layout property.

See Also:

Constant Field Values

Method Detail

getLayout

CyLayoutAlgorithm getLayout(String name)

Returns a layout algorithm of the specified name and null if no algorithm exists with that name.

Parameters:

name - The name of the algorithm.

Returns:

a layout algorithm of the specified name and null if no algorithm exists with that name.

getAllLayouts

Collection<CyLayoutAlgorithm> getAllLayouts()

Returns a collection of all available layouts.

Returns:

a collection of all available layouts.

getDefaultLayout

CyLayoutAlgorithm getDefaultLayout()

Returns Cytoscape's default layout.

Returns:

the default layout.

setDefaultLayout

CyLayoutAlgorithm setDefaultLayout(CyLayoutAlgorithm layout)

Changes Cytoscape's default layout.

Parameters:

layout - The new default algorithm