Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

Gantt Chart

  • Last UpdatedJun 28, 2024
  • 7 minute read

Basic

Property

Description

Name

Name that identifies the control. This value is also used for the label of the control.

XML Node

(Required) XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.

  • Prefix with to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use forward slash ( / ) for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

    The default value is the value for the Name property without the spaces.

Note:
- If you use a forward slash (/) to denote a parent, which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.
- If you edit this value later, then it may affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Lookup Source

(Required) Name of the item from the lookup list.

To add a name of the item for the control from the lookup list:

  1. Click the Lookup Source button. The Lookup Source Configuration page appears.

  2. In the Data Source Type list, select a type of data source.

    Note: Supported datasource types are database and Web API lookup source.

  3. In the Data Source box, select a data source.

  4. In the Parameters section, select the parameters to include, if applicable.

  5. Click Save & Continue. The selected name is set for the control and the Lookup Source Configuration page is closed.

Event State

Column name that corresponds to the state of an event in the selected lookup source.

The maximum number of displayed characters for the value of this property is 25. If the value exceeds the character limit, an ellipsis is added and the full column value is shown in a tooltip on mouse hover.

Note: This property is shown in the details pane with the Event Color as part of the header for a Gantt Chart's selected segment. In the body of the details pane, the Event Start Time, Event End Time, and Event Name properties are shown.

Event Start Time

Column name that corresponds to an event's start time in the selected lookup source.

Note: This must be in UTC format in the source and in the lookup configuration, its data type must be set to DateTime.

Event End Time

Column name that corresponds to an event's end time in the selected lookup source.

Note: This must be in UTC format in the source and in the lookup configuration, its data type must be set to DateTime.

Event Name

Column name that corresponds to the name or description of an event in the selected lookup source.

The maximum number of displayed characters for the value of this property is 25. If the value exceeds the character limit, an ellipsis is added and the full column value is shown in a tooltip on mouse hover.

Event Color

Column name that corresponds to the color of an event in the selected lookup source.

Appearance

Property

Description

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Label Position

Position of the label for the control.

  • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

  • Select Left to align the label to the left of the control.

  • Select Top to align the label to the top of the control.

  • Select Right to align the label to the right of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Default.

Note: If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.
For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

Label-Control Area

Area occupied by the label and the control in percentage.

  • Select Default to allow the system to set the label and the control areas.

  • Select Custom to specify the label area. The control area is automatically set based on the label area.

    The default value is Default.

Note: If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.
This is applicable only when the Label Position is set to Left or Right.

Width

Width in pixels for the control.

The default value is 0.

Note: If the value is 0, then the width of the control is set as per the default values.

Retain Space

Reserve or remove space when the control is hidden.

  • Select Yes to keep space when the control is hidden.

  • Select No to remove space when the control is hidden.

    The default value is No.

Bar Thickness

Thickness of the Gantt bar in pixels.

The default value is 0. The value other than the default must be from 10 to 150 pixels.

Time Period

This controls the period of data to be displayed in the Gantt Chart control.

  • Select Duration to specify a time period in hour. This is based on the last segment's end time relative to now. If this is selected, the Duration property is shown after the Time Period property with 8 hours as the default value. Otherwise, Duration property is hidden.

  • Select Time Range to enable the use of ganttTimeRangeStartTime and ganttTimeRangeEndTime properties in scripting.

    You can use the Time Range start and end time properties with Date Time or Text controls when scripting.

    For example scripts, see Scripting Guidelines for Time Period property. For more information on Date Time and Text controls, see Date Time and Text.

The default value is Duration.

Duration

See Time Period property.

Note: If this property is updated through scripting or refreshData() is triggered, the Gantt Chart control is redrawn. Currently selected segment and its details pane are no longer shown.

Show Details Pane

Show or hide the Gantt Chart segment's details pane.

  • Select Yes to show the details pane when a segment in the control is selected.

  • Select No to hide the details pane and remove the space it occupies.

    The default value is Yes.

Show Time Range

Show or hide the start and end date/time.

  • Select Yes to show the start and end date/time in the control.

  • Select No to hide the start and end date/time in the control.

    The default value is No.

    The start time is calculated based on the specified value in the Duration property subtracted from the last segment end time (end time - duration).

Title Position

Position of the title for the control.

  • Select Left to align the title to the left of the control.

  • Select Right to align the title to the right of the control.

  • Select Suppress to hide the title for the control.

    The default value is Left.

Title

Title of the Gantt control. It is shown directly above the top-left corner of the control.

This supports two lines with 35 characters for each line. An ellipsis is added if it exceeds the 35-character limit. If you want to add a line break, use the html tag <br>.

Note: If this property is not configured or blank, nothing is shown, the other control contents use its space, and the control size is adjusted based on the available content within the control.

Custom Style Sheet Identifier

Prefix for the CSS class name in the custom style sheet.

For information about using custom style sheets, see Custom Styles.

Note: The value must start with an alphabet and can contain only alphanumeric characters.

Advanced

Property

Description

On Click

Run a script after the control is clicked.

ID

Reference identification code for the control. This value is automatically generated and cannot be changed.

Enable Refresh

Enable or disable control auto refresh.

  • Select Yes to enable control refresh and configure the Refresh Rate property.

  • Select No to disable control refresh.

    The default value is No.

Note: This property will not work on the control even if it is set to Yes if the control segment's details pane is shown.

Refresh Rate

This is how often the control display is refreshed, in seconds, to fetch value from the data source.

Note: This is only visible if the Enable Refresh property is set to Yes.

The default value is 30 seconds and the valid refresh rate is from 10 to 600 seconds.

Enable Action (1 - 3)

Call the script defined in a particular Action Script property in the Scripts tab.

The default value is No.

If you keep the default, the action button is not visible in the segment details window.

If you set this to Yes, its corresponding Action property appears, where you can specify the name or label of that particular action.

Action (1-3)

Name or label for Action (1-3).

The maximum number of displayed characters is 8. If it exceeds the character limit, an ellipsis is added and the full label is shown in a tooltip on mouse hover.

Scripts

For information about using scripts, see scripting guidelines Gantt Chart for control.

TitleResults for “How to create a CRG?”Also Available in