Gantt Class Properties

These properties are used by the Gantt class. The properties are described in alphabetic order.

Description

This property has been deprecated and is ignored.

Description

Use this property to specify the date and time where the time line should end. The value must be of type Date or DateTime.

This property is read-write.

Description

Use this property to specify the date and time where the time line should begin. The value must be of type Date or DateTime.

This property is read-write.

Description

This property has been deprecated and is ignored.

Description

This property has been deprecated and is ignored.

Description

Use this property to specify whether to show grid lines with the chart.

Gantt charts only support the %ChartGrid_Vertical and %ChartGrid_None values.

Grid lines are shown within the chart section of the Gantt chart, if enabled, and are tied to the major tick mark. The major tick mark is associated with the smallest time increment displayed on the time line axis. For example, if both years and months are displayed on the time line axis, the major tick marks denote the months.

If you do not specify a value, no grid lines are shown (%ChartGrid_None).

This property controls only the display of grid lines. If you want to specify the style of the grid lines, use the GridLineType property.

The values are:

Numeric Value

Constant Value

Description

0

%ChartGrid_None

Don't show grid lines (default)

2

%ChartGrid_Vertical

Show vertical grid lines

This property is read-write.

Description

Use this property to specify the style of the grid lines when vertical grid lines are turned on—that is, the GridLines property must be set to %ChartGrid_Vertical.

The default value is %ChartLine_Dash. The possible values are:

Numeric Value

Value

Description

0

%ChartLine_Solid

Draw grid lines with solid lines.

1

%ChartLine_Dash

Draw grid lines with lines composed of dashes (default).

2

%ChartLine_Dot

Draw grid lines with lines composed of dots.

This property is read-write.

Description

Use this property to specify the height of the chart. This property takes a numeric value. The unit of measurement is pixels.

You can use this property to overwrite the height set in Application Designer.

If you try to read this property before setting it, the value returned is zero.

This property is read-write.

Description

This property has been deprecated and is ignored.

Description

Use this property to specify whether the user can change the end date of a task by dragging and dropping.

Note: Drag-and-drop is not supported on touch-friendly mobile devices such as an Apple iPad.

This property takes a Boolean value: True if the user can change the end date, False otherwise.

The default value of this property is False.

This property is read-write.

Description

Use this property to specify whether the user can move a task bar by dragging and dropping.

Note: Drag-and-drop is not supported on an Apple iPad.

This property takes a Boolean value: True if the user can move the bar, False otherwise.

The default value of this property is False.

This property is read-write.

Description

Use this property to specify whether the user can change the progress value of a task by dragging and dropping.

Note: Drag-and-drop is not supported on an Apple iPad.

This property takes a Boolean value: True if the user can change the progress value, False otherwise.

The default value of this property is False.

This property is read-write.

Description

Use this property to specify whether the user can change the start date of a task by dragging and dropping.

Note: Drag-and-drop is not supported on an Apple iPad.

This property takes a Boolean value: True if the user can change the start date, False otherwise.

The default value of this property is False.

This property is read-write.

Description

The IsDrillable property is used with the task bars as well as the task dependency lines in the chart section of a Gantt chart. Where the user is directed depends on whether a URL is provided or not, as detailed in this table:

User Action

If URL is not provided:

If URL is provided:

Clicks a task bar.

FieldChange event is associated with the field that is set with SetTaskDrill.

Redirects to URL provided by field identified using the SetTaskBarURL method.

Clicks a task dependency line.

FieldChange event is associated with the Child ID field in the Task Dependency table.

Redirects to URL provided by field identified using the SetTaskDependencyURL method.

This property takes a Boolean value: True if the end-user can click the chart to initiate an action, and False otherwise.

The default value for this property is False.

This property is read-write.

Description

This property has been deprecated and is ignored.

Description

Use this property to set or return the row height for each row in the Gantt chart as Number value representing pixels. The default value is 25 pixels.

This property is read-write.

Description

This property has been deprecated and is ignored.

Description

Use this property to specify whether or not task labels are displayed alongside the corresponding task bar in the chart area. This property takes a boolean value; true to display the labels, false to not display the labels. The default is to display the labels.

This property is read-write.

Description

Use this property to specify the style class that defines the overall appearance attributes of the chart . The value must be a valid style class within the style sheet specified for the chart.

This property is read-write.

Description

This property has been deprecated and is ignored.

Description

Use this property to specify an integer value that specifies the line type of the line connecting dependent tasks. This value affects all the dependency lines for the entire Gantt chart, not just for a specific set of tasks.

This property is read-write.

See Styling PeopleSoft Charts.

Numeric Value

Constant Value

Description

0

%ChartLine_Solid

Solid line

1

%ChartLine_Dashed

Dashed line

2

%ChartLine_Dotted

Dotted line

3

%ChartLine_Mixed

Mixture of dashes and dots

Description

Use this property of type integer to specify which field in the record defines the glyph to represent a task milestone (for both planned and actual milestones). This glyph is used for the entire chart, not just for a specific task.

By default a diamond shaped glyph will be used.

Milestones associated with planned dates use colors defined by the SetPlannedTaskBarColor method. Milestones associated with actual dates use colors defined by the SetActualTaskBarColor method.

This property is read-write.

Description

Use this property to specify the column title to be displayed in column one (that is, the left-most column) in the table section of the Gantt chart. Use the SetTaskAppDataTitles method to specify the column titles for the application specific data fields (that is, column two and beyond).

This property is read-write.

Description

Use this property to specify the width of the chart. This property takes a numeric value. The unit of measurement is pixels.

Generally this property is used with charts created for iScripts, to specify the width of the image, before generating the image map. You can also use it to overwrite the width set in Application Designer.

If you try to read this property before setting it, the value returned is zero.

This property is read-write.