com.aspose.slides
Class ChartData

java.lang.Object
  extended by com.aspose.slides.ChartData
All Implemented Interfaces:
IChartData

public class ChartData
extends java.lang.Object
implements IChartData

Represents data used for a chart plotting.


Method Summary
 IChartCategoryCollection getCategories()
           Gets the primary categories (or both primary and secondary categories if UseSecondaryCategories property is false).
 IChartDataWorkbook getChartDataWorkbook()
           Gets the cells factory to create cells used for chart series or categories.
 com.aspose.slides.IDOMObject getParent_Immediate()
           Returns Parent_Immediate object.
 IChartCategoryCollection getSecondaryCategories()
           Gets the secondary categories if UseSecondaryCategories property is true.
 IChartSeriesCollection getSeries()
           Gets the series.
 IChartSeriesGroupCollection getSeriesGroups()
           Gets the groups of series.
 boolean getUseSecondaryCategories()
           If false then SecondaryCategories property return null and data in Categories property is used both for primary and secondary series.
 byte[] readWorkbookStream()
           Writes the internally contained Excel workbook it into an in-memory stream.
 void setUseSecondaryCategories(boolean value)
           If false then SecondaryCategories property return null and data in Categories property is used both for primary and secondary series.
 void writeWorkbookStream(byte[] ms)
           Initializes the internally contained Excel workbook with user-specified value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getChartDataWorkbook

public IChartDataWorkbook getChartDataWorkbook()

Gets the cells factory to create cells used for chart series or categories. Read-only IChartDataWorkbook.

Specified by:
getChartDataWorkbook in interface IChartData

getSeries

public IChartSeriesCollection getSeries()

Gets the series. Read-only IChartSeriesCollection.

Specified by:
getSeries in interface IChartData

getSeriesGroups

public IChartSeriesGroupCollection getSeriesGroups()

Gets the groups of series. Read-only IChartSeriesGroupCollection.


1) Each group of series contains series with combinable types. Groups of combinable series types defined and described with CombinableSeriesTypesGroup enum. Also each group of series contains series witch is plotted whether on primary axes or on secondary axes (not both cases in one group). So, principle of series grouping is a grouping by type groups mentioned above and by primary/secondary plotting type. 2) Group of series contains some series properies whitch is common for each series in group ("series group properties"). "Series group properties" in ChartSeriesGroup class is read/write. Each of "series group properties" can have a read-only projection in ChartSeries class.

Specified by:
getSeriesGroups in interface IChartData

getCategories

public IChartCategoryCollection getCategories()

Gets the primary categories (or both primary and secondary categories if UseSecondaryCategories property is false). Read-only IChartCategoryCollection.


 Example. What categories are related to series - ChartData.getCategories() or ChartData.getSecondaryCategories()?
 
 if (series.getPlotOnSecondAxis() && series.getChart().getChartData().getUseSecondaryCategories())
 {
     // related categories are series.getChart().getChartData().getSecondaryCategories()
 }
 else
 {
     // related categories are series.getChart().getChartData().getCategories()
 }


If UseSecondaryCategories property is false then SecondaryCategories property return null and data in this Categories property is used both for primary and secondary series. If UseSecondaryCategories property is true then data in SecondaryCategories property is used for secondary series and data in this Categories property is used for primary series.

Specified by:
getCategories in interface IChartData

getUseSecondaryCategories

public boolean getUseSecondaryCategories()

If false then SecondaryCategories property return null and data in Categories property is used both for primary and secondary series. If true then data in SecondaryCategories property is used for secondary series and data in Categories property is used for primary series. Read/write boolean.


 Example. What categories are related to series - ChartData.getCategories() or ChartData.getSecondaryCategories()?
 
 if (series.getPlotOnSecondAxis() && series.getChart().getChartData().getUseSecondaryCategories())
 {
     // related categories are series.getChart().getChartData().getSecondaryCategories()
 }
 else
 {
     // related categories are series.getChart().getChartData().getCategories()
 }

Specified by:
getUseSecondaryCategories in interface IChartData

setUseSecondaryCategories

public void setUseSecondaryCategories(boolean value)

If false then SecondaryCategories property return null and data in Categories property is used both for primary and secondary series. If true then data in SecondaryCategories property is used for secondary series and data in Categories property is used for primary series. Read/write boolean.


 Example. What categories are related to series - ChartData.getCategories() or ChartData.getSecondaryCategories()?
 
 if (series.getPlotOnSecondAxis() && series.getChart().getChartData().getUseSecondaryCategories())
 {
     // related categories are series.getChart().getChartData().getSecondaryCategories()
 }
 else
 {
     // related categories are series.getChart().getChartData().getCategories()
 }

Specified by:
setUseSecondaryCategories in interface IChartData

getSecondaryCategories

public IChartCategoryCollection getSecondaryCategories()

Gets the secondary categories if UseSecondaryCategories property is true. Read-only IChartCategoryCollection.


 Example. What categories are related to series - ChartData.getCategories() or ChartData.getSecondaryCategories()?
 
 if (series.getPlotOnSecondAxis() && series.getChart().getChartData().getUseSecondaryCategories())
 {
     // related categories are series.getChart().getChartData().getSecondaryCategories()
 }
 else
 {
     // related categories are series.getChart().getChartData().getCategories()
 }


If UseSecondaryCategories property is false then this SecondaryCategories property return null and data in Categories property is used both for primary and secondary series. If UseSecondaryCategories property is true then data in this SecondaryCategories property is used for secondary series and data in Categories property is used for primary series.

Specified by:
getSecondaryCategories in interface IChartData

readWorkbookStream

public byte[] readWorkbookStream()

Writes the internally contained Excel workbook it into an in-memory stream.

Specified by:
readWorkbookStream in interface IChartData
Returns:
Returns an instance of MemoryStream containing a copy of the internally contained Excel workbook.

writeWorkbookStream

public void writeWorkbookStream(byte[] ms)

Initializes the internally contained Excel workbook with user-specified value.

Specified by:
writeWorkbookStream in interface IChartData
Parameters:
ms - The user-supplied stream containing the entire Excel workbook.

getParent_Immediate

public com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.



Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.