Tile Class Properties

In this section, the Tile class properties are presented in alphabetical order.

Description

Use the GroupletIDStyleClass property to specify a custom style class as a String value. The custom style class must be defined in a custom free-form style sheet that you have attached using the TileSpecificStyleSheet property.

This property is read/write.

Example

/* Custom free-form style sheet */
%This.TileSpecificStyleSheet = StyleSheet.MY_TILES_CSS;

/*Apply your custom style class to the tile content */
%This.GroupletIDStyleClass = "my_custom_style";

Description

Use the hasContent property to set or return a Boolean value indicating whether the tile has content defined. This property provides you with an opportunity to perform alternate processing when an error condition has occurred.

When you set hasContent to False, you should define the following tile properties:

  • An image in lieu of content (optional).

  • PreferencesUrl (optional).

  • PreferencesUrlLabel (required).

This property is read/write.

Example

If no_error_condition Then
   /* Normal processing of tile content */
Else
   %This.hasContent = False;
   %This.setTileImageRef("IMG_MISSING_DATA");
   %This.PreferencesUrlLabel = "No Data Available";
   %This.PreferencesUrl = "http://myserver.example.com/psc/my_site/EMPLOYEE/MY_NODE/c/MY_MENU.MY_COMPONENT.GBL";
End-If;

Description

Use the hasLiveDataCount property to set or return a Boolean value indicating whether the badge area is enabled. Set this property within your implementation only if you wish to dynamically override whether the badge area is enabled (that is, whether badge data is displayed). Setting this property is equivalent to invoking the setTileHasCount method. If the badge is enabled, you must also set the badge data with the TileTransCount property.

This property is read/write.

Example

%This.hasLiveDataCount = True; /* Enables the badge area. */
%This.TileTransCount = MY_REC.COUNT;

Description

Use the hasLiveDataDescr property to set or return a Boolean value indicating whether the live data area is enabled. Set this property within your implementation only if you wish to dynamically override whether the live data area is enabled (that is, whether live data is displayed). Setting this property is equivalent to invoking the setTileLiveData method. If live data is enabled, you must also specify one or more live data values with the TileLiveData_1, TrendImage, TileLiveData_2, and TileLiveData_3 properties.

This property is read/write.

Example

%This.hasLiveDataDescr = True; /* Enables the live data area. */

%This.TileLiveData_1 = "Value 1";
%This.hasLivedataTrendImage = True; /* Optional trend image */
%This.TrendImage = %This.k_strTrendUpImage; 
%This.TileLiveData_2 = "Value 2";
%This.TileLiveData_3 = "Value 3";

Description

Use the hasLivedataTrendImage property to set a Boolean value indicating whether to display an optional trend image (up or down). When a trend image is enabled, it is displayed preceding the TileLiveData_2 element in the live data area or with the first KPI data value only when a single KPI is displayed (either the 1 KPI or the chart and 1 KPI content types).

Note: Only one trend image can be displayed on a tile. The default location is in the live data area. Therefore, if you want to associate a trend image with KPI data, you should not enable the live data area for the tile. If you enable the live data area, the trend image will be displayed there and not with the KPI data.

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_2 = NumberToString("%10.2v", &nMetric) | "%";
%This.isTileLiveData_2_Metrics = True;

/* A trend arrow is an optional element of live data. */
%This.hasLivedataTrendImage = True; 
%This.TrendImage = %This.k_strTrendUpImage;

Description

Use the ImageReferenceField property to specify the image to be displayed when the tile's content type is specified as an image. Setting a value for this property is equivalent to invoking the setTileImageRef method. When the tile content is specified to be an image, either this property or the setTileImageRef method is required.

Because ImageReferenceField is actually a Field object, you must set its Value property as follows:

%This.ImageReferenceField.Value
= Image.IMAGE_ID;

This property is read/write.

Example

REM %This.setTileImageRef("MY_IMAGE"); /* Method equivalent */

%This.ImageReferenceField.Value = Image.MY_IMAGE;
%This.TileImageReferenceLabel("My tooltip");

Description

Use the isTileLiveData_1_Metrics property to set a Boolean value indicating whether to format the TileLiveData_1 element as a metric similar to the badge metric (in tangerine orange and in bold).

Note: While this formatting style can also be used with the first live data element (TileLiveData_1), it is typically used with the second live data element only.

This property is read/write.

Description

Use the isTileLiveData_1_MetricsLabel property to set a Boolean value indicating whether to format the TileLiveData_1 element with a metrics label style.

Note: The isTileLiveData_1_MetricsLabel property and the metrics label style do not produce any visual formatting change for this live data element.

This property is read/write.

Description

Use the isTileLiveData_2_Metrics property to set a Boolean value indicating whether to format the TileLiveData_2 element as a metric similar to the badge metric (in tangerine orange and in bold). This is the recommended formatting for the second live data element.

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_2 = NumberToString("%10.2v", &nMetric) | "%";
%This.isTileLiveData_2_Metrics = True;

Description

Use the isTileLiveData_2_MetricsLabel property to set a Boolean value indicating whether to format the TileLiveData_2 element with the metrics label style.

Note: The isTileLiveData_2_MetricsLabel property and the metrics label style do not produce any visual formatting change for this element.

This property is read/write.

Description

Use the isTileLiveData_3_Metrics property to set a Boolean value indicating whether to format the TileLiveData_3 element as a metric similar to the badge metric (in tangerine orange and in bold).

Note: While this formatting style can also be used with the third live data element (TileLiveData_3), it is typically used with the second live data element only.

This property is read/write.

Description

Use the isTileLiveData_3_MetricsLabel property to set a Boolean value indicating whether to format the TileLiveData_3 element with the metrics label style.

Note: The isTileLiveData_3_MetricsLabel property and the metrics label style do not produce any visual formatting change for this element.

This property is read/write.

Description

Use the PreferencesUrl property to set an alternate target content URL when an error condition exists—for example, when the tile content is invalid. Prior to setting the PreferencesUrl property, set the hasContent property to False.

Specify a String value that is a fully qualified URL that allows the user to correct the error condition.

This property is read/write.

Example

%This.hasContent = False;
%This.PreferencesUrl = "http://myserver.example.com/psc/my_site/EMPLOYEE/MY_NODE/c/MY_MENU.MY_COMPONENT.GBL";

Description

Use the PreferencesUrlLabel property to set an alternate URL label when an error condition exists—for example, when the tile content is invalid. Prior to setting the PreferencesUrlLabel property, set the hasContent property to False.

If a custom URL label is not specified, the system default label is displayed instead.

This property is read/write.

Example

%This.hasContent = False;
%This.PreferencesUrlLabel = "No Data Available";

Description

Use the Tilechart property to instantiate a Chart object for this tile. Using this property is required when the tile content is set to either chart or chart plus one KPI. After associating a Chart object to this property, you can define additional properties and invoke methods on the Chart object to specify its characteristics.

This property is read/write.

Example

Local Chart &my_Chart;
Local Rowset &rowset;

&rowset = CreateRowset(Record.MY_CHART_DATA);
&rowset.Flush();
&rowset.Fill();

/* IMPORTANT: Instantiate your Chart object with this property.
&my_Chart = %This.Tilechart;
&my_Chart.SetData(&rowset);
/* Invoke other Chart class methods and set Chart class properties. */

Description

Instead of TileContentOption, use one of the SetTileContentAs* methods to set the tile content type.

This property is read/write.

Description

Use the TileHtmlArea property to set the HTML text for this tile as a string value. Using this property is required when the tile content is set to an HTML area.

This property is read/write.

Example

/* Use an HTML definition as the HTML text. */
%This.TileHtmlArea = GetHTMLText(HTML.MY_HTML);

/* Alternatively, specify the HTML text inline. */
%This.TileHtmlArea = "<B>%UserId: </B>has exceeded quota.<BR><I>%Message(146,51): </I><BR>";

Description

Use the TileHtmlAreaStyle property to specify a custom style class for the HTML area as a String value. The custom style class must be defined in a custom free-form style sheet that you have attached using the TileSpecificStyleSheet property.

This property is read/write.

Example

/* Custom free-form style sheet */
%This.TileSpecificStyleSheet = StyleSheet.MY_TILES_CSS;

/*Apply your custom style class to the HTML area */
%This.TileHtmlAreaStyle = "my_custom_style";

Description

Use this property to set or return the ID for this tile. Setting the ID for the tile is equivalent to invoking the setTileID method.

This property is read/write.

Description

Use the TileImageReferenceLabel property to set a tooltip (sometimes referred to as hover text) for image content as a String value. This tooltip can be read by screen readers and is also displayed as hover text.

This property is read/write.

Example

%This.setTileImageRef("MY_IMAGE");
%This.TileImageReferenceLabel("My tooltip");

Description

Use the TileKPI_1 property to set the first key performance indicator (KPI) data value as a String value. Setting this property is required when you have specified one of the KPI content types in Tile Wizard or you have invoked the one of the following methods: SetTileContentAsChartAndKPI, SetTileContentAsOneKPI, SetTileContentAsTwoKPIs, or SetTileContentAsTwoKPIsTopBottom.

Since KPIs are typically numeric values, you can use the getAmountFormattedValue method or several built-in functions (for example, NumberToString or NumberToDisplayString) to convert the numeric value to a String value.

Set a label for this data value using the TileKPI_1_Label property.

Optionally, you can use the hasLivedataTrendImage property to enable a trend image for display with the first KPI data value only when a single KPI is displayed (either the 1 KPI or the chart and 1 KPI content types).

This property is read/write.

Example

&rev = &total_rev / 1000000;
%This.TileKPI_1 = %This.getAmountFormattedValue(&rev, "USD");
%This.TileKPI_1_Label = "Revenue (in Millions)";

Description

Use the TileKPI_1_Label property to set the first KPI label as a String value. Setting this property is required when you have specified one of the KPI content types in Tile Wizard or you have invoked the one of the following methods: SetTileContentAsChartAndKPI, SetTileContentAsOneKPI, SetTileContentAsTwoKPIs, or SetTileContentAsTwoKPIsTopBottom.

Set the data value to accompany this label using the TileKPI_1 property.

This property is read/write.

Description

Use the TileKPI_2 property to set the second KPI data value as a String value. Setting this property is required when you have specified the two KPIs content type in Tile Wizard or you have invoked the one of the following methods: SetTileContentAsTwoKPIs or SetTileContentAsTwoKPIsTopBottom.

Since KPIs are typically numeric values, you can use the getAmountFormattedValue method or several built-in functions (for example, NumberToString or NumberToDisplayString) to convert the numeric value to a String value.

Set a label for this data value using the TileKPI_2_Label property.

This property is read/write.

Description

Use the TileKPI_2_Label property to set the second KPI label as a String value. Setting this property is required when you have specified the two KPIs content type in Tile Wizard or you have invoked the one of the following methods: SetTileContentAsTwoKPIs or SetTileContentAsTwoKPIsTopBottom.

Set the data value to accompany this label using the TileKPI_2 property.

This property is read/write.

Description

When the tile content contains two KPIs, set the TileKPI_2_Layout property as an alternative to invoking either the SetTileContentAsTwoKPIs or the SetTileContentAsTwoKPIsTopBottom. Use the following constants with this property:

  • %This.k_strDataKPI_2_DefaultLayout - The KPIs are displayed side-by-side (equivalent to SetTileContentAsTwoKPIs).

  • %This.k_strDataKPI_2_TopBottom - The KPIs are displayed stacked (equivalent to SetTileContentAsTwoKPIsTopBottom).

This property is read/write.

Description

Use the TileLiveData_1 property to set the value for the first segment of live data as a String value. To display live data, the live data area must be enabled in the Tile Wizard definition, by invoking the setTileLiveData method, or by setting the hasLiveDataDescr property.

Typically, TileLiveData_1 represents a label for the live data.

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_1 = "Overall Profit Margin";

Description

Use the TileLiveData_2 property to set the value for the second segment of live data as a String value. To display live data, the live data area must be enabled in the Tile Wizard definition, by invoking the setTileLiveData method, or by setting the hasLiveDataDescr property.

Typically, TileLiveData_2 is used to display a metric or other numeric value. Optionally, you can set the isTileLiveData_2_Metrics property to format this element as a metric similar to the badge metric (in tangerine orange and in bold). In addition, you can set the TrendImage property to display an up or down trend arrow preceding this metric.

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_2 = NumberToString("%10.2v", &nMetric) | "%";
%This.isTileLiveData_2_Metrics = True;

/* A trend arrow is an optional element of live data. */
%This.hasLivedataTrendImage = True; 
%This.TrendImage = %This.k_strTrendUpImage;

Description

Use the TileLiveData_3 property to set the value for the third segment of live data as a String value. To display live data, the live data area must be enabled in the Tile Wizard definition, by invoking the setTileLiveData method, or by setting the hasLiveDataDescr property.

Typically, TileLiveData_3 is used to display an additional description of the live data.

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_3 = "from Q3";

Description

Use the TileSpecificStyleSheet to attach a custom free-form style sheet. Then, use either the GroupletIDStyleClass property or the TileHtmlAreaStyle property to specify a custom style class that is defined in the style sheet.

This property is read/write.

Example

/* Custom free-form style sheet */
%This.TileSpecificStyleSheet = StyleSheet.MY_TILES_CSS;

/*Apply your custom style class to the tile content */
%This.GroupletIDStyleClass = "my_custom_style";

Description

Use the TileTransCount property to set the badge data as a Number value. To display badge data, the badge area must be enabled in the Tile Wizard definition, by invoking the setTileHasCount method, or by setting the hasLiveDataCount property.

This property is read/write.

Example

%This.hasLiveDataCount = True; /* Enables the badge area. */
%This.TileTransCount = MY_REC.COUNT;

Description

Use the TrendImage property to set a String value indicating which optional trend arrow (up or down) to display.

Use either of these built-in constant values to set the trend image: %This.k_strTrendUpImage or %This.k_strTrendDownImage.

Alternatively, you can specify a custom trend image by specifying the image ID using the following syntax:

%This.TrendImage
= "MY_TREND_UP";

This property is read/write.

Example

%This.hasLiveDataDescr = True;
%This.TileLiveData_2 = NumberToString("%10.2v", &nMetric) | "%";
%This.isTileLiveData_2_Metrics = True;

/* A trend arrow is an optional element of live data. */
%This.hasLivedataTrendImage = True; 
%This.TrendImage = %This.k_strTrendUpImage;