SparklineGroup Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the SparklineGroup Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is x14:sparklineGroup.

public class SparklineGroup : DocumentFormat.OpenXml.OpenXmlCompositeElement

type SparklineGroup = class
    inherit OpenXmlCompositeElement

Public Class SparklineGroup
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

SparklineGroup

Remarks

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).

Constructors

SparklineGroup()	Initializes a new instance of the SparklineGroup class.
SparklineGroup(IEnumerable<OpenXmlElement>)	Initializes a new instance of the SparklineGroup class with the specified child elements.
SparklineGroup(OpenXmlElement[])	Initializes a new instance of the SparklineGroup class with the specified child elements.
SparklineGroup(String)	Initializes a new instance of the SparklineGroup class from outer XML.

Properties

AxisColor	AxisColor. Represents the following element tag in the schema: x14:colorAxis.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DateAxis	dateAxis, this property is only available in Office 2010 and later. Represents the following attribute in the schema: dateAxis
DisplayEmptyCellsAs	displayEmptyCellsAs, this property is only available in Office 2010 and later. Represents the following attribute in the schema: displayEmptyCellsAs
DisplayHidden	displayHidden, this property is only available in Office 2010 and later. Represents the following attribute in the schema: displayHidden
DisplayXAxis	displayXAxis, this property is only available in Office 2010 and later. Represents the following attribute in the schema: displayXAxis
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
First	first, this property is only available in Office 2010 and later. Represents the following attribute in the schema: first
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FirstMarkerColor	FirstMarkerColor. Represents the following element tag in the schema: x14:colorFirst.
Formula	Formula. Represents the following element tag in the schema: xne:f.
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
High	high, this property is only available in Office 2010 and later. Represents the following attribute in the schema: high
HighMarkerColor	HighMarkerColor. Represents the following element tag in the schema: x14:colorHigh.
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
Last	last, this property is only available in Office 2010 and later. Represents the following attribute in the schema: last
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LastMarkerColor	LastMarkerColor. Represents the following element tag in the schema: x14:colorLast.
LineWeight	lineWeight, this property is only available in Office 2010 and later. Represents the following attribute in the schema: lineWeight
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
Low	low, this property is only available in Office 2010 and later. Represents the following attribute in the schema: low
LowMarkerColor	LowMarkerColor. Represents the following element tag in the schema: x14:colorLow.
ManualMax	manualMax, this property is only available in Office 2010 and later. Represents the following attribute in the schema: manualMax
ManualMin	manualMin, this property is only available in Office 2010 and later. Represents the following attribute in the schema: manualMin
Markers	markers, this property is only available in Office 2010 and later. Represents the following attribute in the schema: markers
MarkersColor	MarkersColor. Represents the following element tag in the schema: x14:colorMarkers.
MaxAxisType	maxAxisType, this property is only available in Office 2010 and later. Represents the following attribute in the schema: maxAxisType
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MinAxisType	minAxisType, this property is only available in Office 2010 and later. Represents the following attribute in the schema: minAxisType
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
Negative	negative, this property is only available in Office 2010 and later. Represents the following attribute in the schema: negative
NegativeColor	NegativeColor. Represents the following element tag in the schema: x14:colorNegative.
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RightToLeft	rightToLeft, this property is only available in Office 2010 and later. Represents the following attribute in the schema: rightToLeft
SeriesColor	SeriesColor. Represents the following element tag in the schema: x14:colorSeries.
Sparklines	Sparklines. Represents the following element tag in the schema: x14:sparklines.
Type	type, this property is only available in Office 2010 and later. Represents the following attribute in the schema: type
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)