Axis Element (XMLA)

APPLIES TO:yesSQL Server Analysis ServicesyesAzure Analysis Services

Contains a set of tuples used to represent a single axis in a multidimensional dataset contained by an Axes element that uses the MDDataSet data type, returned by the Execute method.

Syntax


<Axes>  
   ...  
   <Axis> <!-- when AxisFormat XMLA property is set to ClusterFormat -->  
      <CrossProduct>...</CrossProduct>  
   </Axis>  
   <Axis> <!-- when AxisFormat XMLA property is set to TupleFormat or CustomFormat -->  
      <Tuples>...</Tuples>  
   </Axis>  
   ...  
</Axes>  

Element Characteristics

Characteristic Description
Data type and length None
Default value None
Cardinality 0-n: Optional element that can occur more than once.

Element Relationships

Relationship Element
Parent elements Axes
Child elements CrossProduct or Tuples

Remarks

The content of the Axis element varies depending on the value of the AxisFormat XMLA property used by the Execute method.

TupleFormat

When a client application sets the AxisFormat property to TupleFormat, an axis is represented as a set of tuples. Each Axis element contains a Tuples element that represents the set of tuples on that axis. Each tuple is represented by using a Tuple element that contains Member elements from every hierarchy on the axis.

ClusterFormat

When a client application sets the AxisFormat property to ClusterFormat, the members on each axis are divided into clusters in which each cluster represents a cross-product between ordered sets of members from each hierarchy. Each Axis element consists of one or more CrossProduct elements. Every CrossProduct element contains a Members element for each hierarchy on the axis.

CustomFormat

When a client application sets the AxisFormat property to CustomFormat, the value is treated the same as the TupleFormat value by an Analysis Services instance.

Examples

Description

The following example illustrates the structure of the Axis elements when a client specifies TupleFormat or CustomFormat for the AxisFormat XMLA property, given the following members for the axis:

Time hierarchy 1999 1999 2000
Category hierarchy Actual Budget Budget

Code

<Axes>  
   <Axis name="Axis0">  
      <Tuples>  
         <Tuple>  
            <Member Hierarchy="Time">  
               <UName>[Time].[1999]</UName>  
               ...  
            </Member>  
            <Member Hierarchy="Category">  
               <UName>[Scenario].[Actual]</UName>  
               ...  
            </Member>  
         </Tuple>  
         <Tuple>  
            <Member Hierarchy="Time">  
               <UName>[Time].[1999]</UName>  
               ...  
            </Member>  
            <Member Hierarchy="Category">  
               <UName>[Scenario].[Budget]</UName>  
               ...  
            </Member>  
         </Tuple>  
         <Tuple>  
            <Member Hierarchy="Time">  
               <UName>[Time].[2000]</UName>  
               ...  
            </Member>  
            <Member Hierarchy="Category">  
               <UName>[Scenario].[Budget]</UName>  
               ...  
            </Member>  
         </Tuple>  
      </Tuples>  
   </Axis>  
   ...  
</Axes>  

Description

The following example illustrates the structure of the Axis elements when a client specifies ClusterFormat for the AxisFormat XMLA property, given the following members for the axis:

Time hierarchy 1999 1999 2000 2001
Category hierarchy Actual Budget Budget Budget
Clusters Cluster 1 Cluster 1 Cluster 1 Cluster 2

Code

<Axes>  
   <Axis name="Axis0">  
      <CrossProduct Size = "4">  
         <Members Hierarchy="Time">  
            <Member>  
               <UName>[Time].[1999]</UName>  
               ...  
            </Member>  
            <Member>  
               <UName>[Time].[2000]</UName>  
               ...  
            </Member>  
         </Members>  
         <Members Hierarchy="Category">  
            <Member>  
               <UName>[Scenario].[Actual]</UName>  
               ...  
            </Member>  
            <Member>  
               <UName>[Scenario].[Budget]</UName>  
               ...  
            </Member>  
         </Members>  
      </CrossProduct>  
      <CrossProduct Size = "1">  
         <Members Hierarchy="Time">  
            <Member>  
               <UName>[Time].[2001]</UName>  
               ...  
            </Member>  
         </Members>  
         <Members Hierarchy="Category">  
            <Member>  
               <UName>[Scenario].[Budget]</UName>  
               ...  
            </Member>  
         </Members>  
      </CrossProduct>  
   </Axis>  
   ...  
</Axes>  

See Also

Properties (XMLA)