Chart Class

This chapter provides an overview of the PeopleSoft Chart class and discusses the following topics:

• Chart terms.

• Chart types.

• Style sheets and charts.

• Font considerations for extended languages.

• Component processor considerations.

• Translation considerations.

• Label considerations.

• Bar chart considerations.

• iScripts and charts.

• Bubble chart considerations.

• Line chart considerations.

• Data series.

• Gantt charts.

• Error handling.

• Data type of a chart object.

• Scope of a chart object.

• Chart class reference.

• Chart class built-in functions.

Understanding the Chart Class

The PeopleSoft Chart class enables you to plot data in charts according to your specifications. You can create a chart by setting data using PeopleCode. You can create a chart based on a chart control on a page, or at runtime using an Internet Script (iScript).

Possible uses for the chart control include:

• charting dynamic data, such as current prices of selected commodities, from a rowset.

• plotting stored data, such as product prices, for graphic analysis of trends, from a record.

The chart class supports the following features:

• Three-dimensional representation.

• Support for all major chart types.

• Control over the various elements of the chart such as the axes, legend, and titles.

• Interactive charts. The user can click on the different data elements of the chart to trigger further processing.

You can specify a rowset and have it graphed using a chart object with minimal PeopleCode. Within this rowset there must be a column containing data for the X axis and one for the Y axis. If more than one series of data is used, an additional column should indicate the series values. Color and popup text for each point could also be set in this rowset using additional columns.

The following distinguishable types of data can be involved in a chart:

• Primary data.

• Secondary or overlay data.

The overlay data may be quite different to the primary data so an additional rowset is needed.

There is only one object used with the chart class, that is, a chart object. There are no subobjects. All methods and properties are used with the chart object. You do not have to instantiate a subobject to access its properties and methods.

However, for a conceptual overview, it's easier to view the chart object in pieces. Just remember that these pieces do not represent subobjects.

A chart contains the following major parts:

• X Axis

• Y Axis

• Overlay

• Legend

• Data

• Title

The X, Y, and Overlay axes have access to titles and labels associated with their data. The following is a conceptual overview of the chart class.

Overview of chart class

Chart Terms

Charts can be composed of many different elements, such as a legend, a title, a label, and so on. The following is a list of general chart terms and their description. Specific chart terminology (such as for Gantt charts) is found in those specific sections:

See Also

Gantt Charts

Understanding Gantt Chart Terms

Chart Types

The following chart types are available for PeopleSoft Chart:

• 2D Bar.

• 2D Histogram.

• 2D Horizontal Bar.

• 2D Horizontal Percent Bar.

• 2D Horizontal Stacked Bar.

• 2D Line.

• 2D Percent Bar.

• 2D Pie.

• 2D Scatter.

• 2D Stacked Bar.

• 3D Bar.

• 3D Percent Bar.

• 3D Pie.

• 3D Stacked Bar.

• Gantt.

2D Bar

The following is an example of a two-dimensional bar chart.

2D Histogram

The following is an example of a two-dimensional histogram chart.

2D Horizontal Bar

The following is an example of a two-dimensional horizontal bar chart.

2D Horizontal Stacked Bar

The following is an example of a two-dimensional horizontal stacked bar chart.

2D Horizontal Percent Bar

The following is an example of a two-dimensional horizontal percent bar chart.

2D Line

The following is an example of a two-dimensional line chart without numeric axes, that is, with IsTrueXY specified as False.

The following is an example of a two-dimensional line chart with a numeric X and Y axis, that is, with IsTrueXY specified as True.

2D Percent Bar

The following is an example of a two-dimensional percent bar chart.

2D Pie

The following is an example of a two-dimensional pie chart.

2D Scatter

The following is an example of a two-dimensional scatter chart.

2D Stacked Bar

The following is an example of a two-dimensional stacked bar chart.

3D Bar

The following is an example of a three-dimensional bar chart.

3D Percent Bar

The following is an example of a three-dimensional percent bar chart.

3D Pie

The following is an example of a three-dimensional pie chart.

3D Stacked Bar

The following is an example of a three-dimensional stacked bar chart.

Gantt

The following is an example of a Gantt chart.

Style Sheets and Charts

A style sheet is a definition, like a record or field definition, that you create in PeopleSoft Application Designer. It contains a collection of formatting styles (called classes) each of which can be applied to either the entire chart or to specific elements within a chart.

You can use a style sheet, and the styles in a style sheet, for the different parts of a chart. You can either specify a style sheet for the entire chart (using either the chart Style or StyleSheet property) or for an element (using that element's Style property.) The override rules are:

1. If you specify the Style property for any element (XAxis, XAxisTitle, YAxis, YAxisTitle, Legend, MainTitle, and so on) the style is used.

2. If you don't specify the Style property for any element of a chart object, but you specify either the Style or StyleSheet property for the chart object itself, that style is used for the unspecified elements.

3. If you don't specify styles for any elements of a chart object, and you don't specify style for the chart object itself, a default style for any chart object is used.

Note. PeopleSoft recommends not using your own styles or style sheets unless absolutely necessary.

See Also

Creating Style Sheet Definitions

Considerations Using Style Sheets

The following style sheet properties are only supported for PeopleSoft Chart:

• Font Family.

• Font Foreground Color.

• Font Size.

• Font Style (only Normal and Italic are supported.)

• Font Weight (only Normal and Bold are supported).

Default Style Sheet Classes

The default style sheet associated with a PeopleSoft Chart is PTSTYLEDEF. The default classes associated with this style sheet include:

Considerations for Gantt Charts

In Gantt charts, the PSCHARTDEFAULT style class uses an 8 point font with a normal weight. This style class affects all text in the chart area, such as task labels, DateTime X-axis labels, and hints. The PSCHARTGANTTGRID style class uses a 10 point font, also with a normal weight, and affects all text in the table area. For the font size between the table and chart areas to be the same, the point size in the PSCHARTGANTTGRID style class should be 1.25 times the point size of the font defined in PSCHARTDEFAULT. Note, however, that the font size for PSCHARTGANTTGRID should not exceed 13; otherwise, column text may bleed over into another column.

Font Considerations for Extended Languages

The environment variable JAVA_FONTS must be set correctly so the fonts that are used in charting can be picked up by the application server's Java Virtual Machine. It must be set to include the paths to any TrueType fonts that are used to support extended languages. This can be set at the system level or in psconfig.sh.

The following is is an example of this variable being set:

JAVA_FONTS=$PS_HOME/jre/lib/fonts:/usr/share/fonts/default/TrueType:/usr/share/fonts/ja/TrueType:/usr/share/fonts/zh_CN/TrueType:/usr/share/fonts/zh_TW/TrueType:/usr/share/fonts/ko/TrueType;export
JAVA_FONTS

Component Processor Considerations

Sometimes records at level zero on a page are considered work records, even when they aren’t specified as such in PeopleSoft Application Designer. Work records aren’t updated by the database and are skipped when the component is run.

A level zero record gets marked as a work record when:

• All the fields for the record are used as read-only fields.

• All the values for these fields can be read from the input keys.

When a chart field is attached to a level zero record field of a record considered a work record, it’s also skipped when the system determines that record's 'work' status.

See Also

Referencing Data in the Component Buffer

Translation Considerations

If you hardcode a value for a label, a title, a data hint, and so on, that value is not translated. Be sure to specify field values or message catalog entries that will be translated.

Label Considerations

Chart labels are shown based on the size of the axis, fonts, and charts on the page. If all the labels are not displaying for your chart, you should either make the chart larger or the font smaller.

Pie chart labels are staggered, so that, in most cases, both labels can be read. However, if one or both of the labels are very long, they could be truncated or completely missing from the chart.

For Gantt charts, use double quotes to correctly display the use of single quotes in your label, if applicable.

Bar Chart Considerations

If the bars on a bar chart are too narrow, a user may not be able to click on them. Sometimes this affects a few bars on a chart, sometimes all of the bars cannot be clicked. The workaround is to put fewer bars on your chart, or to make your chart bigger, so that each bar is wider.

iScripts and Charts

PeopleSoft supports two types of charts:

• Charts generated using the chart control on a page.

• Charts generated at runtime and used in an iScript.

To build a chart at runtime, use the CreateObject function instead of the GetChart function. You can then use the GetChartURL Response class method to use the URL in your application.

The following is an example of building a chart using a standalone rowset:

Function IScript_GetChartURL() 
local object &MYCHART; 
local string &MYURL; 
 
&MYCHART = CreateObject("Chart"); 
&MYCHART.SetData(xx);  
 
/* xx will be a data row set */ 
 
&MYURL = %Response.GetChartURL(&MYCHART); 
 
/* use &MYURL in your application */ 
... 
End-Function;

See Also

Creating a Chart Using an iScript

Bubble Chart Considerations

Bubble charts are a type of scatter chart, where points of data are plotted in two dimensional space along a numeric X and Y axis. Bubble charts add the ability of being able to display an extra dimension of data through the size of each point or glyph, that is, the size of the glyphs is scaled from the data.

Each point in a bubble chart can be individually colored, clicked on to start PeopleCode program, and can have pop up text associated with it. Programming a scatter chart is similar to creating the other charts: at a minimum, you need to specify the data record (rowset), the X data field, and the Y data field.

The size of the glyphs can be set within the data. Each point in the chart, along with the regular pop up text can also have online annotations associated with it.

When you create a bubble or scatter chart, a TrueXY axis is automatically set, that is, the IsTrueXY property is set to true.

See Also

Line Chart Considerations

IsTrueXY

Line Chart Considerations

The X axis on a line chart is either a category axis or a TrueXY axis:

• With a category axis, each data marker is placed along the axis according to its position in the data series.

• With a TrueXY axis, each data marker is placed along the axis according to its numeric value.

You use the IsTrueXY property to control whether the X axis is a TrueXY axis or not.

The following charts use the exact same data series:

In the first example, IsTrueXY is set to false, which means that the X axis is a category axis and the values along it are place in the order in which they occur in the data set. Note the order of the numbers along the X axis:

In the following example, IsTrueXY is set to true, so the X axis is a TrueXY axis. The order of the numbers along the X axis is now numeric.

See Also

IsTrueXY

Data Series

Data Series

A data series is a group of related information. You can group the same information into more than one series. All of the following charts use the same data set.

In the following example, there are three data series, based on product:

Each series is indicated with its own discreet line.

In the following example, each data series is grouped by product. There are several different products, each with its own data series.

Gantt Charts

A Gantt chart displays tasks along a timeline. Gantt charts are frequently used in project management because they can provide a graphical illustration of a schedule, which helps to plan, coordinate, and track specific tasks in a project.

This section provides an overview of Gantt chart terminology and discusses how to:

• Use Gantt charts in PeopleSoft Pure Internet Architecture.

• Create Gantt charts.

• Specify DateTime axis format.

• Work with start and end dates.

• Use Gantt glyphs.

Understanding Gantt Chart Terms

Gantt charts can be composed of many different elements, such as a title, a label, and so on. The following is a list of terms that apply specifically to Gantt charts.

Using Gantt Charts in PeopleSoft Pure Internet Architecture

The Gantt chart consists of two sections: a table section and chart section.

The left side of the chart, where you see the table, is the table section. The other side, where you see the bars, is the chart section.

Table Section

The table section contains all of the tasks and associated subtasks and displays them in a hierarchy. Tasks that contain subtasks are called parent tasks and subtasks are called child tasks. You can click on the expand (collapse) image to the left of the task name (Baby, above) to expand or collapse the hierarchy of subtasks. Note that subtasks may also act as parent tasks to other subtasks.

Each task has a name Born, Baby, Childhood, and so on.) It also has a level. Parent tasks have a higher level than child tasks.

Horizontal scrollbars are provided under the table section to support scrolling through the task-related columns. The amount that a table section scrolls depends on the value set for the SetTableXScrollBar method. Each click on the arrow scrollbar scrolls the task either left or right by the amount set with the SetTableXScrollBar method (or 10% of the table area, if a value isn't set.)

See SetTableXScrollbar.

Chart Section

The chart section displays the tasks, task dependencies, and milestones graphically.

In the example above, each horizontal bar represents a single task. The progress bar, that is, the percentage complete for a particular task, is indicated with a bar of a different color on top of the task bar. The milestone date (in the above screen shot, Graduate) is represented with a circle.

You can also have dependencies between the tasks. These are represented as lines connected the task bars.

Creating Gantt Charts

Every Gantt chart has at least one data set used to define the tasks and the information related to each task, such as start date, end date, milestones, percent finished, and so on.

A second data set can be used to describe dependencies between the tasks.

The following is a list of the required methods for using the Gantt chart:

• SetTaskData

  Use this method to specify where most of the information for the Gantt chart is stored. You can specify either a rowset or a record.

• SetTaskID

  Use this method to specify the task ID, or name, of the task. Every task must have a unique task identifier. The task ID is used to support task linking and dependencies.

• SetPlannedStartDate

  Use this method to specify the planned starting date of the task. Each task must have its own planned starting date.

• SetPlannedEndDate

  Use this method to specify the planned ending date of the task. Each task must have its own planned ending date.

Though not required, PeopleSoft recommends also using the SetTaskName method to display meaningful information in the table section of the Gantt chart.

If you only use the required methods, and do not use the SetTaskAppData method, PeopleSoft recommends that you also use the SetChartArea method and dedicate most, if not all, of the entire area to the chart (and not the table.)

If you specify one actual date, either for start or end, you must specify the other (SetActualStartDate, SetActualEndDate).

In addition, if you want to use dependency data, the following methods are required:

• SetTaskDependencyData

  Use this method to specify where most of the information for the dependency data is stored. You can specify either a rowset or a record.

• SetTaskDependencyParentID

  In a dependency, one task depends on another. Use this method to specify the parent task, that is, the one that the other (child) task depends upon.

• SetTaskDependencyChildID

  In a dependency, one task depends on another. Use this method to specify the child task, that is, the one that depends on another.

Specifying DateTime Axis Formats

You can control the display of the label format that describes the DateTime axis in up to six different time increments, from seconds to years, or any combination thereof simultaneously for a given time period. Each time increment, if enabled through the DateTimeAxis specific methods, occupies a single level within the X axis hierarchy. Smaller time increments display closer to the axis, while larger time increments display farther from the axis.

The following example shows the levels of the labels for the DateTime axis. The first level, in seconds, is the closest level to the chart edge, next are minutes at the second level, then hours at the third level, and so on. Generally, the smallest unit should be on the lowest level. So, if months and years are displayed, months display at the first level and years display at the second.

In the following example, days, months, and years are defined at levels 1, 2, and 3, respectively. This means that the days of the month (1, 10, 20) are displayed closest to the chart area, the months are displayed below them, and the years below that.

By default, the DateTime axis displays both the year and the months, with the major tick mark marking the months.

Note. The charting algorithm may or may not display a given time increment, even if it is enabled. The resolution of the given time increments may be too great, depending on the length of the time period defined in the chart section.

See Also

Gantt Chart DateTimeAxis Specific Methods

Working with Start and End Dates

You must set the end date to be after the start date, for both the planned as well as actual dates, or else you receive an error.

Both the start and end dates you specify for a task must fall within the axis dates, that is, the dates specified by the AxisEndDateTime and AxisStartDateTime properties. If you specify task dates that fall outside of the axis dates, the task is still displayed in the table section of the Gantt chart, but no bar displays in the chart section of the Gantt chart, even if one of the dates does fall inside the axis dates.

Using Gantt Glyphs

The following lists all the glyphs you can use with the Gantt chart.

You can use either the numeric or constant value.

Error Handling

The PeopleCode program is terminated if a field or record is missing at runtime.

If a valid record is specified but no data is found, or for any other error, the chart is replaced by the message " Image creation failed."

If the Java Runtime Environment (JRE) is missing, an error appears and is logged.

Data Type of a Chart Object

Chart objects are declared using the Chart data type. For example,

Local Chart &MyChart;

Component Chart &Abs_Hist_Chart;

Scope of a Chart Object

A chart object can be instantiated only from PeopleCode.

You can use this object only in PeopleCode programs that are associated with an online process, not in an Application Engine program, a message subscription, a Component Interface, and so on.

Chart Class Reference

The following sections contain the methods and properties used with a chart.

The reference is divided up among the different parts of a chart, however, all methods and properties are used with the chart object: there are no subobjects in a chart.

• Chart Data Methods and Properties: Used to set X and Y axes data.

• Chart Appearance Properties: Used to set the type of graph, the line style, and so on.

• Chart Color Methods: Used to set and manipulate colors for either a series or for each point.

• Chart Axis Methods and Properties: Used to further control the appearance of the axes.

• Chart Title Properties: Used to set the text and style of titles for the graph and the axes.

• Chart Legend Methods and Properties: Used for each series legend.

• Chart Overlay Methods and Properties: Used to set and manipulate overlay data.

• Bubble Chart Methods and Properties: Used to set and manipulate bubble charts.

• TrueXY Line Chart Properties: Used to set and manipulate TrueXY line charts.

• Gantt Chart Methods and Properties: Used to set and manipulate Gantt charts.

Chart Class Built-in Functions

CreateObject

GetChart

GetChartURL

GetGanttChart

Chart Data Methods

These methods are used to set X and Y axes data.

Refresh

Syntax

Refresh()

Description

Use the Refresh method if the underlying data of the chart has changed, and you want to update the chart.

Note. You don't need to use the Refresh method after setting a property or method of the chart itself, such as setting the starting point or changing colors. When a method or property is used, the refresh method is automatically called.

Parameters

None.

Returns

None.

Example

&MyChart.Refresh();

See Also

chart data class: DataStartRow property, DataWidth property, SetDataXAxis method, SetDataYAxis method.

Reset

Syntax

Reset()

Description

Use the Reset method to clear out all existing chart settings and data.

Parameters

None.

Returns

None.

See Also

chart data class: Refresh method.

SetData

Syntax

SetData({Record_Name | &Rowset})

Description

Use the SetData method to specify where the data from the chart is coming from.

You can use either a record name or an already instantiated, populated rowset. In general, specify a record when building a chart from page data and a rowset when building a chart from a standalone rowset.

If you make a change to the underlying data of a chart, use the Refresh method to update the chart.

Parameters

Returns

None.

Example

The following is the minimum code you need to create a Peoplesoft chart.

Local Chart &MyChart; 
 
&MyChart = GetChart(ABS_HIST.CHART); 
&MyChart.SetData(ABS_HIST); 
&MyChart.SetDataYAxis(ABS_HIST.Reason); 
&MyChart.SetDataXAxis(ABS_HIST.Duration);

The following example creates a chart using a standalone rowset.

Function IScript_GetChartURL() 
local object &MYCHART; 
local string &MYURL; 
local rowset &MYROWSET; 
 
&MYCHART = CreateObject("Chart"); 
 
&MYROWSET = CreateRowset(Record.ABS_HIST); 
 
&EmplID = %Emplid; 
 
&MYROWSET.Fill("Where EMPLID :=1", &EmplID); 
 
&MYCHART.SetData(&MYROWSET);  
&MYCHART.SetDataXAxis(ABS_HIST.ABSENCE_TYPE); 
&MYCHART.SetDataYAxis(ABS_HIST.DURATION_DAYS); 
 
&MYURL = %Response.GetChartURL(&MYCHART); 
 
/* use &MYURL in your application */ 
... 
End-Function;

See Also

chart data class: SetDataXAxis method, SetDataYAxis method.

SetDataHints

Syntax

SetDataHints(Record_Name.Field_Name)

Description

Use the SetDataHints method to specify the field that contains the text that displays as a data hint.

What displays for a data hint depends on the value specified for the data hints method, as well as the value specified for the series and the data method.

Series Data but No Data Hints

If you do not specify data hints, but you do specify both the data series and data methods, the hints appear as follows:

Value value for point x position of series series

Where:

• value is the Y data value

• x position is the X axis label

• series is the series value

The following is an example of this type of data hints. The pop-up menu appears when the cursor hovers over any data value.

Data Hints, Data, and Series

If you specify data hints, that is the value that appears. In the following example, the data hints are set to the same value as the series is set, that is, the region.

Data and Series, but no Data Hints

If you do not specify SetDataHints and do not specify SetDataSeries, the value of the Y axis appears in the data hint:

Parameters

Returns

None.

Example

The following PeopleCode example:

&oChart.SetDataHints(QE_CHART_RECORD.QE_CHART_REGION);

Could produce data hints as follows:

Data hints set to the region value

See Also

chart data class: SetDataXAxis method, SetDataSeries method.

SetDataSeries

Syntax

SetDataSeries(Record_Name.Field_Name)

Description

Use the SetDataSeries method to specify the name of the field containing the series values. Every distinct value in this field is considered a unique series.

The series is plotted in the order given by the record.

By default, the legend is populated by the value of this field.

If this value is Null, the system assumes there is only one series to plot.

Parameters

Returns

None.

Example

&MYCHART.SetDataSeries(MYRECORD.MYSERIES);

See Also

chart data class: SetDataXAxis method, SetDataYAxis method.

SetDataURLs

Syntax

SetDataURLs(FieldName)

Description

Use the SetDataURLs method to specify a URL to be launched when a data point is clicked in the chart. The URL for each point must be given as a string, that is, enclosed with quotation marks. You can also specify recordname.fieldname. Use this method for charts created from a chart control or a standalone rowset.

One use of this method could be to launch a JavaScript that generates a pop-up menu.

Parameters

Returns

None.

Example

&MyChart.SetDataURLs(MyRecord.URL);

SetDataXAxis

Syntax

SetDataXAxis(Record_Name.Field_Name)

Description

Use the SetDataXAxis method to specify the groups along the X axis.

If this value is not set or Null, the Y values are plotted along the X axis in groups labeled by their order number.

The order of the data is plotted in the order of the data in the record.

By default, the labels along the X axis are populated by the value of this field.

Parameters

Returns

None.

Example

In the following example, the Y axis is set to a numeric amount, while the X axis is set to the products.

&oChart = GetChart(QE_CHART_DUMREC.QE_CHART_FIELD); 
 
&oChart.SetData(Record.QE_CHART_RECORD); 
&oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); 
&oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT); 
&oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION);

X axis set with product data

See Also

chart data class: SetDataYAxis method, SetData method.

SetDataYAxis

Syntax

SetDataYAxis(Record_Name.Field_Name)

Description

Use the SetDataYAxis to specify the data to plot in the chart.

The Y axis is always considered the data axis.

The Y axis must always be numeric. If the greatest Y axis value is less than ten, the Y axis labels are given a decimal place. If the greatest Y axis value is greater than or equal to ten, the Y axis labels are displayed as integers.

Note. If you've specified negative numbers in the Y axis, the X axis is drawn according to the XAxisCross property.

Parameters

Returns

None.

Example

&oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES);

See Also

chart data class: SetDataXAxis method, SetData method.

Chart Data Properties

These properties are used to set X and Y axes data.

DataStartRow

Description

This property sets or returns the row number (after any preprocessing) at which to start plotting. This is useful when you have many rows of data in a rowset, and you want to start at a particular row. This can also be useful for creating your own 'scrolling' effect, by specifying both the start row and how many rows to be displayed (by using the DataWidth property.)

If this property is not set, then the value is 1.

This property is read-write.

See Also

chart data class: DataWidth property.

DataWidth

Description

This property returns or sets the number of rows to plot for a series. The starting point for the number of rows is set with the DataStartRow property. If the DataWidth property value is not set, then the width is from the DataStartRow to the last element in the rowset. If the property value is less than zero, then it will automatically be set to one.

This property is read-write.

Example

Suppose your rowset returned 400 rows. You wouldn't want all 400 to display in your chart. Instead, you'd pick a subset of those rows. The row to start with is set with DataStartRow, while how many rows to display is set with DataWidth.

The following code could be used with a pushbutton connected with a chart. The pushbutton enables the next set of data to be displayed with the chart. Note that you don't need to use the Refresh method with this code example. When a method or property is used, the refresh method is automatically called.

Local Chart &MyChart; 
 
&MyChart = GetChart(ChartRec.DisplayField); 
&Start = &MyChart.DataStartRow; 
/* display the next 20 rows of data */ 
&MyChart.DataStartRow = &Start + 20; 
&MyChart.DataWidth = 20;

See Also

chart data class: DataStartRow property.

ImageMap

Description

This property returns the HTML client-side image map. The image map is what makes the chart interactive.

This property is read-only.

See Also

Creating a Chart Using an iScript.

IsTrueXY

Description

Use this property to enable a TrueXY, or numeric, axis. This causes the X axis data to be loaded as continuous linear numeric data, rather than discrete data, as is used in bar charts for example.

This property is only applicable to scatter, line or histogram charts where the X axis can be numeric.

This property is read-write.

See Also

Line Chart Considerations

TrueXY Line Chart Properties

Chart Appearance Properties

These properties are used to set the type of graph, the line style, and so on.

GridLines

Description

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

If you don't specify a value, no grid lines are shown.

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:

This property is read-write.

Considerations for Gantt Charts

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 DateTime axis using the SetFormat functions such as the SetMonthFormat, SetDayFormat, and so on. For example, if you choose to display both years and months on the DateTime axis, the major tick marks denote the months.

See Specifying DateTime Axis Formats.

See Also

GridLineType

GridLineType

Description

Use this property to specify the style of the grid lines when either or both vertical or horizontal grid lines are turned on.

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

This property is read-write.

Height

Description

Use this property to specify the height 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 height of the image, before generating the image map. You can also use it to overwrite the height set in PeopleSoft Application Designer.

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

This property is read-write.

IsDrillable

Description

Use this property to specify whether the end-user can click on the chart and trigger a PeopleCode program in the FieldChange event for that row.

By default, when the chart data comes from a record, a PeopleCode program in the FieldChange event for the Y-Data field of the clicked row is executed.

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

Note. Setting this property has no effect if the IsPlainImage property is set as True.

Note. When using a chart in an iScript, this property must be used in conjunction with the SetDataURLs method. The SetDataURLs method must point to a field that is populated with the URLs to be triggered for each data point in the chart.

The default value for this property is False.

This property is read-write.

Considerations for Gantt Charts

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.

See Also

IsPlainImage

IsPlainImage

Description

Use this property to specify whether the chart is built without any extra HTML, such as SRC or MAP tags.

If this property is specified as True, the end-user won't be able to click on the chart to trigger an event. In addition, the pop-up data hints won't appear when the end-user passes a mouse over the chart. However, you may see a performance improvement if your chart has an extremely complicated image map and you specify this property as True.

This property takes a Boolean value: True if the chart is built without extra HTML, False otherwise.

The default value of this property is False.

This property is read-write.

LineType

Description

Use the LineType property to specify the style of series that are plotted as lines. This is for a regular series only. To specify the style of line for overlay data, use the OLLineType property.

This property takes either a numeric or constant value. The values are:

This property is read-write.

See Also

chart overlay class: OLLineType property.

RotationAngle

Description

Use this property to specify the rotation angle of the chart. This property is valid only with 3D style charts, that is, charts that have Type set as %ChartType_3DBar, %ChartType_3DStackedBar, and so on.

Note. This property has no effect on the 3D pie chart.

If you change the value of this property, you don't have to use the Refresh method to refresh the chart.

This property takes a numeric value from 1 to 360.

This property does not take negative numbers.

The chart is rotated in a clockwise direction.

This property is read-write.

Style

Description

A style sheet is a definition, like a record or field definition, that you create in PeopleSoft Application Designer. It contains a collection of formatting styles, called classes, each of which can be applied to either the entire chart or to specific elements within a chart.

Use this property to specify the overall style of the chart by specifying a style sheet class. The value must be a valid class within the style sheet specified for the chart.

Individual style properties (such as SetXAxisStyle, MainTitleStyle, and so on) can be used to override this value for individual elements of the chart.

This property is read-write.

StyleSheet

Description

Use this property to associate a style sheet with a chart.

The PTSTYLEDEF style sheet is the default style sheet associated with a chart.

Both the Style property for the chart, and individual style properties (such as SetXAxisStyle, MainTitleStyle, and so on) can be used to override this value for individual elements of the chart.

This property is read-write.

Type

Description

Use this property to specify the type of chart that you want. You can specify either a numeric or constant value for this property. The valid values are:

This property is read-write.

See Also

Chart Types.

Width

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 PeopleSoft Application Designer.

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

This property is read-write.

Chart Colors

The following lists all the values you can use with the chart color methods. You can use either the numeric or constant value.

Chart Color Methods

These methods are used to set and manipulate colors for either a series or for each point.

SetColorArray

Syntax

SetColorArray(&Array_of_Color)

Description

Use the SetColorArray method to set the colors for a series. You can specify only a one-dimensional array for the parameter. This method applies only to base chart data, not to the overlay data.

The type of array can be any of the following:

• String

• Number

• Integer

• Decimal

SetDataColor does not work with line charts. Individual line segments can not be colored as there are less line segments than points. SetColorArray must be used instead to color each complete line (series).

Parameters

See Chart Colors.

Returns

None.

Example

The following example sets the four series in the chart:

&NumArray = CreateArray(1, 3, 6, 9);

&oChart.SetColorArray(&NumArray);

See Also

Array Class.

SetDataColor

Syntax

SetDataColor(Record_Name.Field_Name)

Description

Use the SetDataColor method to specify a field that contains the color for each data point. Each field for each datapoint must contain either a number or a constant, specifying the color you want to use.

SetDataColor does not work with line charts. Individual line segments can not be colored as there are less line segments than points. SetColorArray must be used instead to color each complete line (series).

Note. This method has no effect when used with an overlay.

Parameters

See Chart Colors.

Returns

None.

Chart Axes Methods

These methods are used to further control the appearance of the axes.

SetXAxisLabels

Syntax

SetXAxisLabels(&Array_of_Any)

Description

Use the SetXAxisLabels method to specify an array of labels for the X axis. By default, the labels are populated from the record field specified by SetDataXAxis. Labels specified with SetXAxisLabels overwrite the default labels.

Note. Default label text is automatically translated. If you set your own labels, be sure to use translated text, such as message catalog entries.

Parameters

See Also

chart data class: SetDataXAxis method.

Array Class

SetYAxisLabels

Syntax

SetYAxisLabels(&Array_of_Any)

Description

Use the SetYAxisLabels method to specify an array of labels for the Y axis. Labels specified with SetYAxisLabels overwrite the default labels.

If the greatest Y axis value is less than ten, the default Y axis labels are given a decimal place. If the greatest Y axis value is greater than or equal to ten, the default Y axis labels are displayed as integers.

Note. Default label text is automatically translated. If you set your own labels, be sure to use translated text, such as message catalog entries.

If you set the labels yourself, you may need to set the YAxisTicks and YAxisMax because you no longer have numbers that correlate to the data points.

Parameters

See Also

SetDataXAxis, YAxisTicks, YAxisMax.

Array Class

Chart Axes Properties

These properties are used to further control the appearance of the axes.

XAxisCross

Description

Use this property to specify the appearance of the X axis data when there are both negative and positive values.

You can specify either a numeric value or a constant for this property. Values are:

Example

The following code:

&MyChart.XAxisCross = %ChartXAxisCross_ZeroLineBttm;

produces a chart similar to this:

Example of %ChartXAxisCross_ZeroLineBttm

XAxisLabelOrient

Description

Use this property to specify whether the X axis label is displayed horizontally or vertically.

The default value is horizontal.

You can specify either a numeric value or a constant for this property. Values are:

This property is read-write.

XAxisStyle

Description

Use this property to specify the style of the X axis. The values for this property are the style classes contained in the style sheet associated with the chart.

Note. Pie chart labels take their style from this property.

This property is read-write.

See Also

Style Sheets and Charts.

XAxisTicks

Description

Use this property to specify the number of minor tick marks along the X axis. This property takes a numeric value. To control the major tick marks use the XAxisScaleResolution method.

This property is read-write.

See Also

XAxisScaleResolution

YAxisLabelOrient

Description

Use this property to specify whether the Y axis label is displayed horizontally or vertically.

The default value is horizontal.

You can specify either a numeric value or a constant for this property. Valid values are:

This property is read-write.

YAxisMax

Description

Use this property to specify the maximum value of the Y (data) axis. This property takes a numeric value.

The maximum value sets the largest value that is displayed on the axis.

Note. If the YAxisMax and YAxisMin properties are not set, or are set to too narrow a range, ticks may not appear on the Y axis.

This property is read-write.

YAxisMin

Description

Use this property to specify the minimum value of the X axis. This property takes a numeric value.

The minimum value sets the point at which the chart plots in positive and negative directions.

The default minimum value is the default value of the Y axis.

Note. If the YAxisMax and YAxisMin properties are not set, or are set to too narrow a range, ticks may not appear on the Y axis.

This property is read-write.

YAxisStyle

Description

Use this property to specify the style of the Y axis. The values for this property are the style classes contained in the style sheet associated with the chart.

This property is read-write.

See Also

Style Sheets and Charts.

YAxisTicks

Description

Use this property to specify the number of minor tick marks along the Y (data) axis. This property takes a numeric value. To control the major tick marks use the YAxisScaleResolution method.

This property is read-write.

See Also

YAxisScaleResolution

Chart Title Properties

These properties are used to set the text and style of titles for the graph and the axes.

MainTitle

Description

Use this property to specify the text for the main title of the chart.

This property takes a string value.

This property is read-write.

MainTitleOrient

Description

Use this property to specify the orientation of the text for the main title.

The default value is horizontal.

You can specify either a number or a constant for this property. The values are:

This property is read-write.

MainTitleStyle

Description

Use this property to specify the style of the main title. The values for this property are the style classes contained in the style sheet associated with the chart.

This property is read-write.

See Also

Style Sheets and Charts.

XAxisTitle

Description

Use this property to specify the text for the X axis title.

This property is read-write.

XAxisTitleOrient

Description

Use this property to specify the orientation of the text for the X axis title.

You can specify either a number or a constant for this property. The values are:

XAxisTitleStyle

Description

Use this property to specify the style of the X axis title. The values for this property are the style classes contained in the style sheet associated with the chart.

This property is read-write.

See Also

Style Sheets and Charts.

YAxisTitle

Description

Use this property to specify text of the title for the Y axis.

This property is read-write.

YAxisTitleOrient

Description

Use this property to specify the orientation of the text for the Y axis title.

You can specify either a number or a constant for this property. The values are:

YAxisTitleStyle

Description

Use this property to specify the style of the Y axis title. The values for this property are the style classes contained in the style sheet associated with the chart.

This property is read-write.

See Also

Style Sheets and Charts.

Chart Legend Methods

These methods are used for each series legend.

SetLegend

Syntax

SetLegend(&Array_of_String)

Description

Use the SetLegend method to specify alternative legends. By default, the legends are populated from the record field specified with SetDataSeries.

This method is used to write both the overlay legend and the series legend. The labels are overwritten in the order of elements in the array, that is, the first element overwrites the first series, the second overwrites the second, and so on, with the last element in the array overwriting the overlay legend. There can be more than one series in an overlay.

If you don't specify an element for an array (that is, a blank or a null) then no legend is listed for that series.

Note. Default label text is automatically translated. If you set your own labels, be sure to use translated text, such as message catalog entries.

Parameters

Returns

None.

Example

The following example displays a legend containing only the overlay.

&LegendArray = CreateArray("", "", "Revenue");

&MyChart.SetLegend(&LegendArray);

See Also

chart data class: SetDataSeries method.

Array Class

Chart Legend Properties

These properties are used for each series legend.

HasLegend

Description

Use this property to specify if a legend is displayed with the chart. This property takes a Boolean value: True, if the legend is displayed with the chart, False otherwise.

The default value is False.

This property is read-write.

LegendMaxEntries

Description

Use this property to specify the number of legend entries before a new column (or row) is created.

When the legend position is specified as left or right, the legend is drawn vertically so a new column is created when this property is exceeded.

When the legend position is specified as top or bottom, the legend is drawn horizontally and a new row is created when this property is exceeded.

The default value of this property is five.

This property is read-write.

LegendPosition

Description

Use this property to specify where the legend should appear, in relationship to the chart. You can specify either a numeric or constant value for this property.

Note. ChartLegend_Separate generates a legend without a chart. The legend takes over the entire charting area. The legend appears in the center of the chart.

The values are:

LegendStyle

Description

Use this property to specify the style of the legend. The values for this property are the style classes contained in the style sheet associated with the chart.

This property is read-write.

See Also

Style Sheets and Charts.

Chart Overlay Methods

These methods are used to set and manipulate overlay data.

SetOLData

Syntax

SetOLData({Record_Name | &Rowset})

Description

Use the SetOLData method to specify where the data for the overlay is coming from. If you make a change to the underlying data of a chart, use the Refresh method to update the chart.

There are no default values for the overlay data. You must specify the data.

It is possible to specify two different Y axis fields, however, you must make certain that different data plotted against the same axis makes sense. For example, plotting two dollar amounts would probably be okay. However, plotting dollars against the number of sales, and sharing the same axis, though technically it would work, it wouldn't look correct.

Parameters

See Also

chart data class: SetDataXAxis method, SetDataYAxis method, SetData method.

SetOLDataSeries

Syntax

SetOLDataSeries(Record_Name.Field_Name)

Description

Use the SetOLDataSeries method to specify the name of the field containing the overlay series values. Every distinct value in this field is considered a unique series.

The series is plotted in the order given by the rows in the record.

If this value is Null, the system assumes there is only one series to plot.

Parameters

See Also

chart data class: SetDataSeries method.

SetOLDataXAxis

Syntax

SetOLDataXAxis(Record_Name.Field_Name)

Description

Use the SetOLDataXAxis method to specify the groups along the X axis if the axis is non-numeric for the overlay.

If the X axis is numeric, this method is used to give the position of the points along the axis. Only discrete values are supported for the X axis.

If this value is Null, the Y values are plotted along the X axis in groups labeled by their order number.

The order of the data is plotted in the order of rows in the record.

Parameters

SetOLDataYAxis

Syntax

SetOLDataYAxis(Record_Name.Field_Name)

Description

Use the SetOLDataYAxis to specify the data to plot for the overlay of the chart.

This value must always be numeric.

There is no default value for this method.

Parameters

See Also

chart data class: SetDataXAxis method, SetDataYAxis method.

Chart Overlay Properties

These properties are used to set and manipulate overlay data.

OLLineType

Description

Use the OLLineType property to specify the style of an overlay line.

This property takes either a numeric or constant value. The values are:

See Also

chart appearance class: LineType property.

OLType

Description

Use this property to specify the style of the overlay line.

You can specify either a numeric or a constant value for this property. The values are:

This property is read-write.

Scatter Chart Methods

The methods in this section are only applicable when the chart has been specified as a 2D Scatter chart.

SetDataAnnotations

Syntax

SetDataAnnotation(Record_Name.Field_Name)

Description

Use the SetDataAnnotations method to specify an optional text label that can be associated with each point in the chart.

Parameters

See Also

SetOLDataAnnotations

SetDataGlyphScale

Syntax

SetDataGlyphScale(Record_Name.Field_Name)

Description

Use the SetDataGlyphScale method to specify a field that contains numerical data defining the size of each glyph. These values are mapped to a range of size values between a predefined minimum and maximum.

Parameters

See Also

SetOLDataGlyphScale

SetOLDataAnnotations

Syntax

SetOLDataAnnotation(Record_Name.Field_Name)

Description

Use the SetOLDataAnnotations method to specify an optional text label that can be associated with each point in the overlay of the chart.

Parameters

See Also

SetDataAnnotations

SetOLDataGlyphScale

Syntax

SetOLDataGlyphScale(Record_Name.Field_Name)

Description

Use the SetOLDataGlyphScale method to specify a field that contains numerical data defining the size of each glyph in the overlay chart. These values are mapped to a range of size values between a predefined minimum and maximum.

Parameters

See Also

SetDataGlyphScale

Scatter Chart Property

The property in this section is only applicable when the chart has been specified as a 2D Scatter chart.

ShowCrossHair

Description

Use the ShowCrossHair property to specify whether the chart should be split into quadrants.

This property takes a boolean value. If you specify true, two lines are drawn, one from the middle of the X axis and one from the middle of the Y axis.

TrueXY Line Chart Properties

The properties in this section are only applicable when the chart has been specified as a TrueXY line chart, that is, if the IsTrueXY property has been set to true.

XAxisCrossPoint

Description

Use the XAxisCrossPoint property to specify the point at which the X axis intersects a numeric Y axis. The value is in the coordinate system of the Y axis scale.

This property is read-write.

See Also

YAxisCrossPoint

XAxisMax

Description

The maximum value of the X axis.

This property is only applicable to scatter, line or histogram charts where the X axis is numeric, that is, the IsTrueXY property has been set to true.

This property is read-write.

XAxisMin

Description

The minimum value of the X axis.

This property is only applicable to scatter, line or histogram charts where the X axis is numeric, that is, the IsTrueXY property has been set to true.

This property is read-write.

XAxisPrecision

Description

Use the XAxisPrecision property to control the number of decimal places displayed in the labels of a numeric X axis.

This property is only applicable to scatter, line or histogram charts where the X axis is numeric, that is, the IsTrueXY property has been set to true.

This property is read-write.

See Also

YAxisPrecision

XAxisScaleResolution

Description

Use the XAxisScaleResolution property to control the level of detail displayed on a numeric axis. Use this property to increase or reduce the number of major tick marks and labels on the X axis.

This property is only applicable to scatter, line, bubble, or histogram charts where the X axis is numeric, that is, the IsTrueXY property has been set to true.

The values are:

This property is read-write.

See Also

YAxisScaleResolution

YAxisCrossPoint

Description

Use the YAxisCrossPoint property to specify the point at which the Y axis intersects a numeric X axis. The value is in the coordinate system of the X axis scale.

This property is only applicable to scatter, line or histogram charts where the X axis is numeric, that is, the IsTrueXY property has been set to true.

This property is read-write.

See Also

XAxisCrossPoint

YAxisMax

Description

The maximum value of the Y axis.

This property is only applicable to scatter, line, or histogram charts.

This property is read-write.

YAxisMin

Description

The minimum value of the Y axis.

This property is only applicable to scatter, line, or histogram charts.

This property is read-write.

YAxisPrecision

Description

Use the YAxisPrecision property to control the number of decimal places displayed in the labels of a numeric Y axis.

This property is only applicable to scatter, line or histogram charts.

This property is read-write.

See Also

XAxisPrecision

YAxisScaleResolution

Description

Use the YAxisScaleResolution property to control the level of detail displayed on a numeric axis. Use this property to increase or reduce the number of major ticks and labels on the Y axis.

This property is only applicable to scatter, line, or histogram charts.

The values are:

This property is read-write.

See Also

XAxisScaleResolution

Gantt Chart Methods

The methods in this section are only applicable when the chart has been specified as a Gantt chart.

SetActualEndDate

Syntax

SetActualEndDate(RecordName.FieldName)

Description

Use the SetActualEndDate method to specify the field in the record that defines the actual end date. This is an optional method, and is used in conjunction with the SetPlannedEndDate method. If an actual end date is specified, then an actual start date must also be specified. When defined, the actual or baseline tasks are visually shown as a separate task bar and are layered beneath the planned task if the two overlap.

Note. The Gantt chart logs a warning to the file PSJChart.log for any task that has a bad date format in this method or the SetActualStartDate method, but continues with its normal processing. For these tasks, the overlayed baseline information isn't displayed in the chart section.

Parameters

See Also

SetActualStartDate, SetPlannedEndDate, SetPlannedStartDate.

SetActualStartDate

Syntax

SetActualStartDate(RecordName.FieldName)

Description

Use the SetActualStartDate method to specify the field in the record that defines the actual start date. This is an optional method, and is used in conjunction with the SetPlannedStartDate method. If an actual start date is specified, then an actual end date must also be specified. When defined, the actual or baseline tasks are visually shown as a separate task bar and are layered beneath the planned task if the two overlap.

Note. The Gantt chart logs a warning to the file PSJChart.log for any task that has a bad date format in this method and the SetActualEndDate method, but continues with its normal processing. For these tasks, the overlayed baseline information is displayed in the chart section.

Parameters

See Also

SetActualEndDate, SetPlannedEndDate, SetPlannedStartDate.

SetActualTaskBarColor

Syntax

SetActualTaskBarColor(RecordName.FieldName)

Description

Use the SetActualTaskBarColor method to specify the field in the record that defines the colors for either the actual task bar or the actual milestone glyph.

Parameters

See Also

SetPlannedTaskBarColor, TaskMilestoneGlyph.

SetChartArea

Syntax

SetChartArea(Percentage)

Description

Use the SetChartArea method to specify what percentage of the Gantt chart is allocated to displaying the chart section. By default, both the task and chart sections are allocated 50% of the available space provided by the Gantt chart.

Parameters

SetPlannedEndDate

Syntax

SetPlannedEndDate(RecordName.FieldName)

Description

Use the SetPlannedEndDate method to specify the field in the record that defines the planned end date. If planned versus actual dates are not used, this method specifies the end date of the task.

This method is required when creating a Gantt chart.

Note. The Gantt chart logs an error to the file PSJChart.log and stops its normal processing if it finds a bad date format in any of the rows in the field associated with this method and the SetPlannedStartDate method.

Parameters

See Also

SetActualEndDate, SetActualStartDate, SetPlannedStartDate.

SetPlannedStartDate

Syntax

SetPlannedStartDate(RecordName.FieldName)

Description

Use the SetPlannedStartDate method to specify the field in the record that defines the planned start date. If planned versus actual dates are not used, this method specifies the start date of the task.

This method is required when creating a Gantt chart.

Note. The Gantt chart logs an error to the file PSJChart.log and stops its normal processing if it finds a bad date format in any of the rows in the field associated with this method and the SetPlannedEndDate method.

Parameters

See Also

SetActualEndDate, SetPlannedEndDate, SetPlannedStartDate.

SetPlannedTaskBarColor

Syntax

SetPlannedTaskBarColor(RecordName.FieldName)

Description

Use the SetPlannedTaskBarColor method to specify the field in the record that defines the colors for either the planned task bar or the planned milestone glyph.

Parameters

See Also

SetActualTaskBarColor, TaskMilestoneGlyph.

SetTableXScrollbar

Syntax

SetTableXScrollbar(Scroll_ArrowAmount)

Description

Use the SetTableXScrollbar method to specify the amount that the scroll bar in the table section of the Gantt chart scroll data when the user clicks on the arrows or scrollbar.

Parameters

SetTaskAppData

Syntax

SetTaskAppData(RecordName.FieldName1 [, RecordName.FieldName2 [,RecordName.FieldName3. . .]])

Description

Use the SetTaskAppData method to specify the fields in the record that define the application data to be viewed in the table section.

In the table section, column one (or the leftmost column) always displays the work breakdown structure (WBS) numbering (if given) and name of the task (or task ID if the name is not given). This method allows applications to define additional task data columns to be displayed in the rightmost columns of the table section.

Parameters

See Also

SetTaskAppDataTitles, SetTaskData, SetTaskDependencyData.

SetTaskAppDataTitles

Syntax

SetTaskAppDataTitles(&TitleArray)

Description

Use the SetTaskAppDataTitles method to specify the column titles to be displayed in the table section, starting with column two. The title for column one (that is, the leftmost column) in the table section is set using the SetTaskTitle method.

The length of the array should match the number of application data fields specified with the SetTaskAppData method. Additional strings beyond the number of application data fields are not displayed. If the number of strings in the array specified by this method is less than the number of application data fields, the blanks are displayed in these title columns.

Parameters

See Also

SetTaskAppData, TaskTitle.

SetTaskBarURL

Syntax

SetTaskBarURL(RecordName.FieldName)

Description

Use the SetTaskBarURL method to specify the field in the record which defines the URL the browser redirects to when the user clicks on a task bar.

By default, the FieldChange event on the planned end date field of the Gantt task data record is triggered if the image map based interactivity is turned on (using the IsDrillable property). This can be overriden by specifying a URL that is triggered when the task bar is clicked.

Use the SetTaskDependencyURL method to specify the URL to be used when the user clicks on a dependency line in the chart section.

Parameters

See Also

SetTaskDependencyURL

IsDrillable

SetTaskData

Syntax

SetTaskData({Record.RecordName | &Rowset})

Description

Use the SetTaskData method to specify from where the task data is to be populated, either from a record or an already instantiated rowset.

Note. If you specify a rowset, the data in the rowset must be provided in the correct display order.

This method is required when you're creating a Gantt chart.

Parameters

See Also

SetTaskDependencyData

SetTaskDependencyChildID

Syntax

SetTaskDependencyChildID(RecordName.FieldName)

Description

The dependent task is the task where the dependency arrow ends. Use the SetTaskDependencyChildID method to specify the field in the record that defines the task ID for the dependent task.

The ID must match up to an ID in the Task data set.

This method is required if you specify dependency data.

Parameters

See Also

SetTaskDependencyData, SetTaskDependencyURL, SetTaskDependencyParentID.

SetTaskDependencyData

Syntax

SetTaskDependencyData({RecordName | &Rowset})

Description

Use the SetTaskDependencyData method to specify either a record, or an already instantiated rowset, that contains the dependency data.

Note. If you specify a rowset, the data in the rowset must be provided in the correct display order.

Parameters

See Also

SetTaskData, SetTaskDependencyChildID, SetTaskDependencyURL, SetTaskDependencyParentID.

SetTaskDependencyURL

Syntax

SetTaskDependencyURL(RecordName.FieldName)

Description

Use the SetTaskDependencyURL method to specify the field in the record that defines the URL the browser redirects to when the user clicks on a task bar.

By default, the FieldChange event on the child ID field of the task dependency record is triggered if the image map based interactivity is turned on (using the IsDrillable property). This can be overriden by specifying a URL that is triggered when the task bar is clicked.

Use the SetTaskBarURL method to specify the URL to be used when the user clicks on a task bar in the chart section.

Parameters

See Also

SetTaskBarURL, SetTaskDependencyChildID, SetTaskDependencyData, SetTaskDependencyParentID.

SetTaskDependencyParentID

Syntax

SetTaskDependencyParentID(RecordName.FieldName)

Description

The depender task is the task where the dependency arrow originates. Use the SetTaskDependencyParentID method to specify the field in the record that defines the task ID for the depender task.

The ID must match up to an ID in the Task data set.

This method is required if you specify dependency data.

Parameters

See Also

SetTaskDependencyChildID, SetTaskDependencyData.

SetTaskExpanded

Syntax

SetTaskExpanded((RecordName.FieldName)

Description

Use the SetTaskExpanded method to specify the field in the record that defines the expanded state of parent tasks.

Whenever an end user changes the expanded state by clicking on the expand (collapse) icon in the table section, the expanded state in the rowset is updated. In addition, a field change event occurs to allow applications to synchronize expanded state changes with other parts of their application.

Parameters

SetTaskHints

Syntax

SetTaskHints(RecordName.FieldName)

Description

Use the SetTaskHints method to specify the field in the record which defines the task hint popup text. The description is displayed in a popup bubble when a cursor hovers over the task bar or milestone glyph.

Parameters

See Also

SetTaskID, SetTaskName.

SetTaskID

Syntax

SetTaskID(Recordname.FieldName)

Description

Use the SetTaskID method to specify the field that defines the unique task identifier. The task ID is used to support task linking and dependencies.

This method is required when you're creating a Gantt chart.

Parameters

See Also

SetTaskName

SetTaskLabel

Syntax

SetTaskLabel(RecordName.FieldName)

Description

Use the SetTaskLabel method to specify the field in the record that defines the task label. The label is displayed alongside its corresponding task bar in the chart area. If a task label is not provided, the task name is used instead. If a task name is not provided, the task id is used.

Parameters

See Also

SetTaskID, SetTaskName.

SetTaskLevel

Syntax

SetTaskLevel(RecordName.FieldName)

Description

Use the SetTaskLevel method to specify the field in the record that defines the level for the task. The outermost summary tasks are always defined as task level one. Tasks with task levels greater than one are subtasks. Subtasks may also contain other subtasks.

If a field is not provided to define the level, all tasks are defined at level 1. A maximum of 32 levels are supported.

The following table shows an example of the different levels that could be used, as well as what the parent task level is.

Note. The parent task is not actually part of the data.

Parameters

See Also

SetTaskID

SetTaskMilestone

Syntax

SetTaskMilestone(RecordName.FieldName)

Description

Use the SetTaskMilestone method to specify the field in the record that defines whether the task should be treated as a milestone.

The fields specified by the SetPlannedStartDate and SetActualStartDate methods are used for determining the dates for the planned and actual milestones. The other date fields in the rowset are ignored

Parameters

See Also

SetActualStartDate, SetTaskMilestone, SetPlannedStartDate.

SetTaskName

Syntax

SetTaskName(RecordName.FieldName)

Description

Use the SetTaskName method to specify the field in the record that defines the task name. If you don't specify a task name, the task ID is used in the table section of the Gantt chart.

Although this method is not required, PeopleSoft recommends using it to display meaningful information in the table section of the Gantt chart.

Parameters

See Also

SetTaskID

SetTaskProgress

Syntax

SetTaskProgress(RecordName.FieldName)

Description

Use the SetTaskProgress method to specify the field in the record that defines the length of the progress bar for this task as shown in the chart area of the Gantt chart.

The value in the field must be between 0 and 100, inclusive. Zero indicates no progress bar is shown, 100 indicates that the progress bar should cover the entire length of the task bar. Values greater than 100 are automatically converted to 100.

Parameters

See Also

SetTaskProgressBarColor

SetTaskProgressBarColor

Syntax

SetTaskProgressBarColor(RecordName.FieldName)

Description

Use the SetTaskProgressBarColor method to specify the field in the record that defines the color for the progress bar.

In order for the progress bar to be visible, its color must contrast with the task bar color. There are no borders drawn around the progress bar.

Parameters

See Also

SetActualTaskBarColor, SetTaskProgress.

SetWBSNumbering

Syntax

SetWBSNumbering(RecordName.FieldName)

Description

Use the SetWBSNumbering method to specify the field in the record that defines the work breakdown structure (WBS) numbering to be displayed for each task row in the table section of the Gantt chart.

A WBS is very similar in structure and layout to a document outline. Each item at a specific level of a WBS is numbered consecutively (that is, 10, 20, 30, 40, 50). Each item at the next level is numbered within the number of its parent item (that is, 10.1, 10.2, 10.3, 10.4). For example:

1.
   1.1
      1.1.1
      1.1.2
      1.1.3
   1.2
      1.2.1
      1.2.2
2.
. . .

If no field name is provided, WBS numbering is not displayed along with the tasks.

Regardless if WBS numbering is provided, child tasks are indented to the right of their parent task.

Parameters

Gantt Chart Properties

This section discusses Gantt chart properties. The properties are described in alphabetical order.

AxisEndDateTime

Description

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

This property is read-write.

AxisStartDateTime

Description

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

This property is read-write.

DataEndDateTime

Description

Use this property to specify where the chart should stop displaying data. The value must be of type DateTime.

This property is read-write.

DataStartDateTime

Description

Use this property to specify where the chart should start displaying data. The value must be of type DateTime.

This property is read-write.

PixelsPerRow

Description

This property returns an integer value of the row height (in pixels) for each row in the table section. Use this property to properly size the height of the table section of your Gantt chart so that all rows in the table are displayed. You can do so by multiplying the value for the PixelsPerRow property by the number of visible rows in the rowset.

The system calculates the value of the PixelsPerRow property at runtime after the Gantt image is rendered. To do so, this property must be read after the PeopleCode Activate event. This can be done by reading in the PixelPerRow value during a FieldChange event on a refresh button on the page.

This property is read-only.

ShowTaskLabels

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.

TaskDependencyLineType

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.

TaskMilestoneGlyph

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.

See Also

Using Gantt Glyphs

TaskTitle

Description

Use this property to specify the column title to be displayed in column one (that is, the leftmost 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.

See Also

SetTaskAppDataTitles

XAxisPosition

Description

Use this property to specify the position of the X axis relative to the Y axis.

Note. This property is not supported in Gantt charts.

You can use either a constant or a numeric value for this property. Valid values are:

This property is read-write.

YAxisPosition

Description

Use this property to specify the position of the Y axis relative to the X axis.

Note. This property is not supported in Gantt charts.

You can use either a constant or a numeric value for this property. Valid values are:

This property is read-write.

Gantt Chart DateTimeAxis Specific Methods

This section discusses the DateTimeAxis specific methods that can be used with Gantt charts. The methods are listed in hierarchical order.

See Also

Specifying DateTime Axis Formats

SetSecondFormat

Syntax

SetSecondFormat(Format)

Description

Use the SetSecondFormat method to specify how seconds display on a DateTime axis.

Locale-specific time separators are used to format the time.

Parameters

See Also

SetHourFormat, SetMinuteFormat.

SetMinuteFormat

Syntax

SetMinuteFormat(Format)

Description

Use the SetMinuteFormat method to specify how minutes are displayed on the DateTime axis.

Locale-specific time separators are used to format the time.

Parameters

See Also

SetHourFormat, SetSecondFormat.

SetHourFormat

Syntax

SetHourFormat(Format)

Description

Use the SetHourFormat method to specify how the hour displays on a DateTime axis.

Parameters

See Also

SetDayFormat, SetMinuteFormat, SetSecondFormat.

SetDayFormat

Syntax

SetDayFormat(Format)

Description

Use the SetDayFormat method to specify the format of the day on a DateTime axis.

Parameters

See Also

SetHourFormat, SetMinuteFormat, SetMonthFormat, SetSecondFormat.

SetMonthFormat

Syntax

SetMonthFormat(Format)

Description

Use the SetMonthFormat method to specify the format of months on a DateTime axis.

Parameters

See Also

SetDayFormat, SetYearFormat.

SetYearFormat

Syntax

SetYearFormat(Format)

Description

Use the SetYearFormat method to specify the format of years on the DateTime axis.

Parameters

See Also

SetDayFormat, SetMonthFormat.

Chart Examples

The following are some example charts, with the PeopleCode used to create them.

Creating a Chart

In the following example, the chart is created from a record with three fields, relating to sales, month, and product. The series in the chart are based on the product. The following is the complete code sample: the steps explain each line.

Global Chart &oChart; 
 
&oChart = GetChart(QE_CHART_DUMREC.QE_CHART_FIELD); 
 
&oChart.SetData(Record.QE_CHART_RECORD); 
&oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); 
&oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT); 
    
&oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION); 
 
&oChart.Type = %ChartType_2DStackedBar; 
    
&oChart.HasLegend = True; 
&oChart.LegendPosition = %ChartLegend_Right; 
 
&oChart.XAxisLabelOrient = %ChartText_Vertical;

The following is the chart produced by the previous code:

To create a chart:

1. Open PeopleSoft Application Designer.

2. Open the page where the chart is to be inserted.

3. Insert the chart control by either:

   • Clicking on the chart icon in the toolbar, or

   • Selecting Insert, Chart

4. Draw the chart control on the page.

5. Associate the chart control with a record field

   Every chart control must be associated with a record field. This is just the field for the chart control. It is not the field used for drilling down for data in the chart.

   Bring up the chart control properties by either

   • Double-clicking on the chart control, or

   • Right-clicking on the chart control and selecting Page Field Properties.

6. Select the record name and field for the chart.

   On the Record tab of the chart control properties, select the record and field for the chart.

   To make the control a page anchor, select the Enable as Page Anchor on the General tab.

7. Write your PeopleCode.

   In some event on the page, such as Activate, put the PeopleCode you need for populating the chart.

8. Get the chart.

   The first thing you must do is get the chart. You must use the record and field name that you associated with the chart control on the page.

   &oChart = GetChart(QE_CHART_DUMREC.QE_CHART_FIELD);

9. Set the data records.

   Set the data record. The SetData function associates the record data with the chart. Then use the SetDataYAxis and SetDataXAxis functions to associate specific fields in the record with the Y axis data and the X axis data.

   &oChart.SetData(Record.QE_CHART_RECORD); 
   &oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); 
   &oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT);

   This is all the code needed to create a chart. You don’t need to set the chart type: the default is a 2D bar chart. You don't need to set the series unless you want to group your data. Everything else is also optional.

10. (Optional) Set the data series.

    In this example, we want to set the region as the series. This means that the data will be grouped according to the region.

    &oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION);

11. (Optional) Set the chart type.

    Because we want a stacked bar for the chart, we must set the Type property of the chart. This means that each product (footballs, rackets, and so on) will have a single bar, and the data series (California, Oregon, and so on) will be what is 'stacked'.

    &oChart.Type = %ChartType_2DStackedBar;

12. (Optional) Set legend and label attributes.

    For this example, we want a legend, and want it to appear in the right side. In addition, because the text of the series labels is so large, they must be vertical to display all of them.

    &oChart.HasLegend = True; 
    &oChart.LegendPosition = %ChartLegend_Right; 
     
    &oChart.XAxisLabelOrient = %ChartText_Vertical;

Creating a Gantt Chart

The following is the complete code sample: the steps explain each line.

&oGantt = GetGanttChart(QE_CHART_DUMREC.QE_CHART_FIELD);

/*/ /////////
// Required
// ////////*/

/*/ Assign record which holds the task related data */
&oGantt.SetTaskData(Record.QE_GANTT_TASK);
&oGantt.SetTaskID(QE_GANTT_TASK.QE_ID);
&oGantt.SetPlannedStartDate(QE_GANTT_TASK.PLANNED_START_DATE);
&oGantt.SetPlannedEndDate(QE_GANTT_TASK.PLANNED_END_DATE);


/*// //////////////////
// General options //
// //////////////////*/

&oGantt.SetTableXScrollbar(0.20);
&oGantt.SetChartArea(QE_GANTT_PROJ.QE_CHART_PERCENT);
&oGantt.width = QE_GANTT_PROJ.QE_WIDTH;
&oGantt.height = QE_GANTT_PROJ.QE_HEIGHT; 
&oGantt.DataStartRow = QE_GANTT_PROJ.QE_START_ROW;
&oGantt.DataWidth = QE_GANTT_PROJ.QE_DATA_SIZE;
&oGantt.IsDrillable = QE_GANTT_PROJ.QE_DRILLABLE;
&oGantt.ShowTaskLabels = QE_GANTT_PROJ.QE_SHOWTASKLABELS;

&oGantt.GridLineType = QE_GANTT_PROJ.QE_GRIDLINE_TYPE;
If QE_GANTT_PROJ.QE_GRIDLINE_ENABLE = "Y" Then
   &oGantt.GridLines = %ChartGrid_Vertical;
Else
   &oGantt.GridLines = %ChartGrid_None;
End-If;



/*// ////////////////////////////////////////
// Optional fields specific to task data //
// //////////////////////////////////////// */

&oGantt.SetTaskName(QE_GANTT_TASK.QE_NAME);
&oGantt.SetTaskWBSNumbering(QE_GANTT_TASK.QE_WBS_ID);
&oGantt.SetTaskLevel(QE_GANTT_TASK.QE_LEVEL);
&Gantt.SetTaskLabel(QE_GANTT_TASK.QE_LABEL);
&Gantt.SetTaskProgress(QE_GANTT_TASK.QE_PROGRESS);
&Gantt.SetTaskHints(QE_GANTT_TASK.QE_HINTS);
&Gantt.SetTaskBarURL(QE_GANTT_TASK.QE_URL);
&oGantt.SetTaskMilestone(QE_GANTT_TASK. QE_MILESTONE);
&oGantt.TaskMilestoneGlyph = QE_GANTT_PROJ.QE_MILESTONE_GLYPH;
&oGantt.SetTaskExpanded(QE_GANTT_TASK.QE_EXPANDED);      

&Gantt.SetPlannedTaskBarColor(QE_GANTT_TASK.QE_PLANNED_TASK_COLOR);
&Gantt.SetActualTaskBarColor(QE_GANTT_TASK.QE_ACTUAL_TASK_COLOR);
&Gantt.SetTaskProgressColor(QE_GANTT_TASK.QE_PROGRESS_COLOR);


/*// /////////////////////////
// Specific to Table Area //
// /////////////////////////*/

&oGantt.SetTaskAppData(QE_GANTT_TASK.QE_PLANNED_START,
QE_GANTT_TASK.QE_PLANNED_END, 
QE_GANTT_TASK.QE_TASK_PROGRESS, 
QE_GANTT_TASK.QE_TASK_NAME, 
QE_GANTT_TASK.QE_EXPANDED);
   
 &oGantt.TaskTitle = "Tasks";
 &appDataArray = CreateArray("Start", "End", "Progress", "Name", "Expanded");
 &oGantt.SetTaskAppDataTitles(&appDataArray);



/*     //////////////////////////////////////////////
     // Optional fields for task dependency data //
     ////////////////////////////////////////////// */

/*// Assign record which holds the task dependency related data */
&oGantt.SetTaskDepenencyData(Record.QE_GANTT_TASKD);
&oGantt.SetTaskDependencyParentID(QE_GANTT_TASKD.QE_PARENT_TASK_ID);
&oGantt.SetTaskDependencyChildID(QE_GANTT_TASKD.QE_TASK_ID);
&oGantt.TaskDependencyLineType = QE_GANTT_PROJ.QE_LINETYPE_CHAR;
&oGantt.SetTaskDependencyURL(QE_GANTT_TASKD.URL);


/*// ///////////////////
// Enable baselines //
// /////////////////// */

&oGantt.SetActualStartDate(QE_GANTT_TASK.QE_ACTUAL_START);
&oGantt.SetActualEndDate(QE_GANTT_TASK.QE_ACTUAL_END);



/*////////////////////////////
// DateTime Axis specific //
////////////////////////////*/
&oGantt.AxisStartDateTime = DateTimeValue("07/15/2002 8:00:00");
&oGantt.AxisEndDateTime = DateTimeValue("09/15/2002 8:00:00");

&oGantt.SetMonthFormat(%Chart_MonthFormat_FullName);
&Gantt.SetDayFormat(%Chart_DayFormat_2Digit);

To create a Gantt chart:

1. Get a Gantt chart.

   Get the chart using the GetGanntChart function. The record and field name specified are associated with a chart definition in PeopleSoft Application Designer.

   Local Gantt &oGantt;
   
   &oGantt = GetGanttChart(QE_CHART_DUMREC.QE_CHART_FIELD);
   

2. Specify values for the required methods.

   There are several methods that are required for the Gantt chart, such as setting the task data, the start and end dates, and so on.

   &oGantt.SetTaskData(Record.QE_GANTT_TASK);
   &oGantt.SetTaskID(QE_GANTT_TASK.ID);
   &oGantt.SetPlannedStartDate(QE_GANTT_TASK.START_DATE);
   &oGantt.SetPlannedEndDate(QE_GANTT_TASK.END_DATE);
   

3. Specify values for the additional methods controlling the display of the data.

   After you've set the required methods, you can set additional methods to control the display of the chart. The following code specifies the amount that the scroll bars scroll when clicked, the percentage of the entire chart that is taken up by the chart area, the width and height of the chart, on what row the chart should begin displaying data, the width of the data, if the user can click on the chart area of the Gantt chart and either execute a function or a URL, and whether labels should display with the tasks in the task section.

   &oGantt.SetTableXScrollbar(0.20);
   &oGantt.SetChartArea(QE_GANTT_PROJ.QE_CHART_PERCENT);
   &oGantt.width = QE_GANTT_PROJ.QE_WIDTH;
   &oGantt.height = QE_GANTT_PROJ.QE_HEIGHT; 
   &oGantt.DataStartRow = QE_GANTT_PROJ.QE_START_ROW;
   &oGantt.DataWidth = QE_GANTT_PROJ.QE_DATA_SIZE;
   &oGantt.IsDrillable = QE_GANTT_PROJ.QE_DRILLABLE;
   &oGantt.ShowTaskLabels = QE_GANTT_PROJ.QE_SHOWTASKLABELS;
   

4. Specify how the grid lines are displayed.

   Depending on the type of data that you are using, you can specify the type of grid lines that should display in the chart section of the Gantt chart.

   &oGantt.GridLineType = QE_GANTT_PROJ.QE_GRIDLINE_TYPE;
   If QE_GANTT_PROJ.QE_GRIDLINE_ENABLE = "Y" Then
      &oGantt.GridLines = %ChartGrid_Vertical;
   Else
      &oGantt.GridLines = %ChartGrid_None;
   End-If;
   

5. Additionally specify how the data is to be displayed.

   The following methods control how the different parts of the task data displays, such as the label, what hints display when the mouse is passed over the task data, and so on.

   &oGantt.SetTaskName(QE_GANTT_TASK.QE_NAME);
   &oGantt.SetTaskWBSNumbering(QE_GANTT_TASK.QE_WBS_ID);
   &oGantt.SetTaskLevel(QE_GANTT_TASK.QE_LEVEL);
   &Gantt.SetTaskLabel(QE_GANTT_TASK.QE_LABEL);
   &Gantt.SetTaskProgress(QE_GANTT_TASK.QE_PROGRESS);
   &Gantt.SetTaskHints(QE_GANTT_TASK.QE_HINTS);
   &Gantt.SetTaskBarURL(QE_GANTT_TASK.QE_URL);
   &oGantt.SetTaskMilestone(QE_GANTT_TASK. QE_MILESTONE);
   &oGantt.TaskMilestoneGlyph = QE_GANTT_PROJ.QE_MILESTONE_GLYPH;
   &oGantt.SetTaskExpanded(QE_GANTT_TASK.QE_EXPANDED);      
   
   &Gantt.SetPlannedTaskBarColor(QE_GANTT_TASK.QE_PLANNED_TASK_COLOR);
   &Gantt.SetActualTaskBarColor(QE_GANTT_TASK.QE_ACTUAL_TASK_COLOR);
   &Gantt.SetTaskProgressColor(QE_GANTT_TASK.QE_PROGRESS_COLOR);
   
   

6. Specify the additional fields to be displayed in table section.

   You can specify application data to also be displayed with the task data.

   &oGantt.SetTaskAppData(QE_GANTT_TASK.QE_PLANNED_START,
   QE_GANTT_TASK.QE_PLANNED_END, 
   QE_GANTT_TASK.QE_TASK_PROGRESS, 
   QE_GANTT_TASK.QE_TASK_NAME, 
   QE_GANTT_TASK.QE_EXPANDED);
   

7. Specify titles for the task bars.

   You can specify different titles for the different task bars.

    &oGantt.TaskTitle = "Tasks";
    &appDataArray = CreateArray("Start", "End", "Progress", "Name", "Expanded");
    &oGantt.SetTaskAppDataTitles(&appDataArray);
   

8. Specify the fields for task dependency data.

   You do not need to specify dependency data. However, if you do, you must also specify the parent ID and the child ID (where the dependency data starts and ends.) You can also specify optional things, like the type of line used between the dependencies, as well as a URL that the browser will open to if the user clicks a dependency line.

   &oGantt.SetTaskDepenencyData(Record.QE_GANTT_TASKD);
   &oGantt.SetTaskDependencyParentID(QE_GANTT_TASKD.QE_PARENT_TASK_ID);
   &oGantt.SetTaskDependencyChildID(QE_GANTT_TASKD.QE_TASK_ID);
   &oGantt.TaskDependencyLineType = QE_GANTT_PROJ.QE_LINETYPE_CHAR;
   &oGantt.SetTaskDependencyURL(QE_GANTT_TASKD.URL);
   

9. Specify the actual dates for the project.

   If you know the actual start and end date, in addition to the planned date, you can add those to your chart as well.

   &oGantt.SetActualStartDate(QE_GANTT_TASK.QE_ACTUAL_START);
   &oGantt.SetActualEndDate(QE_GANTT_TASK.QE_ACTUAL_END);
   

10. Specify the DateTime axis values.

    You can specify values for where the DateTime axis starts and ends.

    &oGantt.AxisStartDateTime = DateTimeValue("07/15/2002 8:00:00");
    &oGantt.AxisEndDateTime = DateTimeValue("09/15/2002 8:00:00");
    

11. Specify the format of the DateTime axis values.

    You can specify the format of the DateTime elements, such as how the days of the week display, whether as a number or using the full name, and so on.

    &oGantt.SetMonthFormat(%Chart_MonthFormat_FullName);
    &Gantt.SetDayFormat(%Chart_DayFormat_2Digit);
    

Creating a Chart Using an iScript

You can also create a chart using an iScript. The following example creates a chart, populates it, then sends the chart URL to a response object. The following is the complete code sample: the steps explain each line.

Function IScript_GetChartURL() 
    
   Local Chart &oChart; 
   Local Rowset &oRowset; 
   Local string &sMap; 
   Local string &sURL; 
    
   &oChart = CreateObject("Chart"); 
    
   &oRowset = CreateRowset(Record.QE_CHART_RECORD); 
   &oRowset.Fill("where QE_CHART_REGION= :1", "MIDWEST"); 
   &oChart.SetData(&oRowset); 
    
   &oChart.Width = 400; 
   &oChart.Height = 300; 
    
   &oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); 
   &oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT); 
   &oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION); 
    
   &oChart.HasLegend = True; 
   &oChart.LegendPosition = %ChartLegend_Right; 
    
   &sURL = %Response.GetChartURL(&oChart); 
   &sMap = &oChart.ImageMap; 
    
   %Response.Write("<HTML><IMG SRC="); 
   %Response.Write(&sURL); 
   %Response.Write("  USEMAP=#THEMAP></IMG><MAP NAME=THEMAP>"); 
   %Response.Write(&sMap); 
   %Response.Write("</MAP></HTML>"); 
    
End-Function;

To create a chart using an iScript:

1. Create the chart object.

   For this example, there is no chart control on a page to be referenced. So to create the chart object, you must use the CreateObject function. The string passed in to the function must be the word 'chart'.

      &oChart = CreateObject("Chart");

2. Create a rowset for the chart data and set the chart data.

   The CreateRowset function creates a rowset data structure. Using the Fill method populates the empty rowset with data. The SetData method associates the rowset data with the chart.

      &oRowset = CreateRowset(Record.QE_CHART_RECORD); 
      &oRowset.Fill("where QE_CHART_REGION= :1", "MIDWEST"); 
      &oChart.SetData(&oRowset);

3. Set the height and width for the chart.

   Because the chart isn’t associated with a chart control on a page, you have to specify the size of the chart image to be generated using the Height and Width properties. The unit of measurement for both these properties is pixels.

      &oChart.Width = 400; 
      &oChart.Height = 300;

4. Set the data axes, series, and legend for the chart.

   As with all charts, you must set the data axes. If necessary for your data, also set the data series and the legend.

      &oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); 
      &oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT); 
      &oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION); 
       
      &oChart.HasLegend = True; 
      &oChart.LegendPosition = %ChartLegend_Right;

5. Generate the URL for the chart.

   Use the GetChartURL method of the Response class to generate the URL referencing the chart data.

      &sURL = %Response.GetChartURL(&oChart);

6. Generate the image map.

   Use the ImageMap property to generate the image map for the chart. The Response object uses this to draw the map.

      &sMap = &oChart.ImageMap;

7. Create the response chart.

   Use the Write Response class method to generate the chart. Note that first the data is set, using the URL generated with GetChartURL, then the image map is used.

      %Response.Write("<HTML><IMG SRC="); 
      %Response.Write(&sURL); 
      %Response.Write("  USEMAP=#THEMAP></IMG><MAP NAME=THEMAP>"); 
      %Response.Write(&sMap); 
      %Response.Write("</MAP></HTML>");

Note. If one or more labels does not render in the chart increase the width of the chart, use shorter label text, or reduce the data set being charted.