Heat Map Properties

The Heat Map supports the following properties, which are available via the Properties pane and the Canvas script editor. Click next to any property name in the Properties pane to see a short description for the selected property.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

Categorizing, Sorting, and Finding Properties

You can click

(Categorize), click Alphabetize

(Alphabetical within Category) or click

(Search) within the properties using the features located immediately above the properties list. The search box is useful to help locate a property when an object contains many properties. For clarity, when you enter a search term, items matching your entry string remain displayed and non-matching items are temporarily hidden. Clear the search box to display the full properties list again.

You can expand and collapse each property category by clicking Down arrow

next to the group name or simply clicking anywhere in the category heading.

Heat Map Properties

The following table describes the property names visible in the Properties pane user interface (UI) and the corresponding script property name.

UI Property	Script Property	Description
Name	ControlName	The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. Names cannot start with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane.
Type	ControlType	The read-only Type property displays the type for the control: Chart, Grid, Heat Map, Object Container, Tag Chooser, View, etc. … The control's Type is also displayed on the Controls view of the Screen pane.
Style		The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type. Click to reveal a drop-down menu of predetermined styles configured for the selected control. Select a desired style and its properties will be applied to the control. Alternately, you can create a new style based on other property values configured for the control. Or you can select <None> to remove subscription to any style. Styles are created in two ways: In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information. In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information. Tip: You can also change a control's Style on the Controls view of the Screen pane.
Height	Height	The Height property specifies the height of the control (or screen). Tip: You can also change the height of a control using the Settings pane (click on the (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Horizontal resize mode	HorizontalResizeMode	The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include: None — No resizing occurs. Shift — The object will shift horizontally. Expand — The object will expand or shrink horizontally the same number of pixels as the screen. Proportional — The object expands or shrinks proportionally to the screen. The default value is None.
Layer	Layer	The Layer property specifies the layer for this control. Layers are used to show, hide, and edit multiple controls on one layer without affecting controls on another layer. Type the name of the layer into the Layer field. All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode. Tip: You can also edit a control's Layer on the Controls view of the Screen pane. Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.
Vertical resize mode	VerticalResizeMode	The Vertical resize mode property specifies whether and how the control dynamically moves or resizes vertically when the screen is resized in run mode. Options include: None — No resizing occurs. Shift — The object will shift vertically. Expand — The object will expand or shrink vertically the same number of pixels as the screen. Proportional — The object expands or shrinks proportionally to the screen. The default value is None.
Visible	IsVisible	The Visible check box indicates whether the control is visible in run mode. Tip: You can also change a control's Visible setting on the Controls view of the Screen pane.
Width	Width	The Width property specifies the width of the control (or screen). Tip: You can also change the width of a control using the Settings pane (click on the (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
X	X	The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels. Tip: You can also change the location of the control using the Settings pane; click on the (Settings) to the right of the control in design mode.
Y	Y	The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels. Tip: You can also change the location of the control using the Settings pane; click on the (Settings) to the right of the control in design mode.
Z index	ZIndex	The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer). Tip: You can also change the Z index of a control using the Settings pane (click on the (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Include in script		The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True. Tip: You can also change the Include in Script setting on the Controls view of the Screen pane.
Background color	BackgroundColor	The Background color property specifies the background color of the screen, object, or control. Click to select a color using the color picker.
Cell padding	CellPadding	The Cell padding property specifies the size of the padding around each heat map cell in pixels.
Facility sender	Facilities FacilitySender SetFacilities	The Facility sender property specifies the name of the control that will send its list of facilities to this control. This property is used instead of a facility filter.
High range color	HighRangeColor	The High range color property specifies the color to be used at the high end of the value range. Click to select a color using the color picker.
Low range color	LowRangeColor	The Low range color property specifies the color to be used at the low end of the value range. Click to select a color using the color picker.
Row header font size	RowHeaderFontSize	The Row header font size property specifies the font size for the text that lies to the left of each row in the heat map.
Row height	RowHeight	The Row height property specifies the height of each heat map row. Only applicable if the Row sizing mode is set to Fixed.
Row sizing mode	RowSizingMode	The Row sizing mode specifies the method used to size the heat map row height. Options include: Auto — Automatically size the rows based on the height of the heat map. Fixed — Size the rows using the value specified in the row height property. If this requires more vertical space than is available, a scroll bar will be added. The default value is Auto.
Show cell labels	ShowCellLabels	The Show cell labels check box indicates whether to display the value in each cell. Note that displaying a value may have an impact on performance.
Show scale	ShowScale	The Show scale check box indicates whether to display the color scale beneath the heat map.
Show tooltips	ShowTooltips	The Show Tooltips check box indicates whether to display tooltips when hovering over a data point or cell. When you hover over a data point or cell in run mode the tooltip displays the point value and timestamp. Only available when a control is showing points.
Show top labels	ShowTopLabels	The Show top labels check box indicates whether to display the date and time labels along the top of the heat map.
UDC	UDC	The UDC property specifies the UDC for which the control is to display data. Click to select a UDC using the Select UDC dialog box.
Begin date	DateStart	The Begin date (or Start or Start date) property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.
Begin relative date	RelativeStart	The Begin relative date (or Relative start date or Start) property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.
End date	DateEnd	The End date (or End) property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.
End relative date	RelativeEnd	The End relative date (or Relative end date or End) property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.
Use relative date	UseRelativeTime	The Use relative date check box indicates whether to use relative dates and time for the chart. Use the Begin/Start and End properties to specify the relative date ranges to use in the chart. If Use relative date is unchecked all dates and time will be absolute. Use the Begin/Start and End properties to specify the absolute date ranges to use in the chart.
Rollup period	RollupPeriod	The Rollup period property works in conjunction with the Rollup unit to define the interval by which a specified Rollup type takes place. For example, if you selected Minutes from the Rollup unit drop-down menu, then typed 3 in the Rollup period field, rollups for the control would occur every three minutes. Enter only whole numbers.
Rollup type	RollupType	By default, a rollup derives its values from raw data stored in the Value History Service (VHS). The Rollup type drop-down menu enables you to rollup data for the selected point. Using the Rollup type option might be preferable to using the data thinning option because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to data thinning. Rollup type options are as follows: None Calculated weighted average Calculated mean (default) Calculated minimum Calculated maximum Calculated delta Calculated last Thin median Thin minimum / maximum Thin last CygNet Help: For Rollup Type definitions and information about how history values are used in rollups, see the History Rollups topic in the CygNet Help: History > History Data > History Rollups
Rollup unit	RollupUnit	The Rollup unit property options define the time units by which a specified Rollup type takes place. The Rollup Unit options are as follows: None Minutes Hours Days (default) Seconds For instance, if you select Minutes, rollups occur on a minute basis. The interval is further defined by the Rollup Period setting, which defines how many (in this case) minutes long a rollup period is.
Top of subunit	RollupTopUnit	The Rollup top of subunit property enables you to specify the time offset by which a rollup is evaluated with greater precision. Subunit refers to the next smaller unit of time from the time unit defined in the Rollup unit property. So, if Rollup unit is set to hours, the implied rollup subunit would be set to minutes. The numeric value is the number of subunits added to starting time of each cell or series. Using the example of hours and minutes, if the starting time of an item would otherwise have been 09:00 AM, if subunits is set to 15, the starting time of that item would be 09:15 AM.
String	String	The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary.
Yes/No	YesNo	The Yes/No property specifies a generic Boolean yes/no property that can be used when scripting this control. Click the check box to enable the property and reference it in your script as necessary.

UI Property

Script Property

Description

Name Type Style

Name

ControlName

The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. Names cannot start with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane.

Type

ControlType

The read-only Type property displays the type for the control: Chart, Grid, Heat Map, Object Container, Tag Chooser, View, etc. … The control's Type is also displayed on the Controls view of the Screen pane.

Style

The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type.

Click to reveal a drop-down menu of predetermined styles configured for the selected control.
Select a desired style and its properties will be applied to the control.
Alternately, you can create a new style based on other property values configured for the control.
Or you can select <None> to remove subscription to any style.

Styles are created in two ways:

In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information.
In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information.

Tip: You can also change a control's Style on the Controls view of the Screen pane.

Location

Height

Height

The Height property specifies the height of the control (or screen).

Tip: You can also change the height of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Horizontal resize mode

HorizontalResizeMode

The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include:

None — No resizing occurs.
Shift — The object will shift horizontally.
Expand — The object will expand or shrink horizontally the same number of pixels as the screen.
Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

Layer

Layer

The Layer property specifies the layer for this control. Layers are used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.

Type the name of the layer into the Layer field.
All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode.

Tip: You can also edit a control's Layer on the Controls view of the Screen pane.

Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.

Vertical resize mode

VerticalResizeMode

The Vertical resize mode property specifies whether and how the control dynamically moves or resizes vertically when the screen is resized in run mode. Options include:

None — No resizing occurs.
Shift — The object will shift vertically.
Expand — The object will expand or shrink vertically the same number of pixels as the screen.
Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

Visible

IsVisible

The Visible check box indicates whether the control is visible in run mode.

Tip: You can also change a control's Visible setting on the Controls view of the Screen pane.

Width

Width

The Width property specifies the width of the control (or screen).

Tip: You can also change the width of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

Z index

ZIndex

The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer).

Tip: You can also change the Z index of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Script

Include in script

The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True.

Tip: You can also change the Include in Script setting on the Controls view of the Screen pane.

Heat Map

Background color

BackgroundColor

The Background color property specifies the background color of the screen, object, or control. Click Down arrow to select a color using the color picker.

Cell padding

CellPadding

The Cell padding property specifies the size of the padding around each heat map cell in pixels.

Facility sender

Facilities

FacilitySender

SetFacilities

The Facility sender property specifies the name of the control that will send its list of facilities to this control. This property is used instead of a facility filter.

High range color

HighRangeColor

The High range color property specifies the color to be used at the high end of the value range. Click Down arrow to select a color using the color picker.

Low range color

LowRangeColor

The Low range color property specifies the color to be used at the low end of the value range. Click Down arrow to select a color using the color picker.

Row header font size

RowHeaderFontSize

The Row header font size property specifies the font size for the text that lies to the left of each row in the heat map.

Row height

RowHeight

The Row height property specifies the height of each heat map row. Only applicable if the Row sizing mode is set to Fixed.

Row sizing mode

RowSizingMode

The Row sizing mode specifies the method used to size the heat map row height. Options include:

Auto — Automatically size the rows based on the height of the heat map.
Fixed — Size the rows using the value specified in the row height property. If this requires more vertical space than is available, a scroll bar will be added.

The default value is Auto.

Show cell labels

ShowCellLabels

The Show cell labels check box indicates whether to display the value in each cell. Note that displaying a value may have an impact on performance.

Show scale

ShowScale

The Show scale check box indicates whether to display the color scale beneath the heat map.

Show tooltips

ShowTooltips

The Show Tooltips check box indicates whether to display tooltips when hovering over a data point or cell. When you hover over a data point or cell in run mode the tooltip displays the point value and timestamp. Only available when a control is showing points.

Show top labels

ShowTopLabels

The Show top labels check box indicates whether to display the date and time labels along the top of the heat map.

UDC

UDC

The UDC property specifies the UDC for which the control is to display data. Click Open dialog box to select a UDC using the Select UDC dialog box.

Range

Begin date

DateStart

The Begin date (or Start or Start date) property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

Begin relative date

RelativeStart

The Begin relative date (or Relative start date or Start) property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

End date

DateEnd

The End date (or End) property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

End relative date

RelativeEnd

The End relative date (or Relative end date or End) property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

Use relative date

UseRelativeTime

The Use relative date check box indicates whether to use relative dates and time for the chart. Use the Begin/Start and End properties to specify the relative date ranges to use in the chart.

If Use relative date is unchecked all dates and time will be absolute. Use the Begin/Start and End properties to specify the absolute date ranges to use in the chart.

Rollup

Rollup period

RollupPeriod

The Rollup period property works in conjunction with the Rollup unit to define the interval by which a specified Rollup type takes place. For example, if you selected Minutes from the Rollup unit drop-down menu, then typed 3 in the Rollup period field, rollups for the control would occur every three minutes. Enter only whole numbers.

Rollup type

RollupType

By default, a rollup derives its values from raw data stored in the Value History Service (VHS). The Rollup type drop-down menu enables you to rollup data for the selected point. Using the Rollup type option might be preferable to using the data thinning option because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to data thinning. Rollup type options are as follows:

None
Calculated weighted average
Calculated mean (default)
Calculated minimum
Calculated maximum
Calculated delta
Calculated last
Thin median
Thin minimum / maximum
Thin last

CygNet Help: For Rollup Type definitions and information about how history values are used in rollups, see the History Rollups topic in the CygNet Help:

History > History Data > History Rollups

Rollup unit

RollupUnit

The Rollup unit property options define the time units by which a specified Rollup type takes place. The Rollup Unit options are as follows:

None
Minutes
Hours
Days (default)
Seconds

For instance, if you select Minutes, rollups occur on a minute basis. The interval is further defined by the Rollup Period setting, which defines how many (in this case) minutes long a rollup period is.

Top of subunit

RollupTopUnit

The Rollup top of subunit property enables you to specify the time offset by which a rollup is evaluated with greater precision. Subunit refers to the next smaller unit of time from the time unit defined in the Rollup unit property. So, if Rollup unit is set to hours, the implied rollup subunit would be set to minutes. The numeric value is the number of subunits added to starting time of each cell or series.

Using the example of hours and minutes, if the starting time of an item would otherwise have been 09:00 AM, if subunits is set to 15, the starting time of that item would be 09:15 AM.

Generic

String

String

The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary.

Yes/No

YesNo

The Yes/No property specifies a generic Boolean yes/no property that can be used when scripting this control. Click the check box to enable the property and reference it in your script as necessary.