Package org.cytoscape.view.presentation.property

Class BasicVisualLexicon

java.lang.Object
org.cytoscape.view.presentation.property.AbstractVisualLexicon
org.cytoscape.view.presentation.property.BasicVisualLexicon
All Implemented Interfaces:
VisualLexicon
public class BasicVisualLexicon extends AbstractVisualLexicon
Basic Implementation of VisualLexicon.

Module: presentation-api

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

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

  • Field Details

    • NETWORK

      public static final VisualProperty<Visualizable> NETWORK

    • NODE

      public static final VisualProperty<Visualizable> NODE

    • EDGE

      public static final VisualProperty<Visualizable> EDGE

    • NODE_PAINT

      public static final VisualProperty<Paint> NODE_PAINT
      The color of the whole node, including its border, label and selected paint.

      Property Type: Color

      Property Range: A non-null color

    • NODE_FILL_COLOR

      public static final VisualProperty<Paint> NODE_FILL_COLOR
      The color of the node.

      Property Type: Color

      Property Range: A non-null color

    • NODE_LABEL_COLOR

      public static final VisualProperty<Paint> NODE_LABEL_COLOR
      The color of the node label.

      Property Type: Color

      Property Range: A non-null color

    • NODE_LABEL

      public static final VisualProperty<String> NODE_LABEL
      The text used for the node label.

      Property Type: String

      Property Range: Any string

    • NODE_X_LOCATION

      public static final VisualProperty<Double> NODE_X_LOCATION
      X location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NODE_Y_LOCATION

      public static final VisualProperty<Double> NODE_Y_LOCATION
      Y location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NODE_SIZE

      public static final VisualProperty<Double> NODE_SIZE
      The size of the node. Width and height will be equal. This property is mutually exclusive of Node Height and Node Width.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NODE_WIDTH

      public static final VisualProperty<Double> NODE_WIDTH
      The width of the node. Width will be independent of height. This property is mutually exclusive of Node Size.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NODE_HEIGHT

      public static final VisualProperty<Double> NODE_HEIGHT
      The height of the node. Height will be independent of width. This property is mutually exclusive of Node Size.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NODE_VISIBLE

      public static final VisualProperty<Boolean> NODE_VISIBLE
      Hides the node if set to false. By default, this value is set to true.

      Property Type: Boolean

      Property Range: true or false

    • NODE_SELECTED

      public static final VisualProperty<Boolean> NODE_SELECTED
      TODO Documentation

      Property Type: Boolean

      Property Range: true or false

    • NODE_NESTED_NETWORK_IMAGE_VISIBLE

      public static final VisualProperty<Boolean> NODE_NESTED_NETWORK_IMAGE_VISIBLE
      A boolean value that indicates whether a nested network should be visualized (assuming a nested network is present for the specified node).

      Property Type: Boolean

      Property Range: true or false

    • NODE_LABEL_WIDTH

      public static final VisualProperty<Double> NODE_LABEL_WIDTH
      The maximum width of the node label. If the node label is wider than the specified width, Cytoscape will automatically wrap the label on space characters. Cytoscape will not hyphenate words, meaning that if a single word (i.e. no spaces) is longer than maximum width, the word will be displayed beyond the maximum width.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NODE_LABEL_POSITION

      public static final VisualProperty<ObjectPosition> NODE_LABEL_POSITION
      The anchor point on the node relative to which the node label will be positioned. Includes the anchor point of the target, the justification, and an x,y offset.

      Property Type: ObjectPosition

      Property Range: A non-null ObjectPosition value.

    • NODE_LABEL_ROTATION

      public static final VisualProperty<Double> NODE_LABEL_ROTATION
      A value used to rotate the node label about its center, in degrees.

      Property Type: Double

      Property Range: -360 <= value <= 360

    • NODE_SELECTED_PAINT

      public static final VisualProperty<Paint> NODE_SELECTED_PAINT
      The color of the node when it is in the selected state.

      Property Type: Color

      Property Range: A non-null color

    • NODE_BORDER_PAINT

      public static final VisualProperty<Paint> NODE_BORDER_PAINT
      The color of the border of the node.

      Property Type: Color

      Property Range: A non-null color

    • NODE_BORDER_WIDTH

      public static final VisualProperty<Double> NODE_BORDER_WIDTH
      TODO Documentation

      Property Type: Double

      Property Range: 0 <= value <= Double.POSITIVE_INFINITY

    • NODE_TOOLTIP

      public static final VisualProperty<String> NODE_TOOLTIP
      The text of the tooltip that appears when a mouse hovers over the node.

      Property Type: String

      Property Range: Any string

    • NODE_LABEL_FONT_FACE

      public static final VisualProperty<Font> NODE_LABEL_FONT_FACE
      The font used for the node label.

      Property Type: Font

      Property Range: Any font available in the local graphics environment

    • NODE_LABEL_FONT_SIZE

      public static final VisualProperty<Integer> NODE_LABEL_FONT_SIZE
      The size of the font used for the node label.

      Property Type: Integer

      Property Range: 1 <= value <= Integer.MAX_VALUE

    • NODE_TRANSPARENCY

      public static final VisualProperty<Integer> NODE_TRANSPARENCY
      The opacity of the color of the node. Zero means totally transparent, and 255 means totally opaque.

      Property Type: Integer

      Property Range: 0 <= value <= 255

    • NODE_OPACITY

      public static final VisualProperty<Integer> NODE_OPACITY
      See Also:
      NODE_TRANSPARENCY

    • NODE_BORDER_TRANSPARENCY

      public static final VisualProperty<Integer> NODE_BORDER_TRANSPARENCY
      TODO Documentation

      Property Type: Integer

      Property Range: 0 <= value <= 255

    • NODE_LABEL_TRANSPARENCY

      public static final VisualProperty<Integer> NODE_LABEL_TRANSPARENCY
      TODO Documentation

      Property Type: Integer

      Property Range: 0 <= value <= 255

    • NODE_SHAPE

      public static final VisualProperty<NodeShape> NODE_SHAPE
      The shape of the node.

      Additional Details: NodeShapeVisualProperty

    • NODE_BORDER_LINE_TYPE

      public static final VisualProperty<LineType> NODE_BORDER_LINE_TYPE
      The type of line used for the border of the node.

      Additional Details: LineTypeVisualProperty

    • EDGE_PAINT

      public static final VisualProperty<Paint> EDGE_PAINT
      The color of the whole edge (including the stroke and arrows) when it is selected or unselected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_LABEL_COLOR

      public static final VisualProperty<Paint> EDGE_LABEL_COLOR
      TODO Documentation

      Property Type: Color

      Property Range: A non-null color

    • EDGE_LABEL

      public static final VisualProperty<String> EDGE_LABEL
      The text used for the edge label.

      Property Type: String

      Property Range: Any string

    • EDGE_WIDTH

      public static final VisualProperty<Double> EDGE_WIDTH
      The width of the edge line.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • EDGE_VISIBLE

      public static final VisualProperty<Boolean> EDGE_VISIBLE
      Hides the edge if set to false. By default, this value is set to true.

      Property Type: Boolean

      Property Range: true or false

    • EDGE_SELECTED

      public static final VisualProperty<Boolean> EDGE_SELECTED
      TODO Documentation

      Property Type: Boolean

      Property Range: true or false

    • EDGE_LINE_TYPE

      public static final VisualProperty<LineType> EDGE_LINE_TYPE
      The type of stoke used to render the line (solid, dashed, etc.)

      Additional Details: LineTypeVisualProperty

    • EDGE_TOOLTIP

      public static final VisualProperty<String> EDGE_TOOLTIP
      The text of the tooltip that appears when a mouse hovers over the edge.

      Property Type: String

      Property Range: Any string

    • EDGE_LABEL_FONT_FACE

      public static final VisualProperty<Font> EDGE_LABEL_FONT_FACE
      The font used for the edge label.

      Property Type: Font

      Property Range: Any font available in the local graphics environment

    • EDGE_LABEL_FONT_SIZE

      public static final VisualProperty<Integer> EDGE_LABEL_FONT_SIZE
      The size of the font used for the edge label.

      Property Type: Integer

      Property Range: 1 <= value <= Integer.MAX_VALUE

    • EDGE_LABEL_TRANSPARENCY

      public static final VisualProperty<Integer> EDGE_LABEL_TRANSPARENCY
      The opacity of the color of the edge label. Zero means totally transparent, and 255 means totally opaque.

      Property Type: Integer

      Property Range: 0 <= value <= 255

    • EDGE_SELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_SELECTED_PAINT
      The color of the whole edge (stroke and arrows) when selected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_UNSELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_UNSELECTED_PAINT
      The color of the whole edge (stroke and arrows) when it is not selected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_STROKE_SELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_STROKE_SELECTED_PAINT
      The color of the edge line when selected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_STROKE_UNSELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_STROKE_UNSELECTED_PAINT
      The color of the edge line.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_TRANSPARENCY

      public static final VisualProperty<Integer> EDGE_TRANSPARENCY
      The opacity of the of the edge. Zero means totally transparent, and 255 means totally opaque.

      Property Type: Integer

      Property Range: 0 <= value <= 255

    • EDGE_SOURCE_ARROW_SHAPE

      public static final VisualProperty<ArrowShape> EDGE_SOURCE_ARROW_SHAPE
      The shape of the arrow on the source node end of the edge.

      Additional Details: ArrowShapeVisualProperty

    • EDGE_TARGET_ARROW_SHAPE

      public static final VisualProperty<ArrowShape> EDGE_TARGET_ARROW_SHAPE
      The shape of the arrow on the target node end of the edge.

      Additional Details: ArrowShapeVisualProperty

    • EDGE_SOURCE_ARROW_SIZE

      public static final VisualProperty<Double> EDGE_SOURCE_ARROW_SIZE
      TODO Documentation

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • EDGE_TARGET_ARROW_SIZE

      public static final VisualProperty<Double> EDGE_TARGET_ARROW_SIZE
      TODO Documentation

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • EDGE_SOURCE_ARROW_SELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_SOURCE_ARROW_SELECTED_PAINT
      The color of the edge source arrow when selected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_TARGET_ARROW_SELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_TARGET_ARROW_SELECTED_PAINT
      The color of the edge target arrow when selected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_SOURCE_ARROW_UNSELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_SOURCE_ARROW_UNSELECTED_PAINT
      The color of the edge source arrow when unselected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_TARGET_ARROW_UNSELECTED_PAINT

      public static final VisualProperty<Paint> EDGE_TARGET_ARROW_UNSELECTED_PAINT
      The color of the edge target arrow when unselected.

      Property Type: Color

      Property Range: A non-null color

    • EDGE_LABEL_ROTATION

      public static final VisualProperty<Double> EDGE_LABEL_ROTATION
      A value used to rotate the edge label about its center, in degrees.

      Property Type: Double

      Property Range: -360 <= value <= 360

    • EDGE_BEND

      public static final EdgeBendVisualProperty EDGE_BEND
      If Edge Bend is defined, edges will be rendered as straight or curved lines. If this value is set to true, edges will be drawn as curved lines.

    • EDGE_LABEL_WIDTH

      public static final VisualProperty<Double> EDGE_LABEL_WIDTH
      TODO Documentation

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • EDGE_STACKING

      public static final VisualProperty<EdgeStacking> EDGE_STACKING
      The strategy to use to render edges when there are more than one edge between a pair of nodes.

      Additional Details: EdgeStackingVisualProperty

    • EDGE_STACKING_DENSITY

      public static final VisualProperty<Double> EDGE_STACKING_DENSITY
      Controls how tightly packed edges are when there are more than one edge between a pair of nodes.

    • EDGE_Z_ORDER

      public static final VisualProperty<Double> EDGE_Z_ORDER
      When rendering edges in 2D, edges with a higher Z-order will be rendered on top of edges with lower Z-order. If two edges overlap and have the same Z-order then the order they are rendered in is unpredictable.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NETWORK_SCALE_FACTOR

      public static final VisualProperty<Double> NETWORK_SCALE_FACTOR
      The zoom level of the network view.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NETWORK_CENTER_X_LOCATION

      public static final VisualProperty<Double> NETWORK_CENTER_X_LOCATION
      The X location of network view center.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NETWORK_CENTER_Y_LOCATION

      public static final VisualProperty<Double> NETWORK_CENTER_Y_LOCATION
      The Y location of network view center.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NETWORK_SIZE

      public static final VisualProperty<Double> NETWORK_SIZE
      The size (width and height) of the network view.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NETWORK_WIDTH

      public static final VisualProperty<Double> NETWORK_WIDTH
      The width of the network view.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NETWORK_HEIGHT

      public static final VisualProperty<Double> NETWORK_HEIGHT
      The height of the network view.

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NETWORK_TITLE

      public static final VisualProperty<String> NETWORK_TITLE
      The title of the network view.

      Property Type: String

      Property Range: Any string

    • NETWORK_BACKGROUND_PAINT

      public static final VisualProperty<Paint> NETWORK_BACKGROUND_PAINT
      The background color of the network view.

      Property Type: Color

      Property Range: A non-null color

    • NODE_Z_LOCATION

      public static final VisualProperty<Double> NODE_Z_LOCATION
      Z location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NODE_DEPTH

      public static final VisualProperty<Double> NODE_DEPTH
      TODO Documentation

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

    • NETWORK_CENTER_Z_LOCATION

      public static final VisualProperty<Double> NETWORK_CENTER_Z_LOCATION
      TODO Documentation

      Property Type: Double

      Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY

    • NETWORK_DEPTH

      public static final VisualProperty<Double> NETWORK_DEPTH
      TODO Documentation

      Property Type: Double

      Property Range: 0 < value <= Double.POSITIVE_INFINITY

  • Constructor Details

    • BasicVisualLexicon

      public BasicVisualLexicon​(VisualProperty<NullDataType> rootVisualProperty)
      Constructor for VisualLexicon. The parameters are required for all lexicons.
      Parameters:
      rootVisualProperty - Root of the visual property tree.

  • Method Details