com.grapecity.documents.excel

Interface ISparklineGroup

All Superinterfaces:

java.lang.Iterable<ISparkline>

public interface ISparklineGroup
extends java.lang.Iterable<ISparkline>

Represents a group of sparklines.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the sparkline group.
void	fromJson(java.lang.String json) Generate sparkline group from json string
ISparkline	get(int index) Gets the ISparkline object.
ISparkAxes	getAxes() Gets the associated ISparkAxes
int	getCount() Gets the number of sparklines in the sparkline group.
java.lang.String	getDateRange() Gets the date range for the sparkline group.
DisplayBlanksAs	getDisplayBlanksAs() Gets the way that blank cells are plotted on a chart.
boolean	getDisplayHidden() Specifies whether hidden cells are plotted in the sparkline group.
double	getLineWeight() Gets the thickness of the sparklines in the sparkline group.
IRange	getLocation() Gets the IRange object that represents the location of the sparkline group.
SparklineRowCol	getPlotBy() Gets how to plot the sparkline when the data on which it is based is in a square-shaped range.
ISparkPoints	getPoints() Gets the position of the specified node as a coordinate pair.
IFormatColor	getSeriesColor() Gets the IFormatColor object that represents the main series color for the sparkline group.
java.lang.String	getSourceData() Gets the range that contains the source data for the sparkline group.
SparkType	getType() Gets the type of sparkline for the group.
void	setDateRange(java.lang.String value) Sets the date range for the sparkline group.
void	setDisplayBlanksAs(DisplayBlanksAs value) Sets the way that blank cells are plotted on a chart.
void	setDisplayHidden(boolean value) Specifies whether hidden cells are plotted in the sparkline group.
void	setLineWeight(double value) Sets the thickness of the sparklines in the sparkline group.
void	setLocation(IRange value) Sets the IRange object that represents the location of the sparkline group.
void	setPlotBy(SparklineRowCol value) Sets how to plot the sparkline when the data on which it is based is in a square-shaped range.
void	setSourceData(java.lang.String value) Sets the range that contains the source data for the sparkline group.
void	setType(SparkType value) Sets the type of sparkline for the group.
java.lang.String	toJson() Generate json string from sparkline group

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

ISparkline get(int index)

Gets the ISparkline object.

Parameters:

index - Index value of the sparkline.

getAxes

ISparkAxes getAxes()

Gets the associated ISparkAxes

getCount

int getCount()

Gets the number of sparklines in the sparkline group.

getDateRange

java.lang.String getDateRange()

Gets the date range for the sparkline group.

setDateRange

void setDateRange(java.lang.String value)

Sets the date range for the sparkline group.

getDisplayBlanksAs

DisplayBlanksAs getDisplayBlanksAs()

Gets the way that blank cells are plotted on a chart.

setDisplayBlanksAs

void setDisplayBlanksAs(DisplayBlanksAs value)

Sets the way that blank cells are plotted on a chart.

getDisplayHidden

boolean getDisplayHidden()

Specifies whether hidden cells are plotted in the sparkline group.

setDisplayHidden

void setDisplayHidden(boolean value)

Specifies whether hidden cells are plotted in the sparkline group.

getLineWeight

double getLineWeight()

Gets the thickness of the sparklines in the sparkline group.

setLineWeight

void setLineWeight(double value)

Sets the thickness of the sparklines in the sparkline group.

getLocation

IRange getLocation()

Gets the IRange object that represents the location of the sparkline group.

setLocation

void setLocation(IRange value)

Sets the IRange object that represents the location of the sparkline group.

getPlotBy

SparklineRowCol getPlotBy()

Gets how to plot the sparkline when the data on which it is based is in a square-shaped range.

setPlotBy

void setPlotBy(SparklineRowCol value)

Sets how to plot the sparkline when the data on which it is based is in a square-shaped range.

getPoints

ISparkPoints getPoints()

Gets the position of the specified node as a coordinate pair. Each coordinate is expressed in points.

getSeriesColor

IFormatColor getSeriesColor()

Gets the IFormatColor object that represents the main series color for the sparkline group.

getSourceData

java.lang.String getSourceData()

Gets the range that contains the source data for the sparkline group.

setSourceData

void setSourceData(java.lang.String value)

Sets the range that contains the source data for the sparkline group.

getType

SparkType getType()

Gets the type of sparkline for the group.

setType

void setType(SparkType value)

Sets the type of sparkline for the group.

delete

void delete()

Deletes the sparkline group.

fromJson

void fromJson(java.lang.String json)

Generate sparkline group from json string

Parameters:

json -

toJson

java.lang.String toJson()

Generate json string from sparkline group

Returns: