RMGraph (ReportMill 14 API)

java.lang.Object
- SnapObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMParentShape
    - - com.reportmill.shape.RMGraph

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener
```
public class RMGraph
extends RMParentShape
```
The RMGraph class provides a template and the machinery for generating graphs. It primarily encapsulates a list key for defining the set of objects to graph and a keys string for defining the attributes of those objects to graph. For instance, the list key might be "Movies" and the keys string might be "revenue". You can programatically create a graph like this:
```
  RMGraph graph = new RMGraph();
  graph.setBounds(0, 0, 640, 480);
  graph.setDatasetKey("Movies");
  graph.setKeysString("revenue");
  graph.setType(RMGraph.TYPE_PIE);
  
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RMGraph.FontBox` Returns the part rect.
`static class`	`RMGraph.ItemLayout`
`static class`	`RMGraph.SectionLayout`
`static class`	`RMGraph.Type`

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes
RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Constructor Summary

Constructors
Constructor and Description

RMGraph()

Constructors
Constructor and Description
`RMGraph()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKey(java.lang.String aKey)` Adds a key.
`void`	`clearKeys()` Removes all keys.
`RMGraph`	`clone()` Standard clone implementation.
`RMShape`	`fromXML(XMLArchiver anArchiver, XMLElement anElement)` Legacy unarchival.
`RMScene3D`	`get3D()` Returns the 3d shape.
`RMGraphPartBars`	`getBars()` Returns the bars shape.
`RMColor`	`getColor(int anIndex)` Returns the specific color at the given index.
`int`	`getColorCount()` Returns the number of colors set for this graph.
`java.util.List<RMColor>`	`getColors()` Returns the list of colors to be used by this graph (or the default graph colors, if null).
`java.lang.String`	`getDatasetKey()` Returns the dataset key associated with the graph.
`static java.util.List`	`getDefaultColors()` Returns the default list of colors to be used by any graph without an explicit list of colors.
`boolean`	`getDraw3D()` Returns whether the graph draws in 3D.
`java.lang.String`	`getFilterKey()` Returns the optional key chain (expression) used to limit the table list derived from dataset key.
`RMGraph.FontBox`	`getFontBox(int anIndex)` Returns the font box for part at index.
`java.lang.String`	`getGraphTypeString()` Returns the graph type as a simple string: bar, pie or hbar.
`RMGrouping`	`getGrouping()` Returns the graph grouping.
`RMGraph.ItemLayout`	`getItemsLayout()` Returns the layout of section items.
`java.lang.String`	`getKey(int anIndex)` Returns the specific key at the given index.
`int`	`getKeyCount()` Returns the number of keys for this graph.
`RMGraphPartLabelAxis`	`getLabelAxis()` Returns the label axis shape.
`RMGraphLegend`	`getLegend()` Returns the child of the graph that represents the legend (if present).
`RMShape`	`getPart(int anIndex)` Returns the individual part at index.
`int`	`getPartCount()` Returns the number of graph parts.
`java.lang.String`	`getPartName(int anIndex)` Returns the individual part at index.
`RMShape[]`	`getParts()` Returns the parts.
`RMGraphPartPie`	`getPie()` Returns the pie shape.
`RMGraph.SectionLayout`	`getSectionLayout()` Returns the layout of series values.
`RMGraphPartSeries`	`getSeries(int anIndex)` Returns the individual series object and the given index.
`int`	`getSeriesCount()` Returns the number of series.
`boolean`	`getShowLegend()` Returns whether the graph shows a legend.
`RMGraph.Type`	`getType()` Returns the graph type (TYPE_BAR, TYPE_PIE, etc.).
`RMGraphPartValueAxis`	`getValueAxis()` Returns the value axis shape.
`boolean`	`isAbreast()` Returns whether section items layout is abreast.
`boolean`	`isLayered()` Returns whether section items layout is layered.
`boolean`	`isStacked()` Returns whether section items layout is stacked.
`boolean`	`isVertical()` Returns whether graph area is considered vertical.
`void`	`paintShape(RMShapePainter aPntr)` Override to suppress background paint.
`void`	`paintShapeOver(RMShapePainter aPntr)` Override to paint GraphArea parts.
`void`	`propertyChange(java.beans.PropertyChangeEvent anEvent)` Overrides normal version to suppress child changes and propagate part changes.
`void`	`relayout()` Overrides to relayout legend too.
`void`	`removeKey(int anIndex)` Removes a key.
`void`	`repaint()` Overrides shape implementation to repaint parent too.
`RMParentShape`	`rpgAll(ReportOwner anRptOwner, RMShape aParent)` Set ReportMill (which tries to get a dataset from reportmill and calls setObjects).
`RMParentShape`	`rpgAll(ReportOwner anRptOwner, RMShape aParent, boolean isSample)` Set ReportMill (which tries to get a dataset from reportmill and calls setObjects).
`void`	`setColors(java.util.List aColorList)` Sets the list of colors to be used by this graph.
`void`	`setDatasetKey(java.lang.String aKeyPath)` Sets the dataset key associated with the graph.
`static void`	`setDefaultColors(java.util.List aList)` Sets the default list of colors to be used by any graph without an explicit list of colors.
`void`	`setDraw3D(boolean aFlag)` Sets whether the graph draws in 3D.
`void`	`setFilterKey(java.lang.String aKeyExpr)` Sets the optional key chain (expression) used to limit the table list derived from dataset key.
`void`	`setGraphTypeString(java.lang.String aString)` Sets the graph type as a simple string: bar, pie or hbar.
`void`	`setItemsLayout(RMGraph.ItemLayout aLayout)` Sets the layout of section items.
`void`	`setSectionLayout(RMGraph.SectionLayout aLayout)` Sets the layout of series values.
`void`	`setShowLegend(boolean aFlag)` Sets whether the graph shows a legend.
`void`	`setType(RMGraph.Type aType)` Sets the graph type (TYPE_BAR, TYPE_PIE, etc.).

Methods inherited from class com.reportmill.shape.RMParentShape
addChild, addChild, addChild, addChild, bringShapesToFront, cloneDeep, divideShapeFromTop, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isSourceURLSet, layout, removeChild, removeChild, removeChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML

Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getClipShape, getColor, getDatasetEntity, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isUnderlined, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, rpgBindings, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

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

- Constructor Detail
  - RMGraph
```
public RMGraph()
```
- Method Detail
  - getDatasetKey
```
public java.lang.String getDatasetKey()
```
    Returns the dataset key associated with the graph.
    
    Overrides:
    
    getDatasetKey in class RMShape
  - setDatasetKey
```
public void setDatasetKey(java.lang.String aKeyPath)
```
    Sets the dataset key associated with the graph.
  - getFilterKey
```
public java.lang.String getFilterKey()
```
    Returns the optional key chain (expression) used to limit the table list derived from dataset key.
  - setFilterKey
```
public void setFilterKey(java.lang.String aKeyExpr)
```
    Sets the optional key chain (expression) used to limit the table list derived from dataset key.
  - getKeyCount
```
public int getKeyCount()
```
    Returns the number of keys for this graph.
  - getKey
```
public java.lang.String getKey(int anIndex)
```
    Returns the specific key at the given index.
  - addKey
```
public void addKey(java.lang.String aKey)
```
    Adds a key.
  - removeKey
```
public void removeKey(int anIndex)
```
    Removes a key.
  - clearKeys
```
public void clearKeys()
```
    Removes all keys.
  - getType
```
public RMGraph.Type getType()
```
    Returns the graph type (TYPE_BAR, TYPE_PIE, etc.).
  - setType
```
public void setType(RMGraph.Type aType)
```
    Sets the graph type (TYPE_BAR, TYPE_PIE, etc.).
  - getGraphTypeString
```
public java.lang.String getGraphTypeString()
```
    Returns the graph type as a simple string: bar, pie or hbar.
  - setGraphTypeString
```
public void setGraphTypeString(java.lang.String aString)
```
    Sets the graph type as a simple string: bar, pie or hbar.
  - getGrouping
```
public RMGrouping getGrouping()
```
    Returns the graph grouping.
  - getSectionLayout
```
public RMGraph.SectionLayout getSectionLayout()
```
    Returns the layout of series values.
  - setSectionLayout
```
public void setSectionLayout(RMGraph.SectionLayout aLayout)
```
    Sets the layout of series values.
  - getItemsLayout
```
public RMGraph.ItemLayout getItemsLayout()
```
    Returns the layout of section items.
  - setItemsLayout
```
public void setItemsLayout(RMGraph.ItemLayout aLayout)
```
    Sets the layout of section items.
  - isVertical
```
public boolean isVertical()
```
    Returns whether graph area is considered vertical.
  - isAbreast
```
public boolean isAbreast()
```
    Returns whether section items layout is abreast.
  - isStacked
```
public boolean isStacked()
```
    Returns whether section items layout is stacked.
  - isLayered
```
public boolean isLayered()
```
    Returns whether section items layout is layered.
  - repaint
```
public void repaint()
```
    Overrides shape implementation to repaint parent too.
    
    Overrides:
    
    repaint in class RMShape
  - relayout
```
public void relayout()
```
    Overrides to relayout legend too.
    
    Overrides:
    
    relayout in class RMParentShape
  - getValueAxis
```
public RMGraphPartValueAxis getValueAxis()
```
    Returns the value axis shape.
  - getLabelAxis
```
public RMGraphPartLabelAxis getLabelAxis()
```
    Returns the label axis shape.
  - getBars
```
public RMGraphPartBars getBars()
```
    Returns the bars shape.
  - getPie
```
public RMGraphPartPie getPie()
```
    Returns the pie shape.
  - getSeriesCount
```
public int getSeriesCount()
```
    Returns the number of series.
  - getSeries
```
public RMGraphPartSeries getSeries(int anIndex)
```
    Returns the individual series object and the given index.
  - get3D
```
public RMScene3D get3D()
```
    Returns the 3d shape.
  - getDraw3D
```
public boolean getDraw3D()
```
    Returns whether the graph draws in 3D.
  - setDraw3D
```
public void setDraw3D(boolean aFlag)
```
    Sets whether the graph draws in 3D.
  - getLegend
```
public RMGraphLegend getLegend()
```
    Returns the child of the graph that represents the legend (if present).
  - getShowLegend
```
public boolean getShowLegend()
```
    Returns whether the graph shows a legend.
  - setShowLegend
```
public void setShowLegend(boolean aFlag)
```
    Sets whether the graph shows a legend.
  - getColorCount
```
public int getColorCount()
```
    Returns the number of colors set for this graph.
  - getColor
```
public RMColor getColor(int anIndex)
```
    Returns the specific color at the given index. Automatically wraps if index exceeds color count.
  - getColors
```
public java.util.List<RMColor> getColors()
```
    Returns the list of colors to be used by this graph (or the default graph colors, if null).
  - setColors
```
public void setColors(java.util.List aColorList)
```
    Sets the list of colors to be used by this graph.
  - getDefaultColors
```
public static java.util.List getDefaultColors()
```
    Returns the default list of colors to be used by any graph without an explicit list of colors.
  - setDefaultColors
```
public static void setDefaultColors(java.util.List aList)
```
    Sets the default list of colors to be used by any graph without an explicit list of colors.
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Overrides normal version to suppress child changes and propagate part changes.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
    
    Overrides:
    
    propertyChange in class RMShape
  - rpgAll
```
public RMParentShape rpgAll(ReportOwner anRptOwner,
                            RMShape aParent)
```
    Set ReportMill (which tries to get a dataset from reportmill and calls setObjects).
    
    Overrides:
    
    rpgAll in class RMParentShape
  - rpgAll
```
public RMParentShape rpgAll(ReportOwner anRptOwner,
                            RMShape aParent,
                            boolean isSample)
```
    Set ReportMill (which tries to get a dataset from reportmill and calls setObjects).
  - paintShape
```
public void paintShape(RMShapePainter aPntr)
```
    Override to suppress background paint.
    
    Overrides:
    
    paintShape in class RMShape
  - paintShapeOver
```
public void paintShapeOver(RMShapePainter aPntr)
```
    Override to paint GraphArea parts.
    
    Overrides:
    
    paintShapeOver in class RMShape
  - getPartCount
```
public int getPartCount()
```
    Returns the number of graph parts.
  - getPart
```
public RMShape getPart(int anIndex)
```
    Returns the individual part at index.
  - getPartName
```
public java.lang.String getPartName(int anIndex)
```
    Returns the individual part at index.
  - getParts
```
public RMShape[] getParts()
```
    Returns the parts.
  - getFontBox
```
public RMGraph.FontBox getFontBox(int anIndex)
```
    Returns the font box for part at index.
  - clone
```
public RMGraph clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class RMParentShape
  - fromXML
```
public RMShape fromXML(XMLArchiver anArchiver,
                       XMLElement anElement)
```
    Legacy unarchival.
    
    Overrides:
    
    fromXML in class RMParentShape

Class RMGraph

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMParentShape

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class java.lang.Object

Constructor Detail

RMGraph

Method Detail

getDatasetKey

setDatasetKey

getFilterKey

setFilterKey

getKeyCount

getKey

addKey

removeKey

clearKeys

getType

setType

getGraphTypeString

setGraphTypeString

getGrouping

getSectionLayout

setSectionLayout

getItemsLayout

setItemsLayout

isVertical

isAbreast

isStacked

isLayered

repaint

relayout

getValueAxis

getLabelAxis

getBars

getPie

getSeriesCount

getSeries

get3D

getDraw3D

setDraw3D

getLegend

getShowLegend

setShowLegend

getColorCount

getColor

getColors

setColors

getDefaultColors

setDefaultColors

propertyChange

rpgAll

rpgAll

paintShape

paintShapeOver

getPartCount

getPart

getPartName

getParts

getFontBox

clone

fromXML