Skip to content

Project Basics Information

Project Basics Tables

Startup Screen

ItemDescription
Create New ProjectOpens the New Project window to assign settings for a new project.
Open Project FilesOpens a file explorer window to select a ".cnvs" file to open a project.
Offline HelpOpens the Canvas Offline Helpfile in a new browser tab.
Online HelpOpens the Canvas Online Helpfile in a new browser tab.
About CanvasOpens the About Canvas window that displays the currently installed Canvas version.
Grid ViewChanges the Recent Projects display to show projects in a grid formation.
List ViewChanges the Recent Projects display to show projects in a list formation.

New Project

ItemDescription
Project NameAssigns a name to the user's project.
The project name and the file name are not required to match, and changing the project name will not automatically update the filename.
Save LocationAssigns a location to save the user's project. The project file will be saved in the ".cnvs" format.
The default path is C:\Users\User. This changes to the most recent location a project was created at after the first project.
Screen SizeUsers can decide the project file type according to the dimension of each Xpanel model. The table below displays the model selections along with their widths and heights.
Screen Size - eXT04, eXT07, nXT07800x480
Screen Size - eXT2-10800x600
Screen Size - eXT2-071024x600
Screen Size - eXT10-H, eXT12-H, eXT151024x768
Screen Size - eXT2-10W1280x800
Screen Size - CustomUser Selection
WAllows the user to determine their custom project-page pixel width. A default selection will be made when selecting any screen size besides custom.
HAllows the user to determine their custom project-page pixel length. A default selection will be made when selecting any screen size besides custom.
LandscapeSwaps the entered W (width) and H (height). If a preset Screen Size is selected, landscape will provide a horizontal orientation.
PortraitSwaps the entered W (width) and H (height). If a preset Screen Size is selected, portrait will provide a vertical orientation.
Password - CheckboxWhen the box is checked, the user can set up a password for the project. Password requirements:
1. The password is case-sensitive.
2. Alphanumeric characters, special characters, and spaces may be used.
3. The password must contain at least 8 characters.
4. The password is displayed as "****" while typing. The visibility may be toggled by clicking the icon to the right of the field. The password selected cannot be retrieved if forgotten.
Password - Recovery EmailAssigns a recovery email that CIMON will reference to begin a recovery process. If access to the recovery email is lost, CIMON will not continue the recovery process with any other email.
Password - New PasswordEnter a new password for the project.
Password - Re-Enter PasswordRe-enter the project password to confirm.
OKCloses the New Project window and creates a project with the entered information.
CancelCloses the New Project window and discards the entered information.

Project Properties

ItemDescription
Expand AllShows all dropdown content within the Project Properties window.
Collapse AllHides all dropdown content within the Project Properties window.
NameAssigns a name to the user’s project.
Recovery EmailAssigns a recovery email to the user's project. If a password removal is requested, the project will be sent to this email.
Project PasswordOpens a project password window to assign or edit the user’s password for the project.
Starting PageAssigns the first page shown when the project is loaded.
Screen SizeDisplays the preset or Custom selection for the project’s screen size.
Screen OrientationDisplays the selection between landscape and portrait. If a preset screen size is selected, landscape will provide a horizontal orientation, and portrait will provide a vertical orientation.
Default Page WidthDisplays the width that new pages will be created with. This matches the W (width) field in the New Project and Convert Project Size windows.
Default Page HeightDisplays the height that new pages will be created with. This matches the H (height) field in the New Project and Convert Project Size windows.
Default Background ColorAssigns a default color for backgrounds of created pages.
Default BackgroundsAssigns up to three default pages to be backgrounds of created pages.
Default OverlaysAssigns up to three default pages to be overlays of created pages.
Preload PagesAssigns pages to preload at project startup to reduce load time to get to the assigned pages.
Beep on TouchControls whether an Xpanel will audibly beep when touched during runtime.
Enable NotificationsControls whether notifications will be shown.
Indicate ClickableControls whether clickable objects indicate that they are clickable when hovered over.
Show Comm Error OverlayControls whether the red X over communication errors will be shown.
Show Permissions WarningControls whether permission warnings will be shown.
User TimeoutControls whether a logged-in user will be logged out after the designated hours and minutes of inactivity.
HoursAssigns a duration in hours to be added to minutes, which, when the length of inactivity exceeds the time, logs the current user out.
MinutesAssigns a duration in minutes to be added to hours, which, when the length of inactivity exceeds the time, logs the current user out.
Limit 3-Button Menu AccessRejects the use of the 3-Button Menu unless the currently logged-in user has the assigned permissions.
Enable Minimum Password LengthControls whether users have a minimum password length and that the user can change the Minimum Password Length (1-16) field to a value 1-16.
Minimum Password Length (1-16)Assigns a minimum length for User passwords. The default minimum length is 8.
Require Number And LetterControls whether User passwords require at least one number and letter to be included.
Require Special CharacterControls whether User passwords require at least one special character to be included.
Enable Password Reset IntervalControls whether the user can change the Password Reset Interval (Days 1-9999) field to a value 1-9999 and check the Require Password Reset field.
Password Reset Interval (Days 1-9999)Assigns a duration in days which, when surpassed, a User requires a password reset. The default minimum length is 1.
Require Password ResetControls whether a User requires a password reset after the designated amount of days.
Change Password On First LoginControls whether a User is prompted to change their password on the first login.
EnableControls whether Audit Logging is enabled or disabled.
Database TypeAssigns a type of database to be used when audit logging. The database types are Maria DB, MySQL, PostgreSQL, and SQLite.
Any database other than SQLite will store data using an external SQL database which must be set up and configured outside of Canvas. This will require a valid connection between the Xpanel and the SQL server. A database named “audit_event_database” must be on the SQL server.
Retention Time (Days)Assigns a duration in days to retain audit logging information. The default length is 180.
ServerAssigns a server to the project’s SMTP properties.
Server Port NumberAssigns a server port number to the project’s SMTP properties. The default port number is 25.
Require AuthenticationControls whether the project’s Email/SMTP function requires a Username and Password.
UsernameAssigns a username to attempt with the given password to log into the assigned server.
PasswordAssigns a password to attempt with the given username to log into the assigned server.
EncryptionAssigns an encryption type for SMTP. The Encryption types are SSL, TLS, and None.
Use Device HostnameControls whether emails will be sent with the assigned name or the name of the current device.
Sender NameAssigns a name to be displayed when sending emails.
The assigned name will only display when Use Device Hostname is unchecked.
Sender Email AddressAssigns an email address to send emails with.
Send Test EmailOpens a test email window that uses the assigned email configuration to send a message to a specified email and included CC’s.
The message will be automatically populated with a default Canvas Test Email.
Base Page Current NumberThe number of the current page the project is on.
Base Page Request NumberThe index of the page to be opened.
Auto-Reset Request NumberToggle to set the request value to -1 after used.
Popup Page Control ValueEnables the use of the Popup Page Request Number.
Popup Page Request NumberThe index of the popup page to be opened.
Popup Page X PositionAssigns the X position to the Popup page when opened.
Popup Page Y PositionAssigns the Y position to the Popup page when opened.

Convert Project Size

ItemDescription
Screen SizeUsers can decide the project file type according to the dimension of each Xpanel model. The table below displays the model selections along with their widths and heights.
Screen Size - eXT04, eXT07, nXT07800x480
Screen Size - eXT2-10800x600
Screen Size - eXT2-071024x600
Screen Size - eXT10-H, eXT12-H, eXT151024x768
Screen Size - eXT2-10W1280x800
Screen Size - CustomUser Selection
WAllows the user to determine their custom project-page pixel width. A default selection will be made when selecting any screen size besides custom.
HAllows the user to determine their custom project-page pixel length. A default selection will be made when selecting any screen size besides custom.
LandscapeSwaps the entered W (width) and H (height). If a preset Screen Size is selected, landscape will provide a horizontal orientation.
PortraitSwaps the entered W (width) and H (height). If a preset Screen Size is selected, portrait will provide a vertical orientation.
Resize objectsControls whether objects will be resized to the newly assigned screen size.
Apply to pop-up pagesControls whether the newly assigned screen size will apply to pop-up pages.
Maintain object aspect ratioControls whether objects will be anchored to a direction after screen size is changed.
AnchorAssigns a direction for objects to anchor to when the Maintain object aspect ratio field is checked. The Anchor directions are Top Left, Center, and Bottom Right.
BackupControls whether a backup project will be made with the assigned name and path after screen size is changed.
Backup NameAssigns a name to the user’s backup project.
The project name and the file name are not required to match, and changing the project name will not automatically update the filename.
Backup PathAssigns a location to save the user’s backup project. The project file will be saved in the “.cnvs” format.
The default path is C:\Users\User. This changes to the most recent location a project was created at after the first project.

Designer Settings

ItemDescription
Expand AllShows all dropdown content within the Designer Settings window.
Collapse AllHides all dropdown content within the Designer Settings window.
Default Save LocationAssigns a location to save the user’s project or backup project when a save location is asked for.
The Default Save Location field will change to the most recent location a project was saved at.
LanguageAssigns a language to be shown on all fields and names in Canvas. The supported languages are English, Korean, Spanish, Thai, and Portuguese.
AutosaveControls whether the user’s project will automatically save every 5 minutes. If a blocking window is open, which forces the user to press OK or Cancel, the project will wait to save until no blocking windows are open.
Auto-Resize FontControls whether text objects will automatically re-size font when resizing the object.
ThemeAssigns a display theme to Canvas. The supported themes are Light and Dark.
Allow system.executeControls whether system.execute commands can be used within the Simulator.
Show system.execute warningControls whether warnings will be shown when using system.execute commands within the Simulator.

Basic Properties

Each feature will have personalized tables. The following table combines the Basic Properties pane of all objects:

ItemDescription
Expand AllShows all dropdown content within the Basic Properties pane.
Collapse AllHides all dropdown content within the Basic Properties pane.
NameAssigns a name to the user’s object.
TextAssigns a string to the object’s initial text value. A tag may be bound to this property to control the value in runtime.
Transparent ColorSets a color to be treated as transparent.
PlaceholderAssigns text to be shown when there is no typed string and no tag with a string value is bound. A tag may be bound to this property to control the value in runtime.
Input HintControls which on-screen keyboard variant is displayed when clicking on a Text Field object while using a physical Xpanel.
Echo ModeControls if typed characters are displayed and in an encrypted format or not.
EnabledControls whether or not the Text or Numeric Field or a button is interactable. A tag may be bound to this property to control the value in runtime.
Use On-Screen KeyboardControls whether or not the On-Screen Keyboard is shown when clicking on a Text or Numeric Field while using a physical Xpanel.
Focus IndexControls the order that pressing tab gives focus. If any Focus Index fields have equivalent values, the tab will focus from least recently to most recently created.
PreviewDisplays the data format shown when accounting for decimal places and leading zeros.
Decimal PlacesSets how many decimal places there should be in the data.
Using Leading ZerosControls whether or not there will be leading zeros for data output.
Leading ZerosSets how many leading zeros to use.
BaseSet between a Decimal or Hexadecimal base.
Use Thousands SeparatorControls whether or not there will be a comma between every three digits of a number.
StateControls which state will be shown based on a numeric value. A tag may be bound to this property to control the value in runtime.
ImageSets an image to be displayed for the current state.
Font NameControls the font style of the object’s text. A font can be imported to use by clicking the plus button.
Font SizeControls the size of the object’s text. A tag may be bound to this property to control the value in runtime.
ItalicSets the object’s text to be italicized. A tag may be bound to this property to control the value in runtime.
BoldSets the object’s text to be bolded. A tag may be bound to this property to control the value in runtime.
UnderlineSets the object’s text to be underlined. A tag may be bound to this property to control the value in runtime.
Text ColorSets the color of the object’s text. A tag may be bound to this property to control the value in runtime.
Horizontal AlignmentSets the alignment area of text on the object’s x-axis.
Vertical AlignmentSets the alignment area of text on the object’s y-axis.
TagAssigns a tag to an object’s parameter. Some objects require a tag to be bound to function.
On Press ValueAssigns this value to a Momentary Button’s tag value when pressed.
On Release ValueAssigns this value to a Momentary Button’s tag value when unpressed.
Min ValueSets the minimum value displayed by the object. A tag may be bound to this property to control the value in runtime.
Max ValueSets the maximum value displayed by the object. A tag may be bound to this property to control the value in runtime.
ValueSets a value to display in a Numeric Text Object, Fillable Rectangle, or Gauge. A tag may be bound to this property to control the value in runtime.
Major StepsSets the number of sections the value range is divided into. A tag may be bound to this property to control the value in runtime.
Minor StepsSets the number of sections each major step range is divided into. A tag may be bound to this property to control the value in runtime.
Labels EnabledControls whether or not the number display for major steps is visible. A tag may be bound to this property to control the value in runtime.
Ticks EnabledControls whether or not the lines for minor steps is visible. A tag may be bound to this property to control the value in runtime.
Date Time FormatSets the format of time.
Sample Period (ms)Configures time interval for the data display. Values between 100 and display time are accepted.
Min ValueSets the minimum value of the y-axis. A tag may be bound to this property to control the value in runtime.
Time DirectionSets the direction the pen lines flow.
HistoricalRemoves storage cap for Trend data.
HoursSets the Hours Time Span value. This is shown on the x-axis.
MinutesSets the Minutes Time Span value. This is shown on the x-axis.
SecondsSets the Seconds Time Span value. This is shown on the x-axis.
DescriptionAssigns a description for the current pen.
Pen ColorAssigns a color to the line of the current pen.
Pen WidthAssigns a width to the line of the current pen.
Pen TypeAssigns a style to the line of the current pen.
Data Logger ModelSets a Data Model that a data a Data Log Table will display.
Format TypeSets the Format to be Numeric or to follow the Tag Formatting in the Tag List in a Data Logger Model.
Include ID ColumnControls whether or not Columns will display their ID.
Column WidthSets the Width of the Column in pixels.
Initial TabControls the starting tab of an Alarm Summary object on the initialization of the project and re-opening of the page. The default is the “Active Alarms” tab.
VisibilityControls whether an Alarm Summary tab is visible or not. A tag may be bound to this property to control the status in runtime.
DeleteRemoves the Column from an Alarm Summary object’s tab.
ContentControls which type of data is shown in the Alarm Summary’s column.
WidthAssigns the default horizontal distance for an Alarm Summary’s column. This can be changed while in runtime.
FormatSelects the date/time Format for the “Alarm Time” column in an Alarm Summary object.
PrecisionSelects the number of decimal places to follow a value.
Description IndexAssigns the index of the alarm description to display.
Focus IndexSets the priority for what will be selected first.
Auto FocusAutomatically selects the text or numeric field on startup.

Appearance

Each feature will have personalized tables. The following table combines the Appearance pane of all objects:

ItemDescription
Expand AllShows all dropdown content within the Appearance pane.
Collapse AllHides all dropdown content within the Appearance pane.
VisibilityControls whether the object is displayed or hidden. A tag may be bound to this property to control the status in runtime.
OpacityControls the transparency of the object. A tag may be bound to this property to control the value in runtime.
BlinkingControls whether the object blinks. A tag may be bound to this property to control the value in runtime.
Blink Interval(ms)Controls how often the object blinks.
WidthControls the thickness of the lines of an object. A tag may be bound to this property to control the value in runtime.
Stroke ColorControls the color of the lines of an object. A tag may be bound to this property to control the value in runtime.
Stroke TypeControls the style of the lines of an object. The available styles are None, Solid, Dashed, and Dotted.
Fill TypeControls whether an object will fill with the fill color or not. The options are None and Solid.
FillControls the fill color of an object. A tag may be bound to this property to control the value in runtime.
Horizontal RadiusControls the horizontal curvature of a Rectangle’s lines. A tag may be bound to this property to control the value in runtime.
Vertical RadiusControls the vertical curvature of a Rectangle’s lines. A tag may be bound to this property to control the value in runtime.
Start AngleControls the starting location in degrees of an object’s lines. A tag may be bound to this property to control the value in runtime.
Arc AngleControls the amount of degrees an object's lines travel. A tag may be bound to this property to control the value in runtime.
Font NameChanges the font style of the object’s text. A font can be imported to use by clicking the plus button.
Font SizeControls the size of the object’s text. A tag may be bound to this property to control the value in runtime.
ItalicSets the object’s text to be italicized. A tag may be bound to this property to control the value in runtime.
UnderlineSets the object’s text to be bolded. A tag may be bound to this property to control the value in runtime.
BoldSets the object’s text to be bolded. A tag may be bound to this property to control the value in runtime.
Font ColorSets the color of the object’s text. A tag may be bound to this property to control the value in runtime.
Horizontal AlignmentSets the alignment area of text on the object’s x-axis.
Vertical AlignmentSets the alignment area of text on the object’s y-axis.
Fill DirectionControls the direction that a Fillable Rectangle fills. The available directions are Top to Bottom, Bottom to Top, Left to Right, and Right to Left.
Background ColorControls the color of the cells for an Alarm Summary object or the color around the cells for a Trend object. A tag may be bound to this property to control the value in runtime.
Chart Background ColorControls the color of the cells within a Trend object. A tag may be bound to this property to control the value in runtime.
Grid ColorControls the color of the cells within a Trend object. A tag may be bound to this property to control the value in runtime.
Show ControlsControls whether the Controls of the grid in a Trend object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Time Span LegendControls whether the date and time range of the grid in a Trend object is displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Tag ValuesControls whether pen description and most recent tag values in a Trend object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show GridControls whether a Trend object’s borders between cells are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show X-Axis LabelsControls whether the labels of the x-axis in a Trend object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Y-Axis LabelsControls whether the labels of the y-axis in a Trend object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Value Span SliderControls whether the slider on a Trend object’s right side is displayed or hidden. A tag may be bound to this property to control the value in runtime.
Text ColorControls the color of the text in the cells of a Data Log Table. A tag may be bound to this property to control the value in runtime.
Active ColorControls the color of active alarms in an Alarm Summary object. A tag may be bound to this property to control the value in runtime.
Active Acknowledged ColorControls the color of active acknowledged alarms in an Alarm Summary object. A tag may be bound to this property to control the value in runtime.
Cleared ColorControls the color in which cleared alarms in an Alarm Summary object are displayed. A tag may be bound to this property to control the value in runtime.
Cleared Acknowledged ColorControls the color in which cleared acknowledged alarms in an Alarm Summary object are displayed. A tag may be bound to this property to control the value in runtime.
Display HeaderControls whether the header of each column in an Alarm Summary object is shown. A tag may be bound to this property to control the value in runtime.
Display Grid LinesControls whether the borders between cells are shown or not. A tag may be bound to this property to control the value in runtime.
Display User ControlsControls whether control buttons in an Alarm Summary object are shown or not. A tag may be bound to this property to control the value in runtime.
Show Active AcknowledgedControls the initial selection of whether Active-Acknowledged alarms in an Alarm Summary object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Active UnacknowledgedControls the initial selection of whether Active-Unacknowledged alarms in an Alarm Summary object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Cleared AcknowledgedControls the initial selection of whether Cleared-Acknowledged alarms in an Alarm Summary object are displayed or hidden. A tag may be bound to this property to control the value in runtime.
Show Cleared UnacknowledgedControls the initial selection of whether Cleared-Unacknowledged alarms in an Alarm Summary object are displayed or hidden. A tag may be bound to this property to control the value in runtime.

Transform

All objects' Transform panes are identical.

ItemDescription
XControls the horizontal placement of an object. A tag may be bound to this property to control the value in runtime.
YControls the vertical placement of an object. A tag may be bound to this property to control the value in runtime.
Z IndexControls the layering of objects. Objects with a lower z-index will lay on top of objects with a higher z-index. The lowest z-index is 0.
WidthControls the horizontal distance of an object. A tag may be bound to this property to control the value in runtime.
HeightControls the vertical distance of an object. A tag may be bound to this property to control the value in runtime.
RotationControls the rotational orientation of an object. A tag may be bound to this property to control the value in runtime.
Use PercentageControls whether Rotation Centers X and Y are used as percentages or values.
Rotation Center XSets the x-position of where the object will rotate from.
Rotation Center YSets the y-position of where the object will rotate from.

Actions

Objects may have action functionality for on press, on release, on double-click, or on enter. The following table combines the Actions pane of all objects:

ItemDescription
Expand AllShows all dropdown content within the Actions pane.
Collapse AllHides all dropdown content within the Actions pane.
Touch EnabledControls whether or not the object has touch functionality. A tag may be bound to this property to control the value in runtime.
Hold (ms)Sets a length of time a user must be pressing down before the On Press action executes.
ActionAssigns a command or script to execute On Press, On Release, or On Double-Click.
Delay (ms)Sets a length of time that will pass before the On Release action executes.
Interval (ms)Sets a length of time that starts when a user clicks and must click again before it elapses before the On Double Click action executes.
PermissionsAssigns permissions that a logged-in user is required to have to interact with the object.

Status Bar

ItemDescription
Cursor CoordinatesRelays the information of the user’s cursor pixel location within the graphic page.
MagnificationRelays the information of the user’s currently selected magnification level.
Device Connection StatusRelays whether the user is connected or disconnected from their selected device(s). Green is all connected, yellow is some disconnected, and red is no connection.