SparklineGroup Class
Defines the SparklineGroup Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is x14:sparklineGroup.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Office2010.Excel.SparklineGroup
Namespace: DocumentFormat.OpenXml.Office2010.Excel
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(FirstMarkerColor), FileFormatVersions.Office2010)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Sparklines), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(SeriesColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(NegativeColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(AxisColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(MarkersColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(LastMarkerColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(HighMarkerColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(LowMarkerColor), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Formula))> _
Public Class SparklineGroup _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As SparklineGroup
[ChildElementInfoAttribute(typeof(FirstMarkerColor), FileFormatVersions.Office2010)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Sparklines), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(SeriesColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(NegativeColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(AxisColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(MarkersColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(LastMarkerColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(HighMarkerColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(LowMarkerColor), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Formula))]
public class SparklineGroup : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
SeriesColor <x14:colorSeries>
NegativeColor <x14:colorNegative>
AxisColor <x14:colorAxis>
MarkersColor <x14:colorMarkers>
FirstMarkerColor <x14:colorFirst>
LastMarkerColor <x14:colorLast>
HighMarkerColor <x14:colorHigh>
LowMarkerColor <x14:colorLow>
DocumentFormat.OpenXml.Office.Excel.Formula <xne:f>
Sparklines <x14:sparklines>
2.6.7 CT_SparklineGroup
Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/main
Referenced by: CT_SparklineGroups
A complex type that specifies properties for a sparkline group.
Child Elements:
colorSeries : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorNegative : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the negative data points for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorAxis : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the horizontal axis for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorMarkers : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the data markers for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorFirst : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the first data point for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorLast : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the last data point for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorHigh : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the highest data point for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
colorLow : A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the color of the lowest data point for each sparkline in this sparkline group. The auto attribute of the CT_Color ([ISO/IEC-29500-4] section A.2) element MUST equal FALSE.
xm:f : An f element that specifies the date range for the sparkline group. The syntax (Formulas) for this f element<14> is:
sparklinegroup-formula = single-sheet-area / [single-sheet-prefix / book-prefix] name
Additionally, if a single-sheet-area is specified, that single-sheet-area MUST contain cells from either a single row or a single column. If the single-sheet-area contains cells from a single row, then the rows of the single-sheet-area MUST either both be relative or both be absolute.<15> If the single-sheet-area contains cells from a single column and multiple rows, then the columns of the single-sheet-area MUST either both be relative or both be absolute.
sparklines : A CT_Sparklines element that specifies properties for individual sparklines.
Attributes:
manualMax : A double ([XMLSCHEMA2] section 3.2.5) attribute that specifies the maximum for the vertical axis that is shared across all sparklines in this sparkline group. MUST be zero if maxAxisType does not equal custom.
manualMin : A double ([XMLSCHEMA2] section 3.2.5) attribute that specifies the minimum for the vertical axis that is shared across all sparklines in this sparkline group. MUST be zero if minAxisType does not equal custom.
lineWeight : A double ([XMLSCHEMA2] section 3.2.5) attribute that specifies the line weight for each sparkline in the sparkline group, where the line weight is measured in points. MUST be greater than or equal to zero, and MUST be less than or equal to 1584<16>.
type : An ST_SparklineType attribute that specifies the type of the sparkline group.
dateAxis : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that whether this sparkline group uses a date axis.
Value of dateAxis |
Meaning |
FALSE |
No date axis is specified for this sparkline group. |
TRUE |
A date axis is specified for this sparkline group. |
displayEmptyCellsAs : An ST_DispBlanksAs attribute that specifies how empty cells are plotted.
markers : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether data markers are displayed for each sparkline in this sparkline group.
high : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data points with the highest value are formatted differently for each sparkline in this sparkline group.
low : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data points with the lowest value are formatted differently for each sparkline in this sparkline group.
first : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the first data point is formatted differently for each sparkline in this sparkline group.
last : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the last data point is formatted differently for each sparkline in this sparkline group.
negative : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the negative data points are formatted differently for each sparkline in this sparkline group.
displayXAxis : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the horizontal axis is displayed for each sparkline in this sparkline group.
displayHidden : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether data in hidden cells are plotted for the sparklines in this sparkline group.
minAxisType : An ST_SparklineAxisMinMax attribute that specifies how the vertical axis minimums for the sparklines in this sparkline group are calculated.
maxAxisType : An ST_SparklineAxisMinMax attribute that specifies how the vertical axis maximums for the sparklines in this sparkline group are calculated.
rightToLeft : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether each sparkline in the sparkline group is displayed in a right-to-left manner.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.
<xsd:complexType name="CT_SparklineGroup">
<xsd:sequence>
<xsd:element name="colorSeries" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorNegative" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorAxis" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorMarkers" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorFirst" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorLast" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorHigh" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element name="colorLow" minOccurs="0" maxOccurs="1" type="x:CT_Color"/>
<xsd:element ref="xm:f" minOccurs="0" maxOccurs="1"/>
<xsd:element name="sparklines" type="CT_Sparklines" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="manualMax" type="xsd:double" use="optional"/>
<xsd:attribute name="manualMin" type="xsd:double" use="optional"/>
<xsd:attribute name="lineWeight" type="xsd:double" use="optional" default="0.75"/>
<xsd:attribute name="type" type="ST_SparklineType" use="optional" default="line"/>
<xsd:attribute name="dateAxis" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="displayEmptyCellsAs" type="ST_DispBlanksAs" use="optional" default="zero"/>
<xsd:attribute name="markers" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="high" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="low" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="first" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="last" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="negative" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="displayXAxis" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="displayHidden" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="minAxisType" type="ST_SparklineAxisMinMax" use="optional" default="individual"/>
<xsd:attribute name="maxAxisType" type="ST_SparklineAxisMinMax" use="optional" default="individual"/>
<xsd:attribute name="rightToLeft" type="xsd:boolean" use="optional" default="false"/>
</xsd:complexType>
See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.