SparklineGroup
SparklineGroup class
Sparkline is organized into sparkline group. A SparklineGroup contains a variable number of sparkline items. A sparkline group specifies the type, display settings and axis settings for the sparklines.
Properties
| Name | Type | Description |
|---|---|---|
| PresetStyle | int | Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType intege |
| SparklineCollection | SparklineCollection | Gets the collection of Sparkline object. NOTE: This member is now obsolete. Instead, please use SparklineGroup.Sparkline |
| Sparklines | SparklineCollection | Gets the collection of Sparkline object. |
| Type | int | Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant. |
| PlotEmptyCellsType | int | Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant. |
| DisplayHidden | boolean | Indicates whether to show data in hidden rows and columns. |
| ShowHighPoint | boolean | Indicates whether to highlight the highest points of data in the sparkline group. |
| HighPointColor | CellsColor | Gets and sets the color of the highest points of data in the sparkline group. |
| ShowLowPoint | boolean | Indicates whether to highlight the lowest points of data in the sparkline group. |
| LowPointColor | CellsColor | Gets and sets the color of the lowest points of data in the sparkline group. |
| ShowNegativePoints | boolean | Indicates whether to highlight the negative values on the sparkline group with a different color or marker. |
| NegativePointsColor | CellsColor | Gets and sets the color of the negative values on the sparkline group. |
| ShowFirstPoint | boolean | Indicates whether to highlight the first point of data in the sparkline group. |
| FirstPointColor | CellsColor | Gets and sets the color of the first point of data in the sparkline group. |
| ShowLastPoint | boolean | Indicates whether to highlight the last point of data in the sparkline group. |
| LastPointColor | CellsColor | Gets and sets the color of the last point of data in the sparkline group. |
| ShowMarkers | boolean | Indicates whether to highlight each point in each line sparkline in the sparkline group. |
| MarkersColor | CellsColor | Gets and sets the color of points in each line sparkline in the sparkline group. |
| SeriesColor | CellsColor | Gets and sets the color of the sparklines in the sparkline group. |
| PlotRightToLeft | boolean | Indicates whether the plot data is right to left. |
| LineWeight | float | Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. |
| HorizontalAxisColor | CellsColor | Gets and sets the color of the horizontal axis in the sparkline group. |
| ShowHorizontalAxis | boolean | Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that cros |
| HorizontalAxisDateRange | String | Represents the range that contains the date values for the sparkline data. |
| VerticalAxisMaxValueType | int | Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant. |
| VerticalAxisMaxValue | float | Gets and sets the custom maximum value for the vertical axis. |
| VerticalAxisMinValueType | int | Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant. |
| VerticalAxisMinValue | float | Gets and sets the custom minimum value for the vertical axis. |
Methods
| Name | Description |
|---|---|
| resetRanges | Resets the data range and location range of the sparkline group. This method will clear original sparkline items in the |
| setVerticalAxisMaxValue | |
| setVerticalAxisMinValue |
SparklineGroup.PresetStyle property
Gets and sets the preset style type of the sparkline group. The value of the property is SparklinePresetStyleType integer constant.
Type: int
SparklineGroup.SparklineCollection property
Gets the collection of Sparkline object. NOTE: This member is now obsolete. Instead, please use SparklineGroup.Sparklines property. This property will be removed 12 months later since November 2022. Aspose apologizes for any inconvenience you may have experienced.
Type: SparklineCollection
SparklineGroup.Sparklines property
Gets the collection of Sparkline object.
Type: SparklineCollection
SparklineGroup.Type property
Indicates the sparkline type of the sparkline group. The value of the property is SparklineType integer constant.
Type: int
SparklineGroup.PlotEmptyCellsType property
Indicates how to plot empty cells. The value of the property is PlotEmptyCellsType integer constant.
Type: int
SparklineGroup.DisplayHidden property
Indicates whether to show data in hidden rows and columns.
Type: boolean
SparklineGroup.ShowHighPoint property
Indicates whether to highlight the highest points of data in the sparkline group.
Type: boolean
SparklineGroup.HighPointColor property
Gets and sets the color of the highest points of data in the sparkline group.
Type: CellsColor
SparklineGroup.ShowLowPoint property
Indicates whether to highlight the lowest points of data in the sparkline group.
Type: boolean
SparklineGroup.LowPointColor property
Gets and sets the color of the lowest points of data in the sparkline group.
Type: CellsColor
SparklineGroup.ShowNegativePoints property
Indicates whether to highlight the negative values on the sparkline group with a different color or marker.
Type: boolean
SparklineGroup.NegativePointsColor property
Gets and sets the color of the negative values on the sparkline group.
Type: CellsColor
SparklineGroup.ShowFirstPoint property
Indicates whether to highlight the first point of data in the sparkline group.
Type: boolean
SparklineGroup.FirstPointColor property
Gets and sets the color of the first point of data in the sparkline group.
Type: CellsColor
SparklineGroup.ShowLastPoint property
Indicates whether to highlight the last point of data in the sparkline group.
Type: boolean
SparklineGroup.LastPointColor property
Gets and sets the color of the last point of data in the sparkline group.
Type: CellsColor
SparklineGroup.ShowMarkers property
Indicates whether to highlight each point in each line sparkline in the sparkline group.
Type: boolean
SparklineGroup.MarkersColor property
Gets and sets the color of points in each line sparkline in the sparkline group.
Type: CellsColor
SparklineGroup.SeriesColor property
Gets and sets the color of the sparklines in the sparkline group.
Type: CellsColor
SparklineGroup.PlotRightToLeft property
Indicates whether the plot data is right to left.
Type: boolean
SparklineGroup.LineWeight property
Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points.
Type: float
SparklineGroup.HorizontalAxisColor property
Gets and sets the color of the horizontal axis in the sparkline group.
Type: CellsColor
SparklineGroup.ShowHorizontalAxis property
Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis.
Type: boolean
SparklineGroup.HorizontalAxisDateRange property
Represents the range that contains the date values for the sparkline data.
Type: String
SparklineGroup.VerticalAxisMaxValueType property
Represents the vertical axis maximum value type. The value of the property is SparklineAxisMinMaxType integer constant.
Type: int
SparklineGroup.VerticalAxisMaxValue property
Gets and sets the custom maximum value for the vertical axis.
Type: float
SparklineGroup.VerticalAxisMinValueType property
Represents the vertical axis minimum value type. The value of the property is SparklineAxisMinMaxType integer constant.
Type: int
SparklineGroup.VerticalAxisMinValue property
Gets and sets the custom minimum value for the vertical axis.
Type: float
resetRanges(dataRange, isVertical, locationRange)
Resets the data range and location range of the sparkline group. This method will clear original sparkline items in the group and creates new sparkline items for the new ranges.
| Parameter | Type | Description |
|---|---|---|
| dataRange | String | Specifies the new data range of the sparkline group. |
| isVertical | boolean | Specifies whether to plot the sparklines from the new data range by row or by column. |
| locationRange | CellArea | Specifies where the sparklines to be placed. |