MicroStrategy ONE

Transitions Configuration File XML Structure

The transitions configuration file contains the list of transition animations that can be applied to a grid or a graph for display in Flash mode.

Transition are generally provided in the transitions.xml file, but they can also be included within pageConfig.xml. The recommended practice is to use a separate configuration file to ensure that your customizations are correctly propagated in future upgrades. You use the same XML structure whether you make the settings in transitions.xml or in pageConfig.xml.

A sample of the XML structure for transitions.xml is shown below, followed by a description of the elements and attributes that make up the file.

XML structure

<transitions>

   <transitionid="Auto" title="Automatic" titleId="mstrWeb.4946" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="GlowWithBlur" title="Glow with Blur" titleId="mstrWeb.4904" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="Glow" title="Glow" titleId="mstrWeb.4905" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="Blur" title="Blur" titleId="mstrWeb.4906" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="Iris" title="Iris" titleId="mstrWeb.4907" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="WipeDown" title="Wipe Down" titleId="mstrWeb.4908" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="WipeUp" title="Wipe Up" titleId="mstrWeb.4909" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="WipeLeft" title="Wipe Left" titleId="mstrWeb.4910" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="WipeRight" title="Wipe Right" titleId="mstrWeb.4911" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="Fade" title="Fade" titleId="mstrWeb.4912" defaultSpeed="1000" scope="52|1,52|2,111,8" />

   <transition id="ZoomBlur" title="Zoom and Blur" titleId="mstrWeb.4913" defaultSpeed="1000" scope="52|1,52|2,111,8" />

</transitions>

Description

The table below describes the XML structure of the widgets configuration file. The four columns in the table include the following descriptive information:

Parent Element

- Child Element 1

- Child Element 2

Indicates the name of the element described in the next three columns. If this is a parent element, the names of all possible child elements are listed below the parent element.

Number of Nodes

Specifies the number of nodes that are required or allowed for the corresponding element in the Parent Element column. For example, if the value is "1", there must be only one node— no more, no less. If the value is "0 or more", the node is not required ("0"), but there is no restriction on the number of nodes that can be added ("or more"). If the value is "1 or more", the node is required ("1"), but there is no restriction on the number of nodes that can be added ("or more").  

Parent Element Attributes

Lists the separate attributes that can be used with the corresponding element in the Parent Element column. Included in parentheses beneath each attribute name are the attribute type and an indication of whether the attribute is required or implied. For example, the version attribute for the <transitions> element has an attribute type of "nmtoken" (name token) and is implied. The title attribute for the <transition> element has an attribute type of "cdata" (character data) and is required.

Description

Describes either a parent element in the Parent Element column or an attribute in the Parent Element Attributescolumn.

Parent Element

- Child Element 1

- Child Element 2

Number of Nodes Parent Element Attributes Description

<transitions>

- <transition>

0 or 1

 

 

The <transitions> element groups a list of transition animations that can be applied to grids or graphs when displayed in Flash mode.

config-src

(cdata / implied)

If the transitions are defined in a separate file, the config-src attribute tells the page configuration file the location of the transitions configuration file.

version

(nmtoken / implied)

If the transitions  are defined in a separate file, the version attribute indicates the release number of the transitions configuration file. This attribute is useful for backwards compatibility because it lets the application know what features are available.

<transition>

 

 

 

 

1 or more

 

 

The <transition> element defines the properties of a single transition animation.

id

(id / required)

The id attribute is the unique id for the transition.

title

(cdata / implied)

 

The title attribute indicates the name displayed in the drop down (if no descriptor is specified in titleId).

 

titleId

(cdata / implied)

The titleId attribute provides a descriptor ID, which can be used for localization. This is the key of the string from the MessageBundles.properties file with the localized description of the visualization. For example, desc-id="scenario1.1".

defaultSpeed

(cdata / implied)

The defaultSpeed attribute sets the speed for the transition animation.

scope

(cdata / implied)

The scope attribute represents the field unit type value for the underlying document object. For a list of possible values, refer to com.microstrategy.web.objects.rw.EnumRWUnitTypes.

See also