Difference between revisions of "Portlet XML Formatting"

Revision as of 03:36, 27 September 2006 (view source) Rmortensen (Talk | contribs) (→‎Chart XML Examples) ← Older edit		Revision as of 03:39, 27 September 2006 (view source) Rmortensen (Talk | contribs) (→‎Chart XML Examples) Newer edit →
Line 36:		Line 36:
	=== Chart XML Examples ===		=== Chart XML Examples ===
−	<br><br><br><br><br><br>
	[[Image:Chartxmlexample1.jpg|300px|thumb]]		[[Image:Chartxmlexample1.jpg|300px|thumb]]

---

Revision as of 03:39, 27 September 2006

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)

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

Example #1 - Offset Pie Chart

<marvelitchart percentvalues="true">
<section number="0" color="#0000FF" explode=".50" />
<section number="1" color="#00FF00" explode=".05" />
<section number="2" color="#FF0000" explode=".05"/>
<section number="3" color="#FFFF00" explode=".05"/>
<section number="4" color="#FF00FF" explode=".05" />
</marvelitchart>

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‚Äù]

Notes

• Columns can be listed by name or by number. Use ‚Äò*‚Äô to signify all columns.
• The lever tag allows specific settings when certain levers are used.
• Use ‚Äúdefault‚Äù to signify all levers. The default lever tag will be used when no specific levers are found.
• The threshold tag is used to test conditions.
• String values are triggered when the specified column = the value of the threshold.
• Dates and Numbers are triggered when the specified column >= the value of the threshold.
• Use value=‚Äú‚Äù to signify all values

Report XML Examples

Example #1 - Colors with thresholds

<columnlist>
<column name='*'>
<lever name='default'>

<threshold field="Percent" value='0' type='double'> <style><![CDATA[color: white;font-weight: bold;background-color: #00CC00;border-bottom-width: thin;border-bottom-style: solid;]]></style> </threshold>

<threshold field="Percent" value='50' type='double'> <style><![CDATA[;font-weight: bold;background-color: #CC0000;border-bottom-width: thin;border-bottom-style: solid;]]></style> </threshold>

<threshold field="Percent" value='40' type='double'> <style><![CDATA[color: white;font-weight: bold;background-color: #FF9900;border-bottom-width: thin;border-bottom-style: solid;]]></style> </threshold>

<threshold field="Percent" value='25' type='double'> <style><![CDATA[font-weight: bold;background-color: yellow;border-bottom-width: thin;border-bottom-style: solid;]]></style> </threshold>

</lever> </column> </columnlist>

Example #2 - Icons with Links

<columnlist>
<column name='*'>

<lever name='default'>

<threshold field="Status" value='UP' type='string'> <style><![CDATA[color: #00CC00;font-weight: bold;]]></style> </threshold>

<threshold field="Status" value='DOWN' type='string'> <style><![CDATA[color: #CC0000;font-weight: bold;]]></style> </threshold>

<threshold field="Status" value='UNREACHABLE' type='string'>
<style><![CDATA[color: orange;font-weight: bold;]]></style>
</threshold>

</lever>
</column>
<column name='Status'>
<lever name='default'>

<threshold field="Status" value='UP' type='string'> <imageurl><![CDATA[/marvelit/images/arrow-0.gif]]></imageurl> <link><![CDATA[http://www.marvelit.com]]></link> </threshold>

<threshold value='DOWN' type='string'> <imageurl><![CDATA[/marvelit/images/arrow-2.gif]]></imageurl> <link><![CDATA[http://www.marvelit.com]]></link> </threshold>

<threshold value='UNREACHABLE' type='string'> <imageurl><![CDATA[/marvelit/images/arrow-1.gif]]></imageurl> <link><![CDATA[http://www.marvelit.com]]></link> </threshold>

</lever>
</column>
</columnlist>