Style Intelligence v12.0

inetsoft.graph.element
Class LineElement

java.lang.Object
  extended by inetsoft.graph.Graphable
      extended by inetsoft.graph.element.GraphElement
          extended by inetsoft.graph.element.StackableElement
              extended by inetsoft.graph.element.LineElement
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
AreaElement

public class LineElement
extends StackableElement

A line element is used to add line visualization to a graph.


Field Summary
 
Fields inherited from class inetsoft.graph.element.GraphElement
DODGE_SYMMETRIC, HINT_ALPHA, HINT_CLIP, HINT_EXPLODED, HINT_MAX_COUNT, HINT_MAX_HEIGHT, HINT_MAX_WIDTH, HINT_SHINE, MOVE_CENTER, MOVE_DODGE, MOVE_JITTER, MOVE_NONE, MOVE_STACK, STACK_SYMMETRIC
 
Constructor Summary
LineElement()
          Create an empty element.
LineElement(String field1)
          Create a line element for a single column (1d).
LineElement(String field1, String field2)
          Create a line element for two columns (2d).
LineElement(String field1, String field2, String field3)
          Create a line element for three columns (3d).
 
Method Summary
 String[] getGroupFields()
          Get the fields for grouping values into lines.
 String[] getSortFields()
          Get the fields for ordering points on lines.
 boolean isClosed()
          Check if the line is closed (start-end points connected).
 boolean isEndArrow()
          Check if an arrow should be drawn at the end point.
 boolean isStartArrow()
          Check if an arrow should be drawn at the starting point.
 void setClosed(boolean closed)
          Set the line is closed (start-end points connected).
 void setEndArrow(boolean arrow)
          Set if an arrow should be drawn at the end point.
 void setGroupFields(String[] fields)
          Set the fields for grouping values into lines.
 void setSortFields(String[] fields)
          Set the fields for ordering points on lines.
 void setStartArrow(boolean arrow)
          Set if an arrow should be drawn at the starting point.
 SortedDataSet sortData(DataSet data, GGraph graph)
          Sort dataset to prepare for generating visual objects.
 boolean supportsFrame(VisualFrame frame)
          Check if the aesthetic frame is supported.
 
Methods inherited from class inetsoft.graph.element.StackableElement
isStackGroup, isStackNegative, setStackGroup, setStackNegative
 
Methods inherited from class inetsoft.graph.element.GraphElement
addDim, addVar, clearDims, clearVars, clone, createVisualModel, equalsContent, getCollisionModifier, getColorFrame, getComparator, getDim, getDimCount, getDims, getEndRow, getLabelPlacement, getLineFrame, getRootColIndex, getRootRowIndex, getRootRowIndexes, getShapeFrame, getSizeFrame, getStartRow, getTextFrame, getTextSpec, getTextureFrame, getVar, getVarCount, getVars, getVisualDataSet, getVisualFrames, isInPlot, removeDim, removeVar, setCollisionModifier, setColorFrame, setComparator, setEndRow, setInPlot, setLabelPlacement, setLineFrame, setShapeFrame, setSizeFrame, setStartRow, setTextFrame, setTextSpec, setTextureFrame, setVisualDataSet, toString
 
Methods inherited from class inetsoft.graph.Graphable
getHint, getHints, setHint, setHints
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LineElement

public LineElement()
Create an empty element. Dims and vars must be added explicitly.


LineElement

public LineElement(String field1)
Create a line element for a single column (1d).


LineElement

public LineElement(String field1,
                   String field2)
Create a line element for two columns (2d).


LineElement

public LineElement(String field1,
                   String field2,
                   String field3)
Create a line element for three columns (3d).

Method Detail

setClosed

public void setClosed(boolean closed)
Set the line is closed (start-end points connected).


isClosed

public boolean isClosed()
Check if the line is closed (start-end points connected).


isStartArrow

public boolean isStartArrow()
Check if an arrow should be drawn at the starting point.


setStartArrow

public void setStartArrow(boolean arrow)
Set if an arrow should be drawn at the starting point.


isEndArrow

public boolean isEndArrow()
Check if an arrow should be drawn at the end point.


setEndArrow

public void setEndArrow(boolean arrow)
Set if an arrow should be drawn at the end point.


sortData

public SortedDataSet sortData(DataSet data,
                              GGraph graph)
Sort dataset to prepare for generating visual objects.

Overrides:
sortData in class StackableElement
Returns:
sorted dataset or null if no sorting is necessary.

supportsFrame

public boolean supportsFrame(VisualFrame frame)
Check if the aesthetic frame is supported. Area element doesn't support shape frame.

Overrides:
supportsFrame in class GraphElement

setGroupFields

public void setGroupFields(String[] fields)
Set the fields for grouping values into lines. For example, if 'State' is a group field, values for each state is grouped into its own line.


getGroupFields

public String[] getGroupFields()
Get the fields for grouping values into lines.


setSortFields

public void setSortFields(String[] fields)
Set the fields for ordering points on lines. If the fields are not set, the points are ordered from left to right (or bottom to top for) regardless of the order of the data in the dataset.


getSortFields

public String[] getSortFields()
Get the fields for ordering points on lines.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.