Package org.cytoscape.view.layout

Enum Class WeightTypes

java.lang.Object
java.lang.Enum<WeightTypes>
org.cytoscape.view.layout.WeightTypes
All Implemented Interfaces:
Serializable, Comparable<WeightTypes>, java.lang.constant.Constable
public enum WeightTypes extends Enum<WeightTypes>
An enum describing different weighting strategies.

Cytoscape Backwards Compatibility (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

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>

  • Enum Constant Details

    • GUESS

      public static final WeightTypes GUESS
      Use a heuristic to guess.

    • LOG

      public static final WeightTypes LOG
      Use the negative log value.

    • DISTANCE

      public static final WeightTypes DISTANCE
      Use 1 minus the normalized value.

    • WEIGHT

      public static final WeightTypes WEIGHT
      Use the normalized value.

  • Method Details

    • values

      public static WeightTypes[] 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 WeightTypes 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

    • toString

      public String toString()
      Returns the name of the weighting type.
      Overrides:
      toString in class Enum<WeightTypes>
      Returns:
      the name of the weighting type.