Chart (Sencha GXT 3.1.1)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.sencha.gxt.widget.core.client.Component
    - - com.sencha.gxt.chart.client.draw.DrawComponent
      - com.sencha.gxt.chart.client.chart.Chart<M>

Type Parameters:
M - the data type to be used by this Chart

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, IsWidget, SpriteHandler.HasSpriteHandlers, SpriteOutEvent.HasSpriteOutHandlers, SpriteOverEvent.HasSpriteOverHandlers, SpriteSelectionEvent.HasSpriteSelectionHandlers, SpriteUpEvent.HasSpriteUpHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId
```
public class Chart<M>
extends DrawComponent
```
Charts provide a flexible way to achieve a wide range of data visualization capabilities. Each Chart gets its data directly from a ListStore, and automatically updates its display whenever data in the Store changes. ## Creating a Simple Chart Every Chart has three key parts - a ListStore that contains the data, multiple Axis types which define the boundaries of the Chart, and one or more Series to handle the visual rendering of the data points. ### 1. Creating a Store The first step is to create a model that represents the type of data that will be displayed in the Chart. Here is an example of a simple class with a field for the name key and a single data value:
```
     public class Data {
       private String name;
       private double data1;

       public Data(String name, double data1) {
         this.name = name;
         this.data1 = data1;
       }

       public double getData1() {
         return data1;
       }

       public String getName() {
         return name;
       }

       public void setData1(double data1) {
         this.data1 = data1;
       }

       public void setName(String name) {
         this.name = name;
       }
     }
 
```
Next create the ValueProvider interface for the model fields:
```
    public interface DataPropertyAccess extends PropertyAccess<Data> {
      ValueProvider<Data, Double> data1();

      ValueProvider<Data, Double> data2();

      ValueProvider<Data, Double> data3();

      ValueProvider<Data, String> name();

      @Path("name")
      ModelKeyProvider<Data> nameKey();
    }

    private static final DataPropertyAccess dataAccess = GWT.create(DataPropertyAccess.class);
 
```
Finally create the store itself. The data could be loaded dynamically, but for sake of ease this example uses in line data:
```
    ListStore<Data> store = new ListStore<Data>(dataAccess.nameKey());
    store.add(new Data("A", 50);
    store.add(new Data("B", 60);
    store.add(new Data("C", 70);
    store.add(new Data("D", 80);
    store.add(new Data("E", 60);
 
```
### 2. Creating the Chart object Now that a Store has been created it can be used in a Chart:
```
    Chart<Data> chart = new Chart<Data>(600, 500);
    chart.setStore(store);
    chart.setAnimated(true);
    chart.setShadowChart(true);
 
```
That's all it takes to create a Chart instance that is backed by a Store. However, if the above code is run in a browser, a blank screen will be displayed. This is because the two pieces that are responsible for the visual display, the Chart's axes and series, have not yet been defined. ### 3. Configuring the Axes Axes are the lines that define the boundaries of the data points that a Chart can display. This example uses one of the most common Axes configurations - a horizontal "x" axis, and a vertical "y" axis:
```
    NumericAxis<Data> verticalAxis = new NumericAxis<Data>();
    verticalAxis.setPosition(Position.LEFT);
    verticalAxis.addField(dataAccess.data1());
    verticalAxis.setMinimum(0);
    verticalAxis.setMaximum(100);
    chart.addAxis(verticalAxis);

    CategoryAxis<Data, String> horizontalAxis = new CategoryAxis<Data, String>();
    horizontalAxis.setPosition(Position.BOTTOM);
    horizontalAxis.setField(dataAccess.name());
    chart.addAxis(horizontalAxis);
 
```
The vertical axis is a NumericAxis and is positioned on the left edge of the Chart. It represents the bounds of the data contained in the "data1" field that was defined above. The minimum value for this axis is "0", and the maximum is "100". The horizontal axis is a CategoryAxis and is positioned on the bottom edge of the Chart. It represents the "name" of each item in the store. ### 4. Configuring the Series The final step in creating a simple Chart is to configure one or more Series. Series are responsible for the visual representation of the data points contained in the Store. This example only has one Series:
```
    LineSeries<Data> series = new LineSeries<Data>();
    series.setYAxisPosition(Position.LEFT);
    series.setYField(dataAccess.data1());
    series.setStroke(new RGB(32, 68, 186));
    series.setStrokeWidth(3);
    series.setSmooth(true);
    chart.addSeries(series);
 
```
This Series is a LineSeries, and it uses the "data1" field from the Store to plot its data points.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Chart.Position
Enumeration used for items positioned on the chart.
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested Classes
Modifier and Type	Class and Description
`static class`	`Chart.Position` Enumeration used for items positioned on the chart.

Field Summary
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

Chart()
Creates a chart with default width and height.

Chart(int width, int height)
Creates a chart with the given width and height.

Constructors
Constructor and Description
`Chart()` Creates a chart with default width and height.
`Chart(int width, int height)` Creates a chart with the given width and height.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAxis(Axis<M,?> axis)` Adds an axis to the chart.
`void`	`addSeries(Series<M> series)` Adds a `Series` to the chart.
`void`	`bindStore(ListStore<M> store)` Binds the store to the chart so that any store events will automatically redraw the chart.
`void`	`calculateMaximumGutter()` Calculates the maximum gutter of the chart's series.
`int`	`getAnimationDuration()` Returns the duration of animations on the chart.
`EasingFunction`	`getAnimationEasing()` Returns the `EasingFunction` used by animations on the chart.
`Map<Chart.Position,Axis<M,?>>`	`getAxes()` Returns the map of axes currently added to the chart.
`Axis<M,?>`	`getAxis(Chart.Position position)` Returns the `Axis` at the given `Chart.Position`.
`PreciseRectangle`	`getBBox()` Returns the bounding box of the chart.
`ListStore<M>`	`getCurrentStore()` Returns the store currently being used by the chart.
`Region`	`getDefaultInsets()` Returns the initial insets of the chart.
`Legend<M>`	`getLegend()` Returns the legend of the chart.
`double[]`	`getMaxGutter()` Returns maximum gutter of the series in the chart.
`List<Series<M>>`	`getSeries()` Returns all of the series attached to the chart.
`Series<M>`	`getSeries(int index)` Returns the series attached to the chart at the given index.
`ListStore<M>`	`getStore()` Returns the data store bound to the chart.
`boolean`	`hasShadows()` Returns whether or not the chart has shadows.
`boolean`	`isAnimated()` Returns whether or not the chart is animated.
`boolean`	`isResizing()` Returns whether or not the chart is resizing.
`void`	`onMouseDown(Event event)` Method used when the chart is clicked.
`void`	`onMouseMove(Event event)` Method used when the mouse moves over the chart.
`void`	`onMouseOut(Event event)` Method used when the mouse leaves the chart.
`void`	`onMouseUp(Event event)` Method used when the mouse is released over the chart.
`void`	`onResize(int width, int height)`
`void`	`redrawChart()` Redraws all elements of the chart.
`void`	`redrawChartForced()` Redraws all elements of the chart immediately.
`Axis<M,?>`	`removeAxis(Axis<M,?> axis)` Removes the `Axis` from the chart.
`Axis<M,?>`	`removeAxis(Chart.Position position)` Removes the `Axis` at the given `Chart.Position` from the chart.
`void`	`removeLegend()` Removes the `Legend` currently attached legend from the chart.
`boolean`	`removeSeries(int index)` Removes the given `Series` from the chart.
`boolean`	`removeSeries(Series<M> series)` Removes the given `Series` from the chart.
`void`	`setAnimated(boolean animated)` Sets whether or not the chart is animated.
`void`	`setAnimationDuration(int animationDuration)` Sets the duration of animations on the chart.
`void`	`setAnimationEasing(EasingFunction animationEasing)` Sets the `EasingFunction` used by animations on the chart.
`void`	`setDefaultInsets(int defaultInsets)` Sets the initial insets of the chart.
`void`	`setDefaultInsets(Region defaultInsets)` Sets the initial insets of the chart.
`void`	`setLegend(Legend<M> legend)` Sets the legend of the chart.
`void`	`setPixelSize(int width, int height)`
`void`	`setShadowChart(boolean shadow)` Sets whether or not the chart has shadows.
`void`	`setStore(ListStore<M> store)` Sets the data store bound to the chart.
`void`	`setSubstore(ListStore<M> substore)` Sets a temporary substore for the chart.

Methods inherited from class com.sencha.gxt.chart.client.draw.DrawComponent
addGradient, addSprite, addSpriteHandler, addSpriteOutHandler, addSpriteOverHandler, addSpriteSelectionHandler, addSpriteUpHandler, clearSurface, getBackground, getSurface, isViewBox, onBrowserEvent, redrawSurface, redrawSurfaceForced, remove, renderSprite, setBackground, setViewBox

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

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

- Constructor Detail
  - Chart
```
public Chart()
```
    Creates a chart with default width and height.
  - Chart
```
public Chart(int width,
     int height)
```
    Creates a chart with the given width and height.
    
    Parameters:
    width - the width of the chart
    height - the height of the chart
- Method Detail
  - addAxis
```
public void addAxis(Axis<M,?> axis)
```
    Adds an axis to the chart. Only one axis for each Chart.Position can be added.
    
    Parameters:
    axis - the axis to be added
  - addSeries
```
public void addSeries(Series<M> series)
```
    Adds a Series to the chart.
    
    Parameters:
    series - the series to be added
  - bindStore
```
public void bindStore(ListStore<M> store)
```
    Binds the store to the chart so that any store events will automatically redraw the chart.
    
    Parameters:
    store - the store to be bound
  - calculateMaximumGutter
```
public void calculateMaximumGutter()
```
    Calculates the maximum gutter of the chart's series.
  - getAnimationDuration
```
public int getAnimationDuration()
```
    Returns the duration of animations on the chart.
    
    Returns:
    the duration of animations on the chart
  - getAnimationEasing
```
public EasingFunction getAnimationEasing()
```
    Returns the EasingFunction used by animations on the chart.
    
    Returns:
    the easing function used by animations on the chart
  - getAxes
```
public Map<Chart.Position,Axis<M,?>> getAxes()
```
    Returns the map of axes currently added to the chart.
    
    Returns:
    the map of axes currently added to the chart
  - getAxis
```
public Axis<M,?> getAxis(Chart.Position position)
```
    Returns the Axis at the given Chart.Position.
    
    Parameters:
    position - the position of the axis
    
    Returns:
    the axis at the given position
  - getBBox
```
public PreciseRectangle getBBox()
```
    Returns the bounding box of the chart.
    
    Returns:
    the bounding box of the chart
  - getCurrentStore
```
public ListStore<M> getCurrentStore()
```
    Returns the store currently being used by the chart.
    
    Returns:
    the store currently being used by the chart
  - getDefaultInsets
```
public Region getDefaultInsets()
```
    Returns the initial insets of the chart.
    
    Returns:
    the initial insets of the chart
  - getLegend
```
public Legend<M> getLegend()
```
    Returns the legend of the chart.
    
    Returns:
    the legend of the chart
  - getMaxGutter
```
public double[] getMaxGutter()
```
    Returns maximum gutter of the series in the chart.
    
    Returns:
    maximum gutter of the series in the chart
  - getSeries
```
public List<Series<M>> getSeries()
```
    Returns all of the series attached to the chart.
    
    Returns:
    all of the series attached to the chart
  - getSeries
```
public Series<M> getSeries(int index)
```
    Returns the series attached to the chart at the given index.
    
    Parameters:
    index - the index of the series
    
    Returns:
    the series attached to the chart
  - getStore
```
public ListStore<M> getStore()
```
    Returns the data store bound to the chart.
    
    Returns:
    the data store bound to the chart
  - hasShadows
```
public boolean hasShadows()
```
    Returns whether or not the chart has shadows.
    
    Returns:
    true if shadows
  - isAnimated
```
public boolean isAnimated()
```
    Returns whether or not the chart is animated.
    
    Returns:
    true if animated
  - isResizing
```
public boolean isResizing()
```
    Returns whether or not the chart is resizing.
    
    Returns:
    true if resizing
  - onMouseDown
```
public void onMouseDown(Event event)
```
    Method used when the chart is clicked.
    
    Overrides:
    
    onMouseDown in class DrawComponent
    
    Parameters:
    event - the mouse event
  - onMouseMove
```
public void onMouseMove(Event event)
```
    Method used when the mouse moves over the chart.
    
    Overrides:
    
    onMouseMove in class DrawComponent
    
    Parameters:
    event - the mouse event
  - onMouseOut
```
public void onMouseOut(Event event)
```
    Method used when the mouse leaves the chart.
    
    Overrides:
    
    onMouseOut in class DrawComponent
    
    Parameters:
    event - the mouse event
  - onMouseUp
```
public void onMouseUp(Event event)
```
    Method used when the mouse is released over the chart.
    
    Overrides:
    
    onMouseUp in class DrawComponent
    
    Parameters:
    event - the mouse event
  - onResize
```
public void onResize(int width,
            int height)
```
  - redrawChart
```
public void redrawChart()
```
    Redraws all elements of the chart.
  - redrawChartForced
```
public void redrawChartForced()
```
    Redraws all elements of the chart immediately.
  - removeAxis
```
public Axis<M,?> removeAxis(Axis<M,?> axis)
```
    Removes the Axis from the chart.
    
    Parameters:
    axis - the axis to remove
    
    Returns:
    the removed axis
  - removeAxis
```
public Axis<M,?> removeAxis(Chart.Position position)
```
    Removes the Axis at the given Chart.Position from the chart.
    
    Parameters:
    position - the position of the axis to remove
    
    Returns:
    the removed axis
  - removeLegend
```
public void removeLegend()
```
    Removes the Legend currently attached legend from the chart.
  - removeSeries
```
public boolean removeSeries(int index)
```
    Removes the given Series from the chart.
    
    Parameters:
    index - the index of the series to be removed
    
    Returns:
    true if the series is removed
  - removeSeries
```
public boolean removeSeries(Series<M> series)
```
    Removes the given Series from the chart.
    
    Parameters:
    series - the series to be removed
    
    Returns:
    true if the series is removed
  - setAnimated
```
public void setAnimated(boolean animated)
```
    Sets whether or not the chart is animated.
    
    Parameters:
    animated - true if animated
  - setAnimationDuration
```
public void setAnimationDuration(int animationDuration)
```
    Sets the duration of animations on the chart.
    
    Parameters:
    animationDuration - the duration of animations on the chart
  - setAnimationEasing
```
public void setAnimationEasing(EasingFunction animationEasing)
```
    Sets the EasingFunction used by animations on the chart.
    
    Parameters:
    animationEasing - the easing function used by animations on the chart
  - setDefaultInsets
```
public void setDefaultInsets(int defaultInsets)
```
    Sets the initial insets of the chart.
    
    Parameters:
    defaultInsets - the initial insets of the chart
  - setDefaultInsets
```
public void setDefaultInsets(Region defaultInsets)
```
    Sets the initial insets of the chart.
    
    Parameters:
    defaultInsets - the initial insets of the chart
  - setLegend
```
public void setLegend(Legend<M> legend)
```
    Sets the legend of the chart.
    
    Parameters:
    legend - the legend of the chart
  - setPixelSize
```
public void setPixelSize(int width,
                int height)
```
    Overrides:
    
    setPixelSize in class DrawComponent
  - setShadowChart
```
public void setShadowChart(boolean shadow)
```
    Sets whether or not the chart has shadows.
    
    Parameters:
    shadow - true if shadows
  - setStore
```
public void setStore(ListStore<M> store)
```
    Sets the data store bound to the chart.
    
    Parameters:
    store - the data store
  - setSubstore
```
public void setSubstore(ListStore<M> substore)
```
    Sets a temporary substore for the chart. Used by TimeAxis.
    
    Parameters:
    substore - substore for the chart

Class Chart<M>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.chart.client.draw.DrawComponent

Methods inherited from class com.sencha.gxt.widget.core.client.Component

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Constructor Detail

Chart

Chart

Method Detail

addAxis

addSeries

bindStore

calculateMaximumGutter

getAnimationDuration

getAnimationEasing

getAxes

getAxis

getBBox

getCurrentStore

getDefaultInsets

getLegend

getMaxGutter

getSeries

getSeries

getStore

hasShadows

isAnimated

isResizing

onMouseDown

onMouseMove

onMouseOut

onMouseUp

onResize

redrawChart

redrawChartForced

removeAxis

removeAxis

removeLegend

removeSeries

removeSeries

setAnimated

setAnimationDuration

setAnimationEasing

setDefaultInsets

setDefaultInsets

setLegend

setPixelSize

setShadowChart

setStore

setSubstore