RMGraphSeries

java.lang.Object

com.inductiveautomation.rm.graphing.RMGraphSeries

public class RMGraphSeries extends Object

A class to represent a graph series, contains a list of series items.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

RMGraphSeries.Item

A class to represent an individual item inside a graph series, including its key, group, value and bar/wedge shape.
Constructor Summary

Constructors

Constructor

Description

RMGraphSeries(String aTitle, String aKey, RMGroup aGroupList)

Creates a new series.
Method Summary

Modifier and Type

Method

Description

void

addItem(RMGroup aGroup)

Add item for given key/group.

RMGraphSeries.Item

getItem(int anIndex)

Returns the individual series item at the given index.

int

getItemCount()

Returns the number of items in this series.

String

getKey()

Returns the key for this series.

static List<RMGraphSeries>

getSeries(RMGraphRPG aGraphRPG)

Returns the graph series for a given graph.

float

getSeriesTotal()

Returns the total for all values in series.

String

getTitle()

Returns the title for this series.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- RMGraphSeries
  
  public RMGraphSeries(String aTitle, String aKey, RMGroup aGroupList)
  
  Creates a new series.
Method Details
- getTitle
  
  public String getTitle()
  
  Returns the title for this series.
- getKey
  
  public String getKey()
  
  Returns the key for this series.
- addItem
  
  public void addItem(RMGroup aGroup)
  
  Add item for given key/group.
- getItemCount
  
  public int getItemCount()
  
  Returns the number of items in this series.
- getItem
  
  public RMGraphSeries.Item getItem(int anIndex)
  
  Returns the individual series item at the given index.
- getSeriesTotal
  
  public float getSeriesTotal()
  
  Returns the total for all values in series.
- getSeries
  
  public static List<RMGraphSeries> getSeries(RMGraphRPG aGraphRPG)
  
  Returns the graph series for a given graph.