Portlet XML Formatting

From MT Marvelit
Revision as of 01:29, 27 September 2006 by Rmortensen (Talk | contribs)

Jump to: navigation, search

Chart XML Tags

On the Chart Portlet - there is a field to enter XML. The format of the XML is as follows:

marvelitchart [Attributes:

  • percentvalues=‚Äùtrue|false‚Äù (pie charts only)]

value-axis [Attributes:

  • low=‚Äù{number}‚Äù
  • high=‚Äù{number}‚Äù
  • ticks=‚Äù{number}‚Äù
  • label=‚Äùtext‚Äù
  • include0=‚Äùtrue|false‚Äù]

category-axis [Attributes:

  • low=‚Äù{number}‚Äù
  • high=‚Äù{number}‚Äù
  • ticks=‚Äù{number}‚Äù
  • label=‚Äùtext‚Äù
  • angle=‚Äùtrue|false‚Äù]

section [Attributes:

  • number=‚Äù{number}
  • color=‚Äù#000000‚Äù
  • explode=‚Äù{percent}‚Äù]

alt-section [Attributes:

  • number=‚Äù{number}
  • color=‚Äù#000000‚Äù]

columnlist (See Report XML)

Simple Example

<marvelitchart percentvalues="false">
<value-axis low="5" high="50" ticks="11" label="val label" include0="false"/>
<category-axis low="-1" high="10" ticks="2.5" label="cat label" angle="45"/>
<section number="0" color="#0000FF" explode=".30" />
<alt-section number="0" color="#0000FF" />
</marvelitchart>


Notes

  • section.explode only applies to pie charts (2d and 3d)
  • alt-section is for overlays
  • The number field for section and alt-section are integers starting with 0
  • include0 = false allows the base of the chart to be a high number. This is useful when all values are of a similarly high value.


Chart XML Examples

Report XML Tags

On the Report and Meter Portlet - there is a field to enter XML. The format of the XML is as follows:

columnformatlist column [Attributes:

  • name=‚Äùcolumnname|number|*‚Äù]

lever [Attributes:

  • name=‚Äùcolumnname|default‚Äù
  • value=‚Äùlever value‚Äù]

threshold [Attributes:

  • field=‚Äùcolumnname|number‚Äù
  • value=‚Äùvalue‚Äù
  • type=‚Äùstring|date|number‚Äù]
  • format (ex: $ ###.00)
  • link (ex: http://www.marvelit.com/)
  • style (css style name)
  • imageurl [Attributes:
  • alt=‚Äùalternate‚Äù]

Simple Example

Example: <columnlist>
<column name="*">
<lever name="default">
<threshold field="State" value="CA" type="string">
<style><![CDATA[color: 0000FF;font-weight: bold;]]></style>
</threshold>
<threshold field="State" value="NY" type="string">
<style><![CDATA[color: red;font-weight: bold;]]></style>
</threshold>
</lever>
</column>
<column name="State">
<lever name="default">
<threshold field="State" value="CA" type="string">
<imageurl>/marvelit/images/CA.jpg</imageurl>
</threshold>
<threshold field="State" value="NY" type="string">
<imageurl>/marvelit/images/NY.jpg</imageurl>
</threshold>
</lever>
</column>
</columnlist>

In this example, There are 2 column tags. The first is a default for all columns that sets the text color for all rows for the state of “CA” to 0000FF and bold and all rows for “NY” to red and bold. Then for the “State” column, it displays an image “CA.jpg” instead of the value of the “State” column when it is “CA”, and “NY.jpg” for “NY

Report XML Examples