The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Special characters and spaces are not allowed. Names cannot start with a number; an underscore will be prefixed if the control name starts 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.

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

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

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.

The Layer property specifies the name of the layer to which this object is assigned. Layers can be 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 (the name can be a previously created layer or a new layer).
• All layers are listed on the Layers pane, where you can manage the layers for the screen in design mode and run mode.

The Lock property indicates whether the control is locked to the current position. A locked control cannot be moved via click and drag, or nudged with the arrow keys, or resized.

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.

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

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

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.

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.

The Items property is a read-only collection of all map items contained in the control, independent of visibility. This property is only accessible via script.

The VisibleItems property is a read-only collection of all visible map items contained in the control. This property is only accessible via script.

The Center property represents the center point of the map view when first displayed in run mode and is indicated by location coordinates. If no value is entered (default), the map is centered at 0°N 0°E, a point where the Prime Meridian intersects with the Equator, in the Gulf of Guinea off the coast of West Africa. Type the desired latitude and longitude location coordinates, for example, 29.76045,-95.36978, which represents the city of Houston, TX.

The Distance unit property specifies the distance units (or scale) to use for the map. Options are Kilometers or Miles (default).

The Layers property is where you configure the properties required to display the layers that will appear on your map. Layer properties include its name, visibility, data source, facility source, and visuals, which can be an image, a geometric shape, or a Canvas object. You can add as many layers and items as you want to your map. Click to open the Map Layer Configuration dialog box.

The Layers > General tab of the Map Layer Configuration dialog box is used to specify shared properties about each layer on the map control. Properties are grouped into the Common and Facility categories.

• Click Add layer to add a layer to the map.
• Select the new row in the Layers grid to reveal the configuration properties for the selected item. Configure the General and Visuals properties for each layer as necessary.
• Or click (Delete layer) to remove a layer from the map as necessary.

Layers > General tab > Common property group

The Name specifies the name of the map layer.

The Visible check box indicates whether to display the layer on the map in run mode.

The Data source specifies the source of the data used in the map layer. Only one option is available:

• CygNet — The data used in the map layer will be sourced from the facility coordinates specified in the Facility service attributes. See Configuring Map Settings for more information.

Layers > General tab > Facility property group

The Facility property specifies the facility source for the map layer. Options include:

• Source — Options include <Self> or Screen.
  • <Self> — Select <Self> to explicitly configure the facility for this layer, which can be further filtered. An override SiteService source and service can also be configured. <Self> is the default value.
  • Screen — Select Screen to inherit the facility from the screen for this map layer.

The Facility filter option is visible only if the Facility Source is <Self>.

Use the Facility filter property to limit the data presented in the control (or row or layer) to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

SiteService is only visible if the Facility Source is <Self>.

The SiteService property specifies the source SiteService for the map layer. Options include:

• Source — Options include <Self> or Screen.
  • <Self> — Select <Self> to explicitly configure the SiteService for this control or screen element. A SiteService selector is displayed:
    • SiteService — The SiteService property specifies the SiteService for which the control (or screen or screen element) is to display data. Click to select a service using the Select Service dialog box.
  • Screen — Select Screen to inherit the SiteService from the screen for this control or screen element. By default, the sender is the Screen control if no other senders have been configured.

The Layers > Visuals tab of the Map Layer Configuration dialog box is used to configure the visuals displayed on each map layer. By default, this could be an image or icon to represent a facility location on the map layer, for example, well facilities could show an oil droplet icon. Alternately, you can display a geometric shape at the facility location or a Canvas object (.cob file).

• Click Add visual to add an item to the map layer.
• Select the new row in the Visuals grid to reveal the configuration properties for the selected item. Configure each item as necessary:
  • Layers > Visuals > Image configuration
  • Layers > Visuals > Shape configuration
  • Layers > Visuals > Object configuration
• Or click (Delete visual) to remove a visual item from the layer as necessary.

Layers > Visuals > Image/Shape/Object > Common property group

The Name specifies the name of the item on the map layer.

The Visibility property specifies the visibility mode and zoom level of a visual item on a map layer. Use this property to restrict the item to a zoom range. By assigning different zoom ranges to different visuals you can change what is displayed as you zoom in and out of the map. For example, you could display an small image (e.g. a well icon) to designate facility locations when zoomed out to a state level, which could then change to display a Canvas object displaying additional facility information as you zoom into a neighborhood where facilities are located.

The Visibility options include:

• On — Visibility for the visual item is always on and is based on the configured Zoom level property.
• Zoom — Specify the zoom range for the visual item. Type a value to indicate the minimum and maximum zoom level for this visual. See Restrict Visual to a Zoom Range for more information.
  • Minimum zoom — The Minimum zoom level where this visual item will be displayed on the map layer. For reference, the following values approximate the zoom levels: World = 2, State = 4, Region = 10, City = 14, Neighborhood = 18.
  • Maximum zoom — The Maximum zoom level where this visual item will be displayed on the map layer. For reference, the following values approximate the zoom levels: World = 2, State = 4, Region = 10, City = 14, Neighborhood = 18.

Layers > Visuals > Image > Advanced > Image property group

If the item on the map layer is an image, you can specify an image to represent facility locations on the map layer, for example, wells could show an oil droplet image. The common image types are supported (SVG, BMP, JPG, PNG, etc…). Browse for the image file.

Click to select a path and file from the Open / Open File / Select File dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Image size property indicates the size of the item on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Image height property indicates the height of the configurable image to be displayed on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Image width property indicates the width of the configurable image to be displayed on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Image Selection dialog box is where you configure CygNet-aware images that will dynamically change based on the point state of the associated point. The point state preference is configured in the Resolution mode property. A default image is displayed if you configure point-state-aware images and no matching state exists.

Click to open the Image Selection dialog box.

The Point scheme property lists the point schemes used in this CygNet domain. The point scheme defines the point types, point alarms, point statuses, and default colors for a CygNet domain.

The Point type property lists the point types used in the selected point scheme. The point types are configured for the selected point scheme for your CygNet system. The default CygNet Standard Point Scheme has eight point types: Analog Input & Analog Output, Digital Input & Digital Output, Enumeration Input & Enumeration Output, and String Input & String Output.

The Point state property lists the point states used in the selected point type. Point state is the highest precedented state for a point record as defined for each point scheme. The point state for a point record is based on 48 System, Configuration, and User status bits, which are associated with the four point types (Analog, Digital, String, Enumeration). A point record may contain up to 48 status bits, which are used to provide point status information about the point record in a CVS and the ELSALM. A point can be in multiple states at the same time, for example, in High Warning and High Alarm; however, the state defined to be the most severe is the one that is used for the point state (i.e., High Alarm, in this case).

The Image property indicates the file path and file name of the image that will be substituted when the point state changes to the selected point state. Browse and select the desired image file. Click to select a path and file from the Open / Open File / Select File dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. A thumbnail of the selected image, and its dimensions are displayed for each point state.

The Resolution mode property determines how a point's status should be used to select images to display. The image will display based on the point state or the alarm condition of the associated point. The point state of the associated point is evaluated to determine which image to display. Options include:

• Point state — all possible point states are included
• Alarm condition — only point states marked explicitly as an alarm condition in the CVSMetadata are included (point states with the alarm condition attribute set to "true")

The default option is Point state. Point-state-aware images are configured in the Images property.

The Size mode property specifies the method used to size the image so it can scale without distortion. Options include:

• Stretch — Resizes the image to fill the entire area, while maintaining its native aspect ratio.
• Auto — Displays the image using its raw size. If the image is too big to fit within the boundaries of the area, sizing follows the Stretch behavior.

The default value is Auto.

If the Image height and/or Image width values exceed the boundaries of the visual, the image uses the selected Size mode behavior and is uniformly stretched to fit the item's boundaries. If the Image height and/or Image width values are smaller than the boundaries of the item, the image will be centered within the item's boundaries.

Layers > Visuals > Image/Shape > Advanced > Value property group

The UDC property specifies the UDC to use with the list of facilities to generate the points that will populate this map visual. Click to select a UDC using the Select UDC dialog box.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Suppress data retrieval check box indicates whether all CygNet data retrieval is suppressed for the control or map visual. Use this if you want to store point information in the control but don't want to automatically query services for data. Tokens will not be replaced and point state colors will be ignored.

You can configure the control with a valid point configuration but the control will not retrieve any CygNet data. This allows you to display static text for a control, while still allowing CygNet data context available from script.

If a control has a point configured, but Suppress data retrieval is enabled, Canvas won’t do much point processing. The one exception is for point validity. If the control is configured to Hide invalid tag, then Canvas will check if the current tag is valid, even if Suppress data retrieval is enabled. This will allow you to configure some static text that will dynamically hide in the case of a templated screen for a facility that doesn’t have that particular point.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Value format property specifies the format for the point's value using any of the valid .NET standard or custom numeric format strings. The value format applies to a point's Value, Primary Value, and Alternate Value properties. The default value format is #,##0.00, which corresponds to 123,456,789.12. Formats use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. Add additional zeros to show more decimal places.

The Hide invalid tag check box indicates whether to hide the control or map visual if it resolves to an invalid or unknown tag.

The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to a point's Timestamp, Last Verified Change Timestamp, and Last Questionable Change Timestamp properties. Use this property to override the default format, which is configured on the Settings page of the Backstage view. The default format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2019/01/01 10:20:30.0001. All timestamps are local client time.

Layers > Visuals > Image/Shape > Advanced > Display property group

The Text property specifies the text that will appear on the face of the visual item. The item can display a static text string, such as a label, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value. Click to configure the static text and/or property tokens using the CygNet Property String dialog box.

The Mouse cursor property determines which mouse cursor will appear when the mouse hovers over this control or map visual. Select an option from the drop-down menu: Arrow (), Hand (), Wait (), or Help (). The default cursor is the Arrow ().

Layers > Visuals > Image/Shape > Advanced > Font property group

The Font size property specifies the font size of the text on the control or map visual.

The Text style property specifies the style to use for the text that appears on the control or map visual. Options include: Normal, Italic, or Oblique. The default value is Normal.

The Text weight property specifies the weight to use for the text that appears on the control or map visual. Options are: Normal or Bold. The default value is Normal.

Layers > Visuals > Image/Shape > Advanced > Tooltip property group

The Tooltip mode property specifies how the tool will be displayed. Options include:

• Text — The tooltip displays as plain and/or tokenized text defined in the Tooltip property, using resolved point and facility properties.
• Object — The tooltip displays as a Canvas object, passing in the facility tag of the control.

The default value is Text.

The Tooltip enabled property indicates whether to display a tooltip when the mouse hovers over the control or map visual.

The Tooltip property specifies the text that will appear on the tooltip. The text display a static text string, such as a label, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value. Click to configure the static text and/or property tokens using the CygNet Property String dialog box.

Layers > Visuals > Shape > Advanced > Shape property group

The Custom line style property specifies a special abbreviated syntax that defines the line's pattern. If you want to manually modify these values, set the Line style type to Custom. For example, 1 3 1 renders a dot-dash-dot effect.

The Line style property specifies the style of the shape's border line. Click to select from the following options: Custom, Solid, Dashed, and Dotted. The default value is Solid. Select Custom to define your own line style and enter the values in the Custom line style property.

The Line width property specifies the width of the shape's border line.

The Shape geometry property specifies a special abbreviated syntax that defines the shape's geometry. If you want to manually modify these values, set the Shape type to Custom.

See Configuring Your Own Custom Shapes for information about how to create your own custom shapes.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Shape type property specifies the type of shape to draw on the map layer. Click to select from the following options:

• Circle
• Custom (default)
• Diamond
• Horizontal Line
• Vertical Line
• Square
• Triangle
• Horizontal Valve
• Vertical Valve

The default value is Custom. Select Custom to define your own shape and enter the values in the Shape geometry property.

See Configuring Your Own Custom Shapes for information about how to create your own custom shapes.

The Shape size property indicates the height and width of the shape on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Shape height property indicates the height of the shape to be displayed on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Shape width property indicates the width of the shape to be displayed on the map layer.

* As a commonly configured property, this property appears in two locations in the configuration pane: at the top and within its property category. The property can be configured in either location.

The Stretch property describes how the shape is resized to fill its allocated space. Click to select from the following options:

• None — The shape preserves its original size.
• Fill — The shape is resized to fill the destination dimensions. The aspect ratio is not preserved.
• Uniform — The shape is resized to fit in the destination dimensions while it preserves its native aspect ratio.
• UniformToFill — The shape is resized to fill the destination dimensions while it preserves its native aspect ratio. If the aspect ratio of the destination rectangle differs from the source, the shape is clipped to fit in the destination dimensions.

The default value is Fill.

Layers > Visuals > Shape> Advanced > Color configuration property group

The Fill color property specifies the color used for the internal body of the shape.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Text color property specifies the color used for the text on the control or map visual.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Line color property specifies the color used for the border line of the shape.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

Layers > Visuals > Object > Object property group

If the visual item on the map layer is an object, you can specify a Canvas object file (.cob) to represent facility locations on the map layer, for example, a small object could display details about a facility location on the map. Browse for the object file (.cob).

Click to select a path and file from the Open / Open File / Select File dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder.

Map properties continued…

The Mode property indicates the map view mode to use when first displayed. Options include:

• Road — Displays road imagery with labels, which is a set of static tiles generated ahead of time and then stored and served. Road is the default mode.
• Aerial — Displays worldwide orthographic aerial and satellite imagery with labels. You can hide the labels at runtime using the map toolbar. See Using a Map in Run Mode.

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.