analytics/schemas/visualization/ChartInstance_1.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--
	Licensed Materials - Property of IBM
	IBM Cognos Products: vgs
	(C) Copyright IBM Corp. 2013
	US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.ibm.com/xmlns/prod/ba/visBundle/chartInstance.1/" targetNamespace="http://www.ibm.com/xmlns/prod/ba/visBundle/chartInstance.1/" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="chartInstance">
		<xs:annotation>
			<xs:documentation>Comment describing your root element</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:all>
				<xs:element name="dataSetInstances" minOccurs="0">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="dataSetInstance" maxOccurs="unbounded">
								<xs:annotation>
									<xs:documentation>Data is given to the output service is the form of a table. The columns of the table represent the fields used in dataSet definition. </xs:documentation>
								</xs:annotation>
								<xs:complexType>
									<xs:all>
										<xs:element name="dataSetFields" minOccurs="0">
											<xs:annotation>
												<xs:documentation>The fields used in the dataSet defintion. The order of these fields must match the order in the dataSetData representation.</xs:documentation>
											</xs:annotation>
											<xs:complexType>
												<xs:sequence>
													<xs:choice maxOccurs="unbounded">
														<xs:element name="categoryField">
															<xs:complexType>
																<xs:all>
																	<xs:element ref="fieldPropertyValues" minOccurs="0"/>
																	<xs:element ref="label" minOccurs="0"/>
																</xs:all>
																<xs:attribute name="name" type="xs:string" use="required"/>
															</xs:complexType>
														</xs:element>
														<xs:element name="valueField">
															<xs:annotation>
																<xs:documentation>The min, max attributes represent the range of data that this field should be visualized within.</xs:documentation>
															</xs:annotation>
															<xs:complexType>
																<xs:all>
																	<xs:element ref="fieldPropertyValues" minOccurs="0"/>
																	<xs:element ref="label" minOccurs="0"/>
																	<xs:element ref="dataFormat" minOccurs="0">
																		<xs:annotation>
																			<xs:documentation>Default data formatting for the field values. Overriden by any formatted specified for the rows of the field.</xs:documentation>
																		</xs:annotation>
																	</xs:element>
																	<xs:element name="dataFormatForRows" minOccurs="0">
																		<xs:complexType>
																			<xs:sequence>
																				<xs:element name="dataFormatForRow" maxOccurs="unbounded">
																					<xs:annotation>
																						<xs:documentation>Data format to be used for a specific row in the data for this field</xs:documentation>
																					</xs:annotation>
																					<xs:complexType>
																						<xs:all>
																							<xs:element ref="dataFormat">
																								<xs:annotation>
																									<xs:documentation>Default data formatting for the field values. Overriden by any formatted specified for the rows of the field.</xs:documentation>
																								</xs:annotation>
																							</xs:element>
																						</xs:all>
																						<xs:attribute name="rows" use="required">
																							<xs:simpleType>
																								<xs:restriction base="xs:string">
																									<xs:pattern value="[0-9]+[0-9,]*"/>
																								</xs:restriction>
																							</xs:simpleType>
																						</xs:attribute>
																					</xs:complexType>
																				</xs:element>
																			</xs:sequence>
																		</xs:complexType>
																	</xs:element>
																</xs:all>
																<xs:attribute name="name" type="xs:string" use="required"/>
																<xs:attribute name="min" type="xs:decimal"/>
																<xs:attribute name="max" type="xs:decimal"/>
															</xs:complexType>
														</xs:element>
													</xs:choice>
												</xs:sequence>
											</xs:complexType>
											<xs:unique name="dataSetFieldUniqueness">
												<xs:selector xpath="*"/>
												<xs:field xpath="@name"/>
											</xs:unique>
										</xs:element>
										<xs:element name="dataSetData">
											<xs:annotation>
												<xs:documentation>JSON structure that represents the data for the vizualization. rowData section is the table of data to be vizualized. Any categorical values are referenced by index in the categoryData section.</xs:documentation>
											</xs:annotation>
											<xs:simpleType>
												<xs:restriction base="xs:string">
													<xs:whiteSpace value="preserve"/>
												</xs:restriction>
											</xs:simpleType>
										</xs:element>
									</xs:all>
									<xs:attribute name="name" type="xs:string" use="required"/>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
					<xs:unique name="dataSetUniqueness">
						<xs:selector xpath="*"/>
						<xs:field xpath="@name"/>
					</xs:unique>
				</xs:element>
				<xs:element name="chartPropertyValues" minOccurs="0">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="chartPropertyValue" maxOccurs="unbounded">
								<xs:complexType>
									<xs:simpleContent>
										<xs:extension base="xs:string">
											<xs:attribute name="name" type="xs:string" use="required"/>
										</xs:extension>
									</xs:simpleContent>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
					<xs:unique name="chartPropertyUniqueness">
						<xs:selector xpath="*"/>
						<xs:field xpath="@name"/>
					</xs:unique>
				</xs:element>
				<xs:element ref="dataFormat" minOccurs="0">
					<xs:annotation>
						<xs:documentation>Default data formatting to be used for values in the chart. Overridden if more specific formatting can be found.</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:all>
			<xs:attribute name="type" type="xs:string" use="required"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="fieldPropertyValues">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="fieldPropertyValue" maxOccurs="unbounded">
					<xs:complexType>
						<xs:simpleContent>
							<xs:extension base="xs:string">
								<xs:attribute name="name" type="xs:string" use="required"/>
							</xs:extension>
						</xs:simpleContent>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
		<xs:unique name="fieldPropertyUniqueness">
			<xs:selector xpath="*"/>
			<xs:field xpath="@name"/>
		</xs:unique>
	</xs:element>
	<xs:element name="label" type="TextType"/>
	<xs:element name="dataFormat">
		<xs:complexType>
			<xs:choice>
				<xs:element name="numberFormat">
					<xs:annotation>
						<xs:documentation>Defines attributes of the decimal numeric format. In addition to the attributes for an integer numeric format, decimal format supports decimal digits, delimiter and scientific notation.</xs:documentation>
						<xs:documentation source="ebnf/EBNF_LayoutPatterns.xml#NumberFormat"/>
					</xs:annotation>
					<xs:complexType>
						<xs:attribute name="useScientific" type="xs:boolean">
							<xs:annotation>
								<xs:documentation>Boolean flag to render value in scientific notation; that is, "0.123 E+03". When true, numeric value will be rendered in scientific notation. Otherwise, value will be rendered in decimal format whenever possible, as suggested by the precision attribute. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="exponentSize" type="xs:nonNegativeInteger">
							<xs:annotation>
								<xs:documentation>Count of digits to be displayed following the exponent symbol when rendering in scientific notation. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="exponentSymbol" type="xs:string">
							<xs:annotation>
								<xs:documentation>Character(s) to be displayed as exponent symbol when rendering in scientific notation. Will be rendered following numeric value (mantissa), separated by a space. If a space is desired between symbol and exponent value, it should be included in this attribute. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attributeGroup ref="CommonFormatAttributes"/>
						<xs:attributeGroup ref="DecimalFormatAttributes"/>
						<xs:attributeGroup ref="CommonNonStringFormatAttributes"/>
					</xs:complexType>
				</xs:element>
				<xs:element name="currencyFormat">
					<xs:annotation>
						<xs:documentation>Defines attributes of a numeric currency format.</xs:documentation>
						<xs:documentation source="ebnf/EBNF_LayoutPatterns.xml#NumberFormat"/>
					</xs:annotation>
					<xs:complexType>
						<xs:attribute name="currencyCode" type="xs:string">
							<xs:annotation>
								<xs:documentation>Unique code that identifies currency. ISO 4217 country code is recommended. When omitted, currency is identified by what the query engine can infer from the model for the dataItem and if nothing then it uses the currency associated with the user's content locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="currencySymbol" type="xs:string">
							<xs:annotation>
								<xs:documentation>Character code to be displayed to identify local currency of numeric value. These character will be precede the numeric value and any [leading] sign. If a blank character is desired between numeric value and this symbol, it should be specified in this attribute. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="intlCurrencySymbol" type="xs:string">
							<xs:annotation>
								<xs:documentation>Character code to be displayed to identify international currency of numeric value. These character will be precede the numeric value and any [leading] sign. If a blank character is desired between numeric value and this symbol, it should be specified in this attribute. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="useIntlSymbol" type="xs:boolean">
							<xs:annotation>
								<xs:documentation>When "true", international currency symbol will be used instead of local currency symbol. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="useTrailingSymbol" type="xs:boolean">
							<xs:annotation>
								<xs:documentation>When "true", characters in [international] currency symbol attribute will be appended to the numeric value and any trailing sign. Any whitespace characters at end of chosen symbol attribute value will be rendered between numeric value and trailing sign. Default value is inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attributeGroup ref="CommonFormatAttributes"/>
						<xs:attributeGroup ref="DecimalFormatAttributes"/>
						<xs:attributeGroup ref="CommonNonStringFormatAttributes"/>
					</xs:complexType>
				</xs:element>
				<xs:element name="percentFormat">
					<xs:annotation>
						<xs:documentation>Defines attributes of a numeric percentage or per mille format.</xs:documentation>
						<xs:documentation source="ebnf/EBNF_LayoutPatterns.xml#NumberFormat"/>
					</xs:annotation>
					<xs:complexType>
						<xs:attribute name="percentSymbol" type="xs:string">
							<xs:annotation>
								<xs:documentation>Characters to be displayed to identify precent or per mille value. These characters will be appended to the numeric value and any trailing sign. If a blank character is desired between numeric value and this trailing symbol, it should be specified in this attribute. If omitted, symbol will be inherited from user's locale.</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attribute name="percentScale" type="xs:nonPositiveInteger">
							<xs:annotation>
								<xs:documentation>Scale to be applied to value after formatting.  If omitted, no percent scale will be applied and the value will formatted according the normal decimal positioning associated with the percent (or permille) symbol.
</xs:documentation>
							</xs:annotation>
						</xs:attribute>
						<xs:attributeGroup ref="CommonFormatAttributes"/>
						<xs:attributeGroup ref="DecimalFormatAttributes"/>
						<xs:attributeGroup ref="CommonNonStringFormatAttributes"/>
					</xs:complexType>
				</xs:element>
			</xs:choice>
		</xs:complexType>
	</xs:element>
	<xs:simpleType name="TextType">
		<xs:annotation>
			<xs:documentation>A simple text type that preserves whitespace</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:whiteSpace value="preserve"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:attributeGroup name="CommonFormatAttributes">
		<xs:attribute name="whenMissing" type="xs:string">
			<xs:annotation>
				<xs:documentation>Characters to be displayed when value to be formatted is missing. If omitted, an empty string is displayed.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:attributeGroup>
	<xs:attributeGroup name="IntegerFormatAttributes">
		<xs:attribute name="sign" type="xs:string">
			<xs:annotation>
				<xs:documentation>Specifies which character or characters to display before negative numeric values. To display a space between a negative sign and the numeric value, specify it in this attribute. The default value will be inherited from the user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="useTrailingSign" type="xs:boolean">
			<xs:annotation>
				<xs:documentation>When "true", the characters indicated by "sign" attribute will be appended to numeric value. Any whitespace characters at end of sign attribute value will be rendered between numeric value and [trailing] sign. When "false", sign attribute value will precede numeric value. Default value will be inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="maxDigits" type="xs:nonNegativeInteger">
			<xs:annotation>
				<xs:documentation>Maximum count of digits to be displayed on the left-hand side of decimal point. If value exceeds this limitation, scientific notation will be used. Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="minDigits" type="xs:nonNegativeInteger">
			<xs:annotation>
				<xs:documentation>Minimum count of digits to be displayed on the left-hand side of decimal point. If value to be formatted has fewer digits than this limitation, padding characters will be applied to left side of formatted value until minimum digit count is achieved. Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="paddingCharacter" type="xs:string">
			<xs:annotation>
				<xs:documentation>When magnitude of value is less than minimum digits attribute, padding characters will be prepended to value until minimum digits restriction is satisfied. Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="scale" type="xs:short">
			<xs:annotation>
				<xs:documentation>Number of digits to shift decimal place from actual location for formatting purposes. This attribute is handy when displaying values in "thousands of dollars", or when whole numbers are stored in the database, but they actually represent values with X decimal places. Positive values shift the decimal place to the right, whereas negative values shift the decimal point to the left. Default value is inherited from database column.</xs:documentation>
				<xs:documentation source="doc_att_format_scale"/>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="useGrouping" type="xs:boolean">
			<xs:annotation>
				<xs:documentation>When "true", grouping delimiter is applied as defined by grouping size attributes. Default value will be inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="groupDelimiter" type="xs:string">
			<xs:annotation>
				<xs:documentation>Character delimiter for digit groups. Also known as "thousands separator", this delimiter is applicable only when digit grouping is enabled (i.e. groupDigits attribute is non-zero). Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="groupSize" type="xs:positiveInteger">
			<xs:annotation>
				<xs:documentation>This is the primary grouping size, which represents the count of digits left of the decimal point to be grouped together and separated by groupDelimiter character. Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="groupSecondarySize" type="xs:positiveInteger">
			<xs:annotation>
				<xs:documentation>Some locales support a secondary grouping size that is applied to the left of the primary group. If specified, this attribute is the count of digits left of [primary] digit group that should be grouped together and separated by groupDelimiter character. If omitted, seconday grouping of digits is same as primary grouping [see groupSize attribute].</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="whenNegative" type="xs:string">
			<xs:annotation>
				<xs:documentation source="http://www-124.ibm.com/icu/apiref/classDecimalFormat.html#_details">Negative numeric format; 'pattern' attribute is used for positive numbers. Some restrictions apply (see http://www-124.ibm.com/icu/apiref/classDecimalFormat.html#_details).</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="whenZero" type="xs:string">
			<xs:annotation>
				<xs:documentation>Characters to be displayed when numeric value is zero. If omitted, significance attribute determines number of zeroes to display.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:attributeGroup>
	<xs:attributeGroup name="DecimalFormatAttributes">
		<xs:attribute name="decimalSize" type="xs:nonNegativeInteger">
			<xs:annotation>
				<xs:documentation>Count of digits to be displayed to right of decimal point. If omitted, fractional [decimal] digits will be displayed as required.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="decimalDelimiter" type="xs:string">
			<xs:annotation>
				<xs:documentation>Character delimiter between whole and fractional components of a floating-point number. Also known as "decimal point", this delimiter is applicable only when fractional digits are presented (i.e. decimals attribute is non-zero). Default value is inherited from user's locale.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attributeGroup ref="IntegerFormatAttributes"/>
	</xs:attributeGroup>
	<xs:attributeGroup name="CommonNonStringFormatAttributes">
		<xs:annotation>
			<xs:documentation>These attributies define the common properties for non-string formats.</xs:documentation>
		</xs:annotation>
		<xs:attribute name="digitShaping">
			<xs:annotation>
				<xs:documentation>The digit shape or system used for displaying numbers. If omitted, the numbers will be nationally shaped.</xs:documentation>
			</xs:annotation>
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="national">
						<xs:annotation>
							<xs:documentation>Digits will be shaped according to the locale.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
					<xs:enumeration value="none">
						<xs:annotation>
							<xs:documentation>No digit shaping is performed.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
	</xs:attributeGroup>
</xs:schema>