org.zkoss.poi.ss.usermodel

Interface Chart

All Superinterfaces:

ManuallyPositionable

All Known Implementing Classes:

XSSFChart

public interface Chart
extends ManuallyPositionable

High level representation of a chart.

Author:

Roman Kashitsyn

Method Summary

Modifier and Type	Method and Description
void	deleteLegend() Delete current chart legend.
void	deleteView3D() Delete current chart legend.
List<? extends ChartAxis>	getAxis()
ChartAxisFactory	getChartAxisFactory()
ChartDataFactory	getChartDataFactory()
String	getChartId()
ChartLegend	getOrCreateLegend()
View3D	getOrCreateView3D()
ClientAnchor	getPreferredSize()
boolean	isPlotOnlyVisibleCells()
void	plot(ChartData data, ChartAxis... axis) Plots specified data on the chart.
void	renameSheet(String oldname, String newname)
void	setClientAnchor(ClientAnchor anchor)
void	setPlotOnlyVisibleCells(boolean plotVisOnly)

Methods inherited from interface org.zkoss.poi.ss.usermodel.charts.ManuallyPositionable

getManualLayout

Method Detail

getChartDataFactory

ChartDataFactory getChartDataFactory()

Returns:

an appropriate ChartDataFactory implementation

getChartAxisFactory

ChartAxisFactory getChartAxisFactory()

Returns:

an appropriate ChartAxisFactory implementation

getOrCreateLegend

ChartLegend getOrCreateLegend()

Returns:

chart legend instance

deleteLegend

void deleteLegend()

Delete current chart legend.

getAxis

List<? extends ChartAxis> getAxis()

Returns:

list of all chart axis

plot

void plot(ChartData data,
          ChartAxis... axis)

Plots specified data on the chart.

Parameters:

data - a data to plot

getOrCreateView3D

View3D getOrCreateView3D()

Returns:

chart legend instance

deleteView3D

void deleteView3D()

Delete current chart legend.

renameSheet

void renameSheet(String oldname,
                 String newname)

getPreferredSize

ClientAnchor getPreferredSize()

setClientAnchor

void setClientAnchor(ClientAnchor anchor)

getChartId

String getChartId()

isPlotOnlyVisibleCells

boolean isPlotOnlyVisibleCells()

setPlotOnlyVisibleCells

void setPlotOnlyVisibleCells(boolean plotVisOnly)