Thermometer Gauge - XML Sheet

You are viewing documentation for an older version. For current documentation - click here.

Thermometer Gauge Specification Sheet
SWF: Thermometer.swf

Quick Links (within this page)

Chart	Data	Others
Chart Image Chart Objects Functional Attributes Axis & Tick mark properties Real-time properties Thermometer properties Chart Cosmetics	Sample XML Data	Number Formatting Font Properties Tooltip Paddings and Margins Message Logger

Thermometer Gauge looks as under:

Sample XML / JSON for Thermometer Gauge:

XML
JSON

<chart palette="4" lowerLimit="-50" upperLimit="10" numberSuffix="° C">
  <value>-40</value>
</chart>

{
  "chart": {
    "palette": "4",
    "lowerlimit": "-50",
    "upperlimit": "10",
    "numbersuffix": "� C"
  },
  "value": "-40"
}

Chart Objects
Custom defined Styles can be applied to the chart objects listed below. The table contains the names of the chart objects, short descriptions, list of supported Styles and list of supported animation parameters.

Object Name	Description	Features Supported	Animation Parameters Supported
BACKGROUND	Background refers to the background for entire chart.	Animation Shadow Glow Bevel Blur	_alpha _x _y _xScale _yScale
GAUGE	Refers to the thermometer base.	Animation Shadow Glow Bevel Blur	_alpha
VALUE	Value textfield for the chart (if visible).	Animation Font Shadow Glow Bevel Blur	_alpha _x _y
TICKMARKS	Tick marks on the scale.	Animation Shadow Glow Bevel Blur	_alpha _x _y
TICKVALUES	Value for tick marks.	Animation Font Shadow Glow Bevel Blur	_alpha _x _y
LIMITVALUES	Textfield representing chart lower and upper limit.	Animation Font Shadow Glow Bevel Blur	_alpha _x _y
Back to top

These attributes let you control a variety of functional elements on the chart. For example, you can opt to show/hide data labels, data values, y-axis values. You can also set chart limits and extended properties.

Attribute Name	Type	Description
animation	Boolean (0/1)	This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
defaultAnimation	Boolean (0/1)	By default, each chart animates some of its elements. If you wish to switch off the default animation patterns, you can set this attribute to 0. It can be particularly useful when you want to define your own animation patterns using the Styles feature.
clickURL	URL in FusionCharts format	The entire chart can now act as a hotspot. Use this URL to define the hotspot link for the chart. The link can be specified in FusionCharts link format.
palette	Number (1-5)	Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme. Valid values are 1-5.
paletteThemeColor	Color Code	If you want your own palette derived from a particular hex color, you can specify the same here. All other colors on the chart will automatically derive from that palette.
annRenderDelay	Number (seconds)	If you've defined any annotation groups over chart, using this attribute you can set the duration after which they'll render on the chart. The timer starts from the time the chart has initialized.
autoScale	Boolean (0/1)	If you've defined the chart parameters (like gauge origin, co-ordinates etc.) using a different chart size and now want to scale the chart to a different size, you need to specify the original width and height and then set this attribute to 1.
manageResize Since v 3.2	Boolean (0/1)	Setting this attribute to 1, you can allow the chart to automatically resize itself when the parent container of the chart is resized. This setting is not applicable when autoScale is set to 0.
origW	Number (Pixels)	If you've opted to dynamically resize the chart, you can convey the original width of chart using this attribute. It refers to the width based on which you had defined the various co-ordinates/radius of the gauge. For example, if you had designed a gauge with 300 px width and in that you had set the bulb radius to be 50, then you can use the dynamic resizing feature and specify origW='300'. It will automatically check the current width and scale the bulb radius etc. appropriately. Please note that both the original width and height of the chart need to be set. To know more on how this attribute works, please read Angular Gauge > Dynamic Resizing page.
origH	Number (Pixels)	If you've opted to dynamically resize the chart, you can convey the original height of chart using this attribute. It refers to the height based on which you had defined the various co-ordinates/radius of the gauge. For example, if you had designed a gauge with 300 px height and in that you had set the bulb radius to be 50, then you can use the dynamic resizing feature and specify origH='300'. It will automatically check the current height and scale the bulb radius etc. appropriately. Please note that both the original width and height of the chart need to be set. To know more on how this attribute works, please read Angular Gauge > Dynamic Resizing page.
showValue	Boolean (0/1)	Whether to show chart's value?
showShadow	Boolean (0/1)	Whether to show shadow for the chart?
use3DLighting	Boolean (0/1)	Whether to use gradient fill for the thermometer?
showPrintMenuItem	Boolean (0/1)	Whether to show "Print Chart" item in the context menu of the chart? Even if you opt to hide the item in context menu, you can still opt to invoke print() JavaScript method of the chart to print the same.
showAboutMenuItem	Boolean (0/1)	Setting this to 1 displays a custom context menu in the chart, which can be customized to show your text and can be linked to your URL. For e.g., you can set the context menu of the chart to include "About your company name" and then link to your company home page. By default, the chart shows "About FusionCharts" when right clicked.
aboutMenuItemLabel	String	The menu item label for the custom context menu item.
aboutMenuItemLink	String	Link for the custom context menu item. You can specify the link in FusionCharts link format to be able to open the same in new window, pop-ups, frames or as JavaScript links.
refreshInstantly Since v 3.2	Boolean (0/1)	By default, the real-time charts wait for a few seconds after rendering for the first time and before updating itself with new data. To allow the chart to start updating itself as soon as it is rendered, set this attribute to 1.
useEllipsesWhenOverflow Since v 3.2	Boolean (0/1)	When enabled in AUTO mode, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1.
Back to top

Axis & Tick mark properties
The following attributes configures the Axis and the tick marks on the chart.

Attribute Name	Type	Description
setAdaptiveMin	Boolean (0/1)	This attribute lets you set whether the lower limit will be 0 (in case of all positive values on chart) or should the lower limit adapt itself to a different figure based on values provided to the chart.
upperLimit	Number	This attribute helps you explicitly set the upper limit of the chart. If you don't specify this value, the chart automatically calculates the upper limit based on the data provided by you.
lowerLimit	Number	This attribute helps you explicitly set the lower limit of the chart.If you don't specify this value, the chart automatically calculates the lower limit based on the data provided by you.
lowerLimitDisplay	String	This attribute allows you to display a label instead of the lower limit. For example, in a chart displaying Literacy Rate on a scale of 0-100%, you may need to show the label Low at the starting point of the chart. Upon using this attribute to specify the label, the value 0 will be replaced by Low. Default value: If you do not specify the lowerLimitDisplay attribute, the lower limit value will be shown.
upperLimitDisplay	String	This attribute allows you to display a label instead of the upper limit. Upon using this attribute, the upper limit of the chart gets replaced by the label specified. Default value: If you do not specify the upperLimitDisplay attribute, the upper limit value will be shown.
showTickMarks	Boolean (0/1)	Whether to show tick marks?
showTickValues	Boolean (0/1)	Whether to show tick values?
showLimits	Boolean (0/1)	Whether to show the first and last tick value (i.e., chart lower and upper limit)?
adjustTM	Boolean (0/1)	Whether to adjust major tick mark number so as to best distribute the specified chart scale.
ticksOnRight	Boolean (0/1)	Whether to show ticks on the left or right side of gauge?
majorTMNumber	Number	Number of major tick marks.
majorTMColor	Color Code	Major tick marks color.
majorTMAlpha	Number (0-100)	Major tick marks alpha.
majorTMHeight	Number (Pixels)	Width of major tick marks.
majorTMThickness	Number (Pixels)	Thickness of major tick mark line.
minorTMNumber	Number	Number of minor tick marks.
minorTMColor	Color Code	Color of minor tick marks.
minorTMAlpha	Number (0-100)	Alpha of minor tick marks.
minorTMHeight	Number (Pixels)	Width of minor tick marks.
minorTMThickness	Number (Pixels)	Thickness of minor tick marks.
tickMarkDistance	Number (Pixels)	Distance between the gauge scale and tick marks.
tickValueDistance	Number (Pixels)	Distance between tick values and tick marks.
tickValueStep	Number	If you need to show every n-th tick value only, you can specify that value here.
tickValueDecimals	Number	Number of decimals to which tick values will be rounded to.
forceTickValueDecimals	Boolean (0/1)	Whether to force number of decimals on tick values?
Back to top

Real-time properties
Using these attributes, you can configure the real-time feature.

Attribute Name	Type	Description
dataStreamURL	URL	This parameter sets the path of the page which is supposed to relay real-time data to the chart. If you've special characters as a part of your data stream URL, like ? or &, you'll need to URL Encode the entire dataStreamURL. This page needs to be on the same sub-domain on which the chart is hosted and invoked from. Otherwise, the Flash sandbox security will restrict it from accessing the data and hence the real-time feature won't work. Example: dataStreamURL='liveQuote.aspx?name=xyz' .
refreshInterval	Number	For this parameter, you can specify the number of seconds after which the chart will look for new data. This process will happen continuously - i.e., if you specify 5 seconds here, the chart will look for new data every 5 seconds.
dataStamp	String	Constantly changing data stamp that can be added to real time Data URL, so as to maintain a state. Please see the section Real time capabilities > Adding data stamp
showRTMenuItem	Boolean (0/1)	Whether to show the real-time update related menu items (like Start/Stop Update) in chart's context menu? Note: For JavaScript charts real-time update related menu items do not appear by default. You need to explicitly set showRTMenuItem='1' in <chart> element. The menu appears as a button on the bottom-left corner of the JavaScript chart. You can then use the button to Start/Stop Update or Clear chart.
Back to top

Thermometer Properties
The following attributes let you control the thermometer properties:

Attribute Name	Type	Description
thmBulbRadius	Number (Pixels)	If you want to explicitly specify a radius for thermometer bulb, you can use this attribute. Else, FusionWidgets XT automatically calculates the best possible value.
thmHeight	Number (Pixels)	Lets you manually set the height for thermometer.
gaugeFillColor	Color Code	Fill color for thermometer.
gaugeFillAlpha	Number (0-100)	Fill alpha for thermometer.
showGaugeBorder	Boolean (0/1)	Whether to show a border around thermometer?
gaugeBorderColor	Color Code	Color of thermometer border.
gaugeBorderThickness	Number (Pixels)	Thickness of thermometer border.
gaugeBorderAlpha	Number (0-100)	Alpha of thermometer border.
Back to top

Message Logger
FusionWidgets XT uses the concept of streaming and showing real-time messages in the chart using Message Logger. The Message logger can be effectively used to show necessary real-time information or live error logs.

Attribute Name	Type	Description
useMessageLog	Boolean (0/1)	Whether to use message logger for the chart?
messageLogWPercent	Number (percent)	This attribute lets you set the width percent of the message logger window w.r.t entire chart width. So, if you set it as 80, the message logger window will take up 80% of chart width.
messageLogHPercent	Number (percent)	This attribute lets you set the height percent of the message logger window w.r.t entire chart height.
messageLogShowTitle	Boolean (0/1)	Whether to show the title for message logger?
messageLogTitle	String	If you've opted to show the title for message logger, you can define your custom title here. Examples are "Error log", "Server History" etc. The title displays at the top left corner of chart.
messageLogColor	Color Code	You can customize the color of the entire message log window by setting a hex value for this attribute.
messageGoesToLog	Boolean (0/1)	The messages streamed to the chart can either be displayed in the message log window or can be passed to JavaScript (which we'll see next). This attribute lets you control whether the messages should be logged in the in-built log window.
messageGoesToJS	Boolean (0/1)	This attribute lets you configure whether each message streamed from the server should be passed to a local JavaScript function.
messageJSHandler	String	If you've opted to pass each message to JavaScript function, this attribute lets you define the name of the function. This helps you create your custom functions to react to messages streamed from server.
messagePassAllToJS	Boolean (0/1)	Whether to pass all message envelope parameters to the custom JavaScript function.
Back to top

Using the attributes below, you can control a myriad of options like:

Formatting of commas and decimals
Number prefixes and suffixes
Decimal places to which the numbers will round to
Scaling of numbers based on a user defined scale
Custom number input formats

Attribute Name	Type	Description
formatNumber	Boolean (0/1)	This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if formatNumber='1' and 40000 if formatNumber='0'.
numberPrefix	String	Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all dollars figure on the chart, you could specify this attribute to ' $' to show like $40000, $50000. For more details, please see Advanced Charting > Number Formatting section.
numberSuffix	String	Using this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figure quantified as per annum on the chart, you could specify this attribute to ' /a' to show like 40000/a, 50000/a. For more details, please see Advanced Charting > Number Formatting section.
decimals	Number	Number of decimal places to which all numbers on the chart will be rounded to. For more details, please see Advanced Charting > Number Formatting section.
forceDecimals	Boolean (0/1)	Whether to add 0 padding at the end of decimal numbers? For example, if you set decimals as 2 and a number is 23.4. If forceDecimals is set to 1, the number will automatically be converted to 23.40 (note the extra 0 at the end). For more details, please see Advanced Charting > Number Formatting section.
formatNumberScale	Boolean (0/1)	Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - e.g., if formatNumberScale is set to 1, 1043 will become 1.04K (with decimals set to 2 places). Same with numbers in millions - an M will be added at the end. For more details, please see Advanced Charting > Number Formatting section.
defaultNumberScale	String	The default unit of the numbers that you're providing to the chart. For more details, please see Advanced Charting > Number Formatting section.
numberScaleUnit	String	Unit of each block of the scale. For more details, please see Advanced Charting > Number Formatting section.
numberScaleValue	String	Range of the various blocks that constitute the scale. For more details, please see Advanced Charting > Number Formatting section.
scaleRecursively	Boolean (0/1)	Whether to scale the number recursively? For more details, please see Advanced Charting > Number Formatting section.
maxScaleRecursion	Number	How many recursions to complete during recursive scaling? -1 completes the entire set of recursion. For more details, please see Advanced Charting > Number Formatting section.
scaleSeparator	String	What character to use to separate the scales that generated after recursion?
decimalSeparator	String	This option helps you specify the character to be used as the decimal separator in a number. For more details, please see Advanced Charting > Number Formatting section.
thousandSeparator	String	This option helps you specify the character to be used as the thousands separator in a number. For more details, please see Advanced Charting > Number Formatting section.
thousandSeparatorPosition Since v3.2 - SR1	Number	This option helps you specify the position of the thousand separator. For more details, please see Advanced Charting > Number Formatting > Basics page.
inDecimalSeparator	String	In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. The chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator. For more details, please see Advanced Charting > Number Formatting section.
inThousandSeparator	String	In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. The chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator. For more details, please see Advanced Charting > Number Formatting section.
Back to top

The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.

Attribute Name	Type	Description
bgColor	Color Code	This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: FF5904, FFFFFF. Remember to remove # and any spaces in between. For more details see Using Gradients.
bgAlpha	Number (0-100)	Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma. For more details see Using Gradients.
bgRatio	Numbers separated by comma	If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent. For more details see Using Gradients.
bgAngle	Number (0-360)	Angle of the background color, in case of a gradient. For more details see Using Gradients.
showBorder	Boolean (0/1)	Whether to show a border around the chart or not?
borderColor	Color Code	Border color of the chart.
borderThickness	Number (Pixels)	Border thickness of the chart.
borderAlpha	Number (0-100)	Border alpha of the chart.
bgImage or bgSWF - deprecated	String	To place any image (JPG/PNG/GIF) or Flash movie (SWF) as background of the chart, enter the (path and) name of the background image or SWF file. It should be in the same domain as the chart. Loading of Flash movie is deprecated and is not supported by JavaScript charts.
bgImageAlpha or bgSWFAlpha - deprecated	Number (0-100)	Helps you specify the opacity for the loaded background image or Flash movie. Loading of Flash movie is deprecated and is not supported by JavaScript charts.
bgImageDisplayMode Since v3.2	String (stretch, tile, fit, fill, center, none)	Helps you specify the mode in which the background image is to be displayed. Stretch - expands the image to fit the entire chart area, without maintaining original image constraints Tile - the image is repeated as a pattern on the entire chart area Fit - fits the image proportionately on the chart area Fill -proportionately fills the entire chart area with the image Center - the image is positioned at the center of the chart area None - Default mode. None of the above modes are applied For more details click here.
bgImageVAlign Since v3.2	String (top, middle, bottom)	Helps you to vertically align the background image.
bgImageHAlign Since v3.2	String (left, middle, right)	Helps you to horizontally align the background image.
bgImageScale Since v3.2	Number (0-300)	Helps you magnify the background image.This attribute will only work when the attribute bgImageDisplayMode is set to none, center or tile.
logoURL	String	You can load an external logo (JPEG/PNG/SWF) on the chart once it has rendered. This attribute lets you specify the URL of the same. Owing to Flash Player security settings, you can only specify logos that are on the sub-domain as the SWF file of the chart.
logoPosition	String ( TL, TR, BL, BR, CC )	Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
logoAlpha	Number (0-100)	Once the logo has loaded on the chart, you can configure its opacity using this attribute.
logoScale	Number (0-100)	You can also change the size of externally loaded logo at run-time by specifying a value for this parameter.
logoLink	String	If you want to link the logo to an external URL, specify the link in this attribute. The link can be in FusionCharts link format, allowing you to link to new windows, pop-ups, frames etc.
Back to top

Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties.

If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc. Using Styles you can also configure real-time values.

Attribute Name	Type	Description
baseFont	Font Name	This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify outCnvBaseFont attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
baseFontSize	Number	This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
baseFontColor	Color Code	This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
Back to top

These attributes let you control the tooltip. You can set the background color, border color, separator character and few other details.

Attribute Name	Type	Description
showToolTip	Boolean (0/1)	Whether to show tooltip for the annotations?
toolTipBgColor	Color Code	Background color for the tooltip
toolTipBorderColor	Color Code	Border Color for the tooltip.
showToolTipShadow	Boolean (0/1)	Whether to show shadow for tooltips.
Back to top

The following attributes help you control chart margins and paddings.

FusionWidgets XT allows you manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionWidgets XT is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent).

You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart.

It is not necessary for you to specify any padding/margin values. FusionWidgets XT automatically assumes the best values for the same, if you do not specify the same.

Attribute Name	Type	Description
chartLeftMargin	Number (Pixels)	Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
chartRightMargin	Number (Pixels)	Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
chartTopMargin	Number (Pixels)	Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
chartBottomMargin	Number (Pixels)	Amount of empty space that you want to put on the bottom of your chart. Nothing is rendered in this space.
valuePadding	Number (Pixels)	Distance between the value and gauge.
Back to top

The XML API for the following features have not been discussed here:

Exporting Chart: All the attributes pertinent to exporting of charts as images or PDFs are discussed in the Exporting as Image/PDF section.
Exporting Chart Data: All the attributes pertinent to exporting of chart data are discussed in the Exporting Chart Data section.
Annotations - All the attributes pertinent to annotations are discussed in the Annotations section.
Alert Manager - All the attributes pertinent to alerts are discussed in the Alert Manager section.
Styles - All the attributes pertinent to Styles are discussed in the Using Styles section.