Package com.grapecity.documents.excel
Interface ISparklineGroup
- All Superinterfaces:
Iterable<ISparkline>
Represents a group of sparklines.
-
Method Summary
Modifier and TypeMethodDescriptionvoiddelete()Deletes the sparkline group.voidGenerate sparkline group from json stringget(int index) Gets theISparklineobject.getAxes()Gets the associatedISparkAxes.intgetCount()Gets the number of sparklines in the sparkline group.Gets the date range for the sparkline group.Gets the way that blank cells are plotted on a chart.booleanGets whether hidden cells are plotted in the sparkline group.doubleGets the thickness of the sparklines in the sparkline group.Gets theIRangeobject that represents the location of the sparklinegroup.Gets how to plot the sparkline when the data on which it is based is in a square-shaped range.Gets the position of the specified node as a coordinate pair.Gets theIFormatColorobject that represents the main series colorfor the sparkline group.Gets the range that contains the source data for the sparkline group.getType()Gets the type of sparkline for the group.voidsetDateRange(String value) Sets the date range for the sparkline group.voidSets the way that blank cells are plotted on a chart.voidsetDisplayHidden(boolean value) Sets whether hidden cells are plotted in the sparkline group.voidsetLineWeight(double value) Sets the thickness of the sparklines in the sparkline group.voidsetLocation(IRange value) Sets theIRangeobject that represents the location of the sparklinegroup.voidsetPlotBy(SparklineRowCol value) Sets how to plot the sparkline when the data on which it is based is in a square-shaped range.voidsetSourceData(String value) Sets the range that contains the source data for the sparkline group.voidSets the type of sparkline for the group.toJson()Generate json string from sparkline groupMethods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Method Details
-
get
Gets theISparklineobject.- Parameters:
index- Index value of the sparkline.
-
getAxes
ISparkAxes getAxes()Gets the associatedISparkAxes. -
getCount
int getCount()Gets the number of sparklines in the sparkline group. -
getDateRange
String getDateRange()Gets the date range for the sparkline group. -
setDateRange
Sets the date range for the sparkline group. -
getDisplayBlanksAs
DisplayBlanksAs getDisplayBlanksAs()Gets the way that blank cells are plotted on a chart. -
setDisplayBlanksAs
Sets the way that blank cells are plotted on a chart. -
getDisplayHidden
boolean getDisplayHidden()Gets whether hidden cells are plotted in the sparkline group. -
setDisplayHidden
void setDisplayHidden(boolean value) Sets 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 theIRangeobject that represents the location of the sparklinegroup. -
setLocation
Sets theIRangeobject that represents the location of the sparklinegroup. -
getPlotBy
SparklineRowCol getPlotBy()Gets how to plot the sparkline when the data on which it is based is in a square-shaped range. -
setPlotBy
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 theIFormatColorobject that represents the main series colorfor the sparkline group. -
getSourceData
String getSourceData()Gets the range that contains the source data for the sparkline group. -
setSourceData
Sets the range that contains the source data for the sparkline group. -
getType
SparkType getType()Gets the type of sparkline for the group. -
setType
Sets the type of sparkline for the group. -
delete
void delete()Deletes the sparkline group. -
fromJson
Generate sparkline group from json string- Parameters:
json- The JSON string representing the sparkline group.
-
toJson
String toJson()Generate json string from sparkline group- Returns:
- The JSON string representing the sparkline group.
-