shapeLegend.format

Sets the format for data values displayed in the shape legend. To use the shapeLegend.format property, first instantiate an XFormatInfo object, and specify the type of format with the setFormat() function. The available formats are shown below:

Chart.DATE_FORMAT for date display

Chart.DECIMAL_FORMAT for number display

Chart.MESSAGE_FORMAT for text display

Chart.PERCENT_FORMAT for fraction display

Chart.CURRENCY_FORMAT for locale-adapting currency display

For the Date, Decimal, and Message formats, use the setFormatSpec() function to assign a format specification using the appropriate masks.

Type

XFormatInfo object

Example (Number Format)

var fmt = new inetsoft.uql.XFormatInfo;

fmt.setFormat(Chart.DECIMAL_FORMAT);

fmt.setFormatSpec("$#,##0.00")

Chart1['shapeLegend.format'] = fmt;

 

Example (Text Format)

var fmt = new inetsoft.uql.XFormatInfo;

fmt.setFormat(Chart.MESSAGE_FORMAT);

fmt.setFormatSpec("{0} Inc.")

Chart1['shapeLegend.format'] = fmt;

 

<< colorLegend.format © 1996-2013 InetSoft Technology Corporation (v11.4) sizeLegend.format >>