Data Labels

A data label is a small box of text associated with a data item (such as a Graph Bar or Shape). Data labels can be displayed in one of two ways:

Note: Rollover data labels display the letters RO (rollover) in Corda Builder™ at the spot the data labels appear. These letters do not appear in the final Corda image. When you view the Corda image on the Web, the data labels only display when the mouse passes over an item (e.g., pie wedge or bar) in the graph.

Warning: Hover text and rollover labels cannot be used on the same item. Hover text always overrides the rollover data label. If you want the data label to appear even when there is hover text, configure the data label as a static data label.

Properties and attributes related to data labels are available from the Data Label property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

The remainder of this section discusses the following topics:

Data Label Text

The key to effective data labels is proper formatting of the data label text. By default, Corda Builder selects how data label text is formatted. Use meta tags to customize the format of data labels, providing complete control over what is displayed by a data label.

A meta tag is a keyword that begins with %_, such as %_VALUE. The meta tag is replaced by a dynamic value when the graph is published as an image. In this way, meta tags let you make sure each data label contains information specific to the data item with which it is associated.

Using meta tags, a data label can display Price: $43 instead of just 43. When combined with a data label's rollover capability, customized data label formatting can greatly reduce the need for hover text.

The data label format string can contain any combination of regular text and meta tags. The list of supported meta tags varies by object type, but all supported meta tags for a given object type are listed in the drop-down menu of the appropriate data label text property.

Note: Corda Builder supports the <br> tag to start a new line in data labels.

Data Value Format

Customize the format of the data displayed with value meta tags such as %_VALUE and %_PERCENT_OF_CATEGORY .

Note: Settings on this tab only apply to text in Labels, Drilldown, and Hover Text that use the %_Value keyword.

Properties and attributes related to data value format are available from the Data Label property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

General Data Label Settings

Data labels support several common object properties, including the following:

Properties and attributes related to data value format are available from the Data Label property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

Graph Data Labels

Configure graph data labels in Object Properties. The following configuration options are available for data labels:

Graph Data Label Position

Corda Builder lets you specify the location of data labels within the graph, with specific positioning options dependent on graph type. It also lets you specify a fixed position at which all rollover data labels appear. A textbox with the letters RO appears in the Image Template file. This is a placeholder for data labels. They appear on rollover in the same condition and with the same format as this textbox.

Properties and attributes related to data label position are available from the Data Label property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

Graph Meta Tags

Graph data labels: support the following meta tags:

Meta Tag

Description

Graph

%_BUBBLE_VALUE

The value of the bubble in an X-Y or time bubble graph.

X-Y, Time Bubble

%_CATEGORY_NAME

The name of the category that the data item belongs to.

All except X-Y, Time Plot

%_CATEGORY_NUMBER

The number of the data series that the data item belongs to.

All except X-Y, Time Plot

%_CATEGORY_TOTAL

The sum of all data values in the category to which the data item belongs (applies to).

Area, Bar, Line, Pareto, Pie, Radar

%_CLOSE_VALUE

The close value for a high-low data item.

Stock (HLOC)

%_FIRST_QUARTILE

The first quartile value for a box plot.

Box Plot

%_GRAPH_TOTAL

The sum of all data values in a bar, line, pie, or radar graph.

Area, Bar, Line, Pareto, Pie, Radar

%_HIGH_VALUE

The high value for a high-low data item.

Stock, Box Plot

%_LOW_VALUE

The low value for a high-low data item.

Stock, Box Plot

%_MEDIAN

The median value for a box plot.

Box Plot

%_CNAME_COLUMN

This meta tag is used in conjunction with a load file that provides the desired label text. For more information about using load files, see Comma- Separated Value Files in the Corda 7 Developer Reference.

All

%_OUTLIERS

A semi-colon separated list of all outlier values for a box plot.

Box Plot

%_OPEN_VALUE

The open value for a high-low data item.

Stock (HLOC)

%_PERCENT_OF_CATEGORY

The data value represented as a percentage of the sum of all data values in its category.

Area, Bar, Line, Pareto, Pie, Radar

%_PERCENT_OF_TOTAL

The data value represented as a percentage of the sum of all data values in the graph.

Area, Bar, Line, Pareto, Pie, Radar

%_POINT_NUMBER

The number of the data item in the data series (the first plot point=1).

X-Y, Time Plot

%_SERIES_NAME

The name of the data series that the data item belongs to.

All except Stock, Box Plot

%_SERIES_NUMBER

The number of the data series that the data item belongs to.

All except Stock, Box Plot

%_THIRD_QUARTILE

The third quartile value for a box plot.

Box Plot

%_TIME_VALUE

The time value for a time plot data item.

Time Plot

%_VALUE

The value of the data item.

Area, Bar, Line, Pareto, Pie, Radar

%_XVALUE

The x value for an X-Y data item.

X-Y

%_YVALUE

The y value for an X-Y or time plot data item.

X-Y, Time Plot

 

Data Labels for Pareto Graphs

Data labels on a Pareto graph work just like data labels from any other graph. However, since the bars typically indicate a different type of value (e.g., dollars) than the line (percentage), you need to "trick" the graph into displaying a different symbol for the data labels along the line.

For example, suppose you set the data label format to $%_VALUE. A data label along the bar looks much like you would expect it to (e.g., $43,000). However, a data label along the line also includes a dollar sign. Where you want the data label along the line to be labelled as a percentage (e.g., 43%), it instead uses the same data label format as the bar (e.g., $43).

To set a bar series data label

  1. From the Project Canvas or the Object List, select the Pareto graph.

  2. In Object Properties, select the Bar Series property.

  3. Select the Enable box next to the Data Label attribute.

  4. Set the Data Label value to the data label format you want to use for the bar series. (e.g. $%_VALUE).

Data Labels for Pie Charts

Pie charts are the only graph that provides two data labels. Each is independently configurable. By default, the Data Label property is displayed, while the Data Label 2 property is hidden.

Dynamic Graph Data Labels

When using an Image Template file with Corda Server™, data labels are often displayed dynamically in graphs, based on the live data. These dynamic data labels override those defined in Corda Builder. Enable data labels dynamically with ITXML.

To display a data label in a graph dynamically with ITXML, set the enable-show attribute of the cit:data-label property to True. More information on these properties and attributes is available in the Corda 7 Object Reference.

Note: The show attribute of cit:data-label lets you configure the data label as either always-on, or on-hover. The default setting is on-hover. Hover data labels are supported in FLASH, SVG, JPEG, and PNG images only. Hover may be unavailable in JPEG or PNG images with some Web browsers. For more details, see Drilldown/ Hover/ Roll-Over Data Label Problems with PNG or JPEG Images in the Corda 7 Install and Administration Guide.

Customize the look of a graph data label dynamically using either ITXML or PCScript:

ITXML

To customize a graph data label dynamically with ITXML, set the text attribute of cit:data-label property. More information on these properties and attributes is available in the Corda 7 Object Reference.

PCScript

To customize a graph data label dynamically with PCScript, use the graph.setDataLabelFormat() method.

Map Data Labels

Note: Maps only support always-on data labels.

Map data labels help identify and provide additional information about map shapes. Within maps, data labels can be applied at the following points:

Note: Since map shapes are just special instances of shape objects, data labels for regular shape objects can be configured in much the same way.

The following configuration options are available for map data labels:

Map Meta Tags

Maps support the following meta tags:

Meta Tag

Description

%_CODE

The map data item code. This is one of three ways to identify a map data item.

%_DESCRIPTION

The value of %_DESCRIPTION is set from the ITXML tab. Select the Verbose XML option. You see a Description field associated with each map shape.

%_EXTRAINFO

The value of %_EXTRAINFO is set from the ITXML tab. Select the Verbose XML option. You see an Extra Info field associated with each map shape.

%_LONGNAME

The map data item's long name. This is one of three ways to identify a map data item.

%_NAME

The name of the data item. This is one of three ways to identify a map data item.

%_NAMECLASS

The data item type (e.g., city, state, province, zip code).

%_RANGENAME

The name of the range into which the data item falls.

%_PARENT

The name of the map to which the data item belongs.

%_VALUE

The value of the data item.

 

Map Data Label Layout

To configure a map's data label, use the Layout property in Label, which provides control over the label's position, margin, and maximum width.

Properties and attributes related to map data label position are available from the Label > Layout property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

Justification

Since shape data labels automatically scale to the width of the label text, no justification is necessary for data labels with a single line of text. However, for multiple lines of text you may want to specify the text justification.

Properties and attributes related to map label justification are available from the Label property in Object Properties. More information on these properties and attributes is available in the Corda 7 Object Reference.

Dynamic Map Data Labels

When using an Image Template file with Corda Server, data labels are often displayed dynamically in maps, based on the live data. These dynamic data labels override those defined in Corda Builder.

To display a map data label in a map dynamically with ITXML, add a cit:label property to the appropriate cit:default-shape. More information on these properties and attributes is available in the Corda 7 Object Reference.

Use meta tags to change data label formats for map shapes in a map.