complexType "GridDimensionType"
Namespace:
ddi:datacollection:3_3
Content:
complex, 3 attributes, 3 elements
Defined:
globally in datacollection.xsd; see XML source
Includes:
definitions of 3 attributes, 3 elements
Used:
at 1 location
XML Representation Summary
<...
   
rank
 = 
xs:nonNegativeInteger
displayCode
 = 
xs:boolean : "true"
displayLabel
 = 
xs:boolean : "true"
   
>
   
Content: 
(CodeDomain | Roster), CreateSummary?
</...>
All Direct / Indirect Based Elements (1):
GridDimension
Known Usage Locations
Annotation
Describes each dimension of the grid including dimension rank (for the purpose of identifying a cell address), a text for the dimension, and optional labels and codes used as column and row stubs. May also describe a roster (a set of unlabeled rows or columns depending upon display situation).
XML Source (w/o annotations (7); see within schema source)
<xs:complexType name="GridDimensionType">
<xs:sequence>
<xs:choice>
<xs:element ref="CodeDomain"/>
<xs:element ref="Roster"/>
</xs:choice>
<xs:element minOccurs="0" ref="CreateSummary"/>
</xs:sequence>
<xs:attribute name="rank" type="xs:nonNegativeInteger" use="required"/>
<xs:attribute default="true" name="displayCode" type="xs:boolean"/>
<xs:attribute default="true" name="displayLabel" type="xs:boolean"/>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 3/3)
displayCode
Type:
xs:boolean, predefined
Use:
optional
If set to "true" (default value) the code value associated with the category label will be displayed. Set to "false" if only the category label should not be displayed.
Attribute Value
Default:
"true"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="true" name="displayCode" type="xs:boolean"/>
displayLabel
Type:
xs:boolean, predefined
Use:
optional
If set to "true" (default value) the label of the CodeList will be displayed. Set to "false" to suppress this display.
Attribute Value
Default:
"true"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="true" name="displayLabel" type="xs:boolean"/>
rank
Type:
xs:nonNegativeInteger, predefined
Use:
required
The rank order of this dimension (the order in which the value for this dimension will appear in the cell address)denoted with a 1-based indexing. Provides coordinate order (1,2,n) for the intersect point of this dimension within the cell address. For example, if the rank of this dimension is 2, the intersect point on this dimension will be the second value listed in the cell address.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="rank" type="xs:nonNegativeInteger" use="required"/>
Content Element Detail (all declarations; defined within this component only; 3/3)
CodeDomain
Type:
CodeDomainType, complex content
This includes a reference to a CodeList that is used for the labels contained in the dimension. CodeLists are used even when the code is not being displayed in order to use this information for creating the cell coordinate address.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="CodeDomain"/>
CreateSummary
Type:
CreateSummaryType, complex content
Note that this is generally usable only with single valid response domain in grid. More complex uses should be carefully documented using details in CommandCode and Input/output Parameters.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="CreateSummary"/>
Roster
Type:
RosterType, complex content
A roster is an unlabeled list of numbered rows or columns depending upon orientation. The numbers may or may not be displayed but will be used as information for creating the cell coordinate address.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="Roster"/>
XML schema documentation generated with DocFlex/XML 1.12 using DocFlex/XML XSDDoc 2.9.0 template set