Share via

2.6.30 CT_DataBar

  • Article

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

Referenced by: CT_CfRule

A complex type that specifies a data bar used in conditional formatting.

Child Elements:

cfvo: A CT_Cfvo element (section 2.6.26) that specifies the cell values corresponding to the min/max length of the data bar. If there exist CT_Cfvo ([ISO/IEC29500-4:2016] section A.2) elements in this sheet that are child elements of a CT_DataBar ([ISO/IEC29500-4:2016] section A.2) element that is a child of a CT_CfRule ([ISO/IEC29500-4:2016] section A.2) element that is a parent of a CT_ExtensionList ([ISO/IEC29500-4:2016] section A.2) element with a child CT_Extension ([ISO/IEC29500-4:2016] section A.2) element that has a child ST_Guid ([ISO/IEC29500-4:2016] section A.2) element equal to the id attribute of this complex type's parent CT_CfRule element (section 2.6.27), those CT_Cfvo elements SHOULD<14> be ignored. The first child CT_Cfvo element specifies the condition corresponding to the min length of the data bar. The second child CT_Cfvo element specifies the condition corresponding to the max length of the data bar.

fillColor: A CT_Color ([ISO/IEC29500-4:2016] section A.2) element that specifies the fill color of the data bar. This element MUST exist if and only if the priority attribute of the CT_CfRule that is a parent of this complex type exists.

borderColor: A CT_Color element that specifies the border color of the data bar. This element MUST exist if and only if border equals "true".

negativeFillColor: A CT_Color element that specifies the negative fill color of the data bar. This element MUST exist if and only if negativeBarColorSameAsPositive equals "false".

negativeBorderColor: A CT_Color element that specifies the negative border color of the data bar. This element MUST exist if and only if negativeBarBorderColorSameAsPositive equals "false" and border equals "true".

axisColor: A CT_Color element that specifies the axis color of the data bar. This element MUST exist if and only if axisPosition does not equal "none".

Attributes:

minLength: An unsignedInt ([XMLSCHEMA2/2] section 3.3.22) attribute that specifies the length of the shortest data bar in this conditional formatting range, expressed as a percentage of the width of the cell containing the data bar. MUST be greater than or equal to zero and less than or equal to maxLength. If, in this same worksheet part, there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is zero ("0") and the maxLength attribute of this element is "100", the minLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be "10". If in this same worksheet part there exists an CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is not zero ("0") or the maxLength attribute of this element is not "100", the minLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be equal to this complex type’s minLength.

maxLength: An unsignedInt attribute that specifies the length of the longest data bar in this conditional formatting range, expressed as a percentage of the width of the cell being formatted. MUST be greater than or equal to minLength and less than or equal to 100. If in this same worksheet part there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is zero ("0") and the maxLength attribute of this element is "100", the maxLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be "90". If, in this same worksheet part, there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is not zero ("0") or the maxLength attribute of this element is not "100", the maxLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be equal to this record’s maxLength.

showValue: A Boolean ([XMLSCHEMA2/2] section 3.2.2) attribute that specifies whether the cells in the conditional formatting range display both the data bar and the numeric value or only the data bar. The following table describes its possible values.

Value

Meaning

"false"

Only the data bar is displayed in the cell.

"true"

Both the data bar and the numeric value are displayed in the cell.

border: A Boolean ([XMLSCHEMA2/2] section 3.2.2) attribute that specifies whether the data bar has a border.

Value

Meaning

"true"

The data bar has a border.

"false"

The data bar has no border.

gradient: A Boolean ([XMLSCHEMA2/2] section 3.2.2) attribute that specifies whether the data bar has a gradient fill. The following table describes its possible values.

Value

Meaning

"false"

The data bar fill is a solid color.

"true"

The data bar fill is a gradient.

direction: An ST_DataBarDirection attribute section 2.7.7) that specifies the direction of the data bar.

negativeBarColorSameAsPositive: A Boolean ([XMLSCHEMA2/2] section 3.2.2) attribute that specifies whether the data bar has a negative bar color that is different from the positive bar color.

negativeBarBorderColorSameAsPositive: A Boolean ([XMLSCHEMA2/2] section 3.2.2) attribute that specifies whether the data bar has a negative border color that is different from the positive border color.

axisPosition: An ST_DataBarAxisPosition attribute (section 2.7.8) that specifies the axis position for the data bar.

The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this complex type.

 <xsd:complexType name="CT_DataBar">
   <xsd:sequence>
     <xsd:element name="cfvo" type="CT_Cfvo" minOccurs="2" maxOccurs="2"/>
     <xsd:element name="fillColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="borderColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="negativeFillColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="negativeBorderColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="axisColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>
   </xsd:sequence>
   <xsd:attribute name="minLength" type="xsd:unsignedInt" use="optional" default="10"/>
   <xsd:attribute name="maxLength" type="xsd:unsignedInt" use="optional" default="90"/>
   <xsd:attribute name="showValue" type="xsd:boolean" use="optional" default="true"/>
   <xsd:attribute name="border" type="xsd:boolean" use="optional" default="false"/>
   <xsd:attribute name="gradient" type="xsd:boolean" use="optional" default="true"/>
   <xsd:attribute name="direction" type="ST_DataBarDirection" use="optional" default="context"/>
   <xsd:attribute name="negativeBarColorSameAsPositive" type="xsd:boolean" use="optional" default="false"/>
   <xsd:attribute name="negativeBarBorderColorSameAsPositive" type="xsd:boolean" use="optional" default="true"/>
   <xsd:attribute name="axisPosition" type="ST_DataBarAxisPosition" use="optional" default="automatic"/>
 </xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).