SparklineGroup class

Office 2013 and later

Defines the SparklineGroup Class.This class is available in Office2010 or above. When the object is serialized out as xml, its qualified name is x14:sparklineGroup.

Namespace:  DocumentFormat.OpenXml.Office2010.Excel
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

No code example is currently available or this language may not be supported.

2.6.7 CT_SparklineGroup

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: CT_SparklineGroups

CT_SparklineGroup is 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 element MUST NOT exist.

colorNegative: A CT_Color element that specifies the color of the negative data points for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorAxis: A CT_Color element that specifies the color of the horizontal axis for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorMarkers: A CT_Color element that specifies the color of the data markers for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorFirst: A CT_Color element that specifies the color of the first data point for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorLast: A CT_Color element that specifies the color of the last data point for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorHigh: A CT_Color element that specifies the color of the highest data point for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

colorLow: A CT_Color element that specifies the color of the lowest data point for each sparkline in this sparkline group. The auto attribute of the CT_Color element MUST NOT exist.

xm:f: An f element (section 2.4.3) that specifies the date range for the sparkline group. The syntax, as specified in section 2.2.2, for this f element is the following:

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 (2) or a single column (2).

sparklines: A CT_Sparklines element (section 2.6.8) 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. This attribute MUST NOT exist if maxAxisType does not equal "custom".

manualMin: A double attribute that specifies the minimum for the vertical axis that is shared across all sparklines in this sparkline group. This attribute MUST NOT exist if minAxisType does not equal "custom".

lineWeight: A double 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.

type: An ST_SparklineType attribute (section 2.7.5) that specifies the type of the sparkline group.

dateAxis: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies 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 (section 2.7.3) 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 (section 2.7.4) 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.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: