Charting Classes

This chapter provides an overview of the PeopleSoft charting classes and discusses:

• Creating PeopleSoft charts.

• Using the Chart class.

• Using the Gantt class.

• Using the OrgChart class.

• Using the RatingBoxChart class.

• Using the Charting Classes Reference.

• Charting classes built-in functions.

Understanding the Charting Classes

PeopleTools delivers four charting classes. One general charting class supports a range of standard chart types, and three specialized charting classes address specific charting needs. Each charting class is discussed in detail in following sections.

The charting classes are:

• Chart

  Use the Chart class to visually display data series in common formats, including bar charts, line charts, pie charts, and bubble charts.

• Gantt

  Use the Gantt class to create interactive Gantt charts that enable you to display and edit project and task information.

• OrgChart

  Use the OrgChart class to create interactive organization charts that enable you to visually represent a hierarchy of information as a series of connected nodes.

• RatingBoxChart

  Use the RatingBoxChart class to create rating box charts that enable you to display and manipulate points of information in two-dimensional bins.

The following examples show each of the four chart classes:

This chart was created from the Chart class with a chart type of 2D Bar:

This example shows a Gantt chart:

This example shows an organization chart:

This example shows a rating box chart:

See Also

Creating PeopleSoft Charts

Using the Chart Class

Using the Gantt Class

Using the OrgChart Class

Using the RatingBoxChart Class

Creating PeopleSoft Charts

This section discusses the process of creating charts using any of the PeopleSoft charting classes. Further details can be found in the specific section for each chart class.

These topics relate to all of the charting classes:

• Creating a chart on a page

• Creating a chart using an iScript

• Font considerations

• Component Processor considerations

• Translation considerations

• Label considerations

• Style sheets

• Using style sheets with RevertToPre850

• Using style sheets with PeopleTools Version 8.50 charts

• Chart colors

Creating a Chart on a Page

This section summarizes the basic steps to create a chart. The basic steps are essentially the same for all four charting classes.

At the end of this chapter are examples of charts with step-by-step instructions and complete PeopleCode programs.

The Chart class section has fundamental, detailed instructions for creating a chart using the Chart class. Each specialized class – Gantt class, OrgChart class, and RatingBoxChart class – has detailed instructions that build on the Chart class instructions.

See Creating a Chart Using the Chart Class, Using the Chart Class, Using the Gantt Class, Using the OrgChart Class, Using the RatingBoxChart Class.

Note. The following steps are for creating a chart on a PeopleSoft Pure Internet Architecture page. You can also create a chart for a web page using an iScript. Only Chart class charts or Gantt class charts can be created using an iScript.

See Creating a Chart Using an iScript.

To create a chart on a page:

1. In Application Designer, place a chart control on a page and associate the chart with a record field.

2. Create a record to hold your chart data.

   For charts made using the OrgChart class and the RatingBoxChart class, you also create a record that controls the appearance of the chart. Place each record on a level-1 grid on the page so the chart records are present in the component buffer at runtime. You can optionally hide the grid. You can also optionally place the grid on another page on the same component.

   Place the page on a component and register the component.

3. Add PeopleCode, probably on the page Activate event, to instantiate the chart object and associate it with the page control.

   For example, this is the minimum PeopleCode to create a bar chart using the Chart class.

   /* Declare a chart object */
   
   Component Chart &cChart;
   
   /* Instantiate the chart object and associate the chart
   ** with the chart page control */
   
   &cChart = GetChart(SC_CHART_DUMREC.QE_CHART_FIELD);
   
   /* Specify the chart data record and specify the record
   **  fields for the X-Axis data and Y-Axis data*/
   
   &cChart.SetData(Record.SC_CHART_RECORD);
   &cChart.SetDataXAxis(SC_CHART_RECORD.SC_PRODUCT);
   &cChart.SetDataYAxis(SC_CHART_RECORD.SC_SALES);
   

4. View the chart in the browser.

   Suppose you have this data in SC_CHART_RECORD:

   Region	Sales
   Arizona	62
   California	50
   Oregon	42
   Washington	30

   This is the bar chart generated by the example code and data. The default chart type for the Chart class is a bar chart. Since no colors are specified, the chart uses the default colors.

5. Add PeopleCode to control the behavior of the chart or to modify its appearance at runtime. For example, for a bar chart you might add FieldChange PeopleCode to the Y-axis field on your data record to display information when a user clicks a data point.

   See Adding Drilldown.

   You can also add FieldChange PeopleCode to a Gantt chart, organization chart, or rating box chart to enable the user to interact with the chart.

See Also

Creating a Chart Using the Chart Class

Using the Chart Class

Using the Gantt Class

Using the OrgChart Class

Using the RatingBoxChart Class

Creating a Chart Using an iScript

If possible, you should put a chart on a page definition. If not possible, then you can build a chart at runtime using an iScript and call the chart using a URL. Use the CreateObject function in the iScript instead of the GetChart function. You can then use the GetChartURL Response class method to use the URL in your application.

Note. You can create only Chart class and Gantt class charts using an iScript. OrgChart class and RatingBoxChart class charts cannot be created with an iScript.

For example, this PeopleCode would build 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

Font Considerations

For Chart class charts and Gantt class charts, 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. You can set this variable at the system level or in psconfig.sh.

The following 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 are not specified as such in PeopleSoft Application Designer. Work records are not updated by the database and are skipped when the component is run.

A level-zero record is marked as a work record when any of these conditions is true:

• The record is designated as a work record in Application Designer.

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

• All 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 to be a work record, it is also skipped when the system determines that record's 'work' status.

See Also

Referencing Data in the Component Buffer

Translation Considerations

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

Label Considerations

The appearance of Chart class chart labels is based on the size of the axis, fonts, and charts on the page. If all the labels for your chart do not appear, then 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.

Style Sheets

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

The following style sheet properties are supported for PeopleSoft charting:

• Font family

• Font foreground color

• Font size

• Font style (only Normal and Italic are supported)

• Font weight (only Normal and Bold are supported)

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

Using Style Sheets with RevertToPre850

How your chart uses style sheets is very different depending on whether you want your chart to use the PeopleTools Version 8.50 appearance or the pre-8.50 appearance.

The overall look of charts changed with the introduction of new style sheets and colors in PeopleTools Version 8.50. The way style sheets are applied to charts changed at the same time.

If you want your chart to use the pre-8.50 look, set the RevertToPre850 Chart class or Gantt class property to True. If the RevertToPre850 property is not set or is set to False, then your chart will use the PeopleTools Version 8.50 look. By default, the property is False.

Warning! By default, all charts use the new 8.50 chart style classes, including charts that were created before PeopleTools Version 8.50.

Any custom Chart class properties or Gantt class properties that were set in PeopleCode for existing charts that use the new 8.50 chart style classes will be ignored if those properties are defined in the 8.50 chart style classes.

A new property, RevertToPre850, enables you to maintain the pre-8.50 visual style of an existing chart. If you want an existing chart to use pre-8.50 style classes, you must set the chart property RevertToPre850 to True.

RevertToPre850 is not available for charts created using the OrgChart class or the RatingBox class. These chart classes were introduced in PeopleTools Version 8.50.

See RevertToPre850, PeopleTools Options.

PTSTYLEDEF Style Sheet

The default style sheet associated with a Chart class chart or Gantt class chart with RevertToPre850 set to True is PTSTYLEDEF.

The chart style classes associated with the PTSTYLEDEF style sheet include:

RevertToPre850 Override Rules

The application style sheet, which is specified on the PeopleTools Options page, controls the formatting of all charts in an application unless it is overridden.

The override rules are:

1. If you specify the style property for any element (XAxisStyle, XAxisTitleStyle, YAxisStyle, YAxisTitleStyle, LegendStyle, MainTitleStyle, and so on), then the style is used.

2. If you do not specify the style property for any element of a chart object but you specify the StyleSheet property for the chart object itself, then that style sheet is used for the unspecified elements.

3. If you do not specify styles for any elements of a chart object and you do not specify a style sheet for the chart object itself, then a default style sheet is used.

Note. Oracle recommends not using your own style classes or style sheets unless absolutely necessary. If you modify styles you must test changes in all supported browsers. Some changes can have different effects in different browsers.

See Also

Using Style Sheets with Gantt Charts

Creating Style Sheet Definitions

Considerations for Gantt Charts

Using Style Sheets with PeopleTools Version 8.50 Charts

This section describes how to use style sheets if you have not set the RevertToPre850 property or have set the property to False.

The application style sheet, which is specified on the PeopleTools Options page, controls the formatting of all charts in an application unless it is overridden.

The override rules are:

1. If a style sheet is specified for the Chart object or Gantt object using the StyleSheet property, then use this style sheet. (The StyleSheet property only applies to Chart class and Gantt class charts. OrgChart class and RatingBoxChart class charts do not use the StyleSheet property.)

2. If no style sheet is specified for the chart object but the style sheet is specified for the page in Application Designer, then use the style sheet on the page as the style sheet of the chart.

3. If no page style sheet is specified, then use the style sheet specified on the PeopleTools Options page.

4. If no style sheet is specified on the PeopleTools Options page, use the default style sheet, PTSTYLEDEF.

Modifying Style Classes

You modify the appearance of a chart by modifying the style classes that control the appearance. The steps you follow to modify styles depends on the extent of your modification. You can, for instance, modify every style in every chart in your application, or you can modify just one style for a single chart.

The following table summarizes the changes to style sheets and style classes depending on the extent of the modification you intend to make.

Note. Do not change the delivered style sheets. Oracle recommends that you use the default styles wherever possible.

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

See Creating Style Sheet Definitions, PeopleTools Options.

PSCHARTSTYLE

The style classes in PSCHARTSTYLE are used by the Chart class and the Gantt class.

Chart Colors

The following table lists all the colors that are defined in the PSCHARTSTYLE style sheet.

You assign colors to your chart using the Chart class and Gantt class color methods. You can use either the numeric or constant value.

Charts that have RevertToPre850 set to True use solid colors. Beginning with 8.50, charts use gradients.

See SetColorArray, SetDataColor.

See SetActualTaskBarColor, SetPlannedTaskBarColor.

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 with a normal weight, and it 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 into another column.

OrgChart Class and RatingBoxChart Class Style Sheets

OrgChart class and RatingBoxChart class chart appearance attributes are controlled entirely using style classes.

To modify a style class you can either create a new style sheet or set style properties to new style classes.

To create a new style sheet:

1. Clone the style sheet.

   For example, in Application Designer, open the PSORGCHART style sheet and save as MYORGCHART.

2. Double-click a style class name and modify the values in the Class properties dialog.

3. Assign the new style sheet to the page on which the chart is placed.

   In Application Designer, open the page and select File, Definition Properties.

   On the Use tab, in the Page Style Sheet field, select the new style sheet.

To set style properties to new style classes:

1. Copy and paste to create a new style class within the style sheet that is associated with the chart.

   For example, copy and paste the PT_ORGCHART_TITLE style class and name it MY_ORGCHART_TITLE.

2. Modify the new style class.

3. Set the style property of the chart class to the new style class.

   For example:

   &ocMyOrgChart.MainTitleStyle = MY_ORGCHART_TITLE;

The PSORGCHART style sheet controls the appearance of organization charts.

The PSRATEBOX style sheet controls the appearance of rating box charts.

Using the Chart Class

Use the Chart class to create charts that display data series in several common formats, including bar charts, line charts, pie charts, and bubble charts.

This section discusses:

• Chart terms.

• Creating charts using the Chart class.

• Chart class chart types.

• Data type of a Chart object.

• Scope of a Chart object.

• Error handling.

• Chart class methods and properties by category.

Chart Terms

The following is a list of Chart class terms and their descriptions:

Creating Charts Using the Chart Class

You can specify a rowset and have it graphed using a chart object with minimal PeopleCode. Within this rowset, one column must contain data for the X axis and another column must contain data for the Y axis. If more than one series of data is used, an additional column is required for each series. You can also set color and pop-up text for each point in this rowset using additional columns.

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

• Primary data.

• Secondary or overlay data.

Overlay data may be quite different from primary data, so an additional rowset is needed.

The only object used with the Chart class is a chart object. Sub-objects do not exist. All methods and properties are used with the Chart object.

For a conceptual overview, a chart is easier to view in pieces; however, these pieces do not represent sub-objects.

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.

Chart Class Chart Types

The following chart types are available for the Chart class:

• 2D Bar

• 3D Bar

• 2D Histogram

• 2D Percent Bar

• 3D Percent Bar

• 2D Stacked Bar

• 3D Stacked Bar

• 2D Horizontal Bar

• 2D Horizontal Percent Bar

• 2D Horizontal Stacked Bar

• 2D Line

• 2D Scatter

• 2D Pie

• 3D Pie

See Also

Creating a Chart Using the Chart Class

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 notification, a Component Interface, and so on.

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.

Chart Class Methods and Properties by Category

The following topics subdivide the Chart class methods and properties by functional category.

The categories are divided among the different parts of a chart. However, all methods and properties are used with the chart object; a chart has no sub-objects.

Chart Data Methods and Properties

Use chart data methods and properties to set X and Y axes data.

See Reset, SetData, SetDataHints, SetDataSeries, SetDataURLs, SetDataXAxis, SetDataYAxis, DataStartRow, DataWidth, ImageMap, IsTrueXY.

Chart Appearance Properties

Use chart appearance properties to set the type of graph, the line style, and so on.

See GridLines, GridLineType, Height, IsDrillable, IsPlainImage, LineType, RevertToPre850, Style, StyleSheet, Type, Width, XRotationAngle, YRotationAngle, ZRotationAngle.

Note. A new property, RevertToPre850, enables you to maintain the pre-8.50 visual style of an existing chart. If you want an existing chart to use pre-8.50 style classes, you must set the chart property RevertToPre850 to True.

See Using Style Sheets with RevertToPre850.

Chart Color Methods

Use chart color methods to set and manipulate colors for either a series or for each point.

See SetColorArray, SetDataColor.

Note. A new property, RevertToPre850, enables you to maintain the pre-8.50 visual style of an existing chart. If you want an existing chart to use pre-8.50 style classes, you must set the chart property RevertToPre850 to True.

See Using Style Sheets with RevertToPre850.

Chart Axis Methods and Properties

Use chart axis methods and properties to further control the appearance of axes.

See SetXAxisLabels, SetYAxisLabels, XAxisCross, XAxisLabelOrient, XAxisStyle, XAxisTicks, YAxisLabelOrient, YAxisMax, YAxisMin, YAxisStyle, YAxisTicks.

Chart Title Properties

Use chart title properties to set the text and style of titles for the graph and the axes.

See MainTitle, MainTitleOrient, MainTitleStyle, XAxisTitle, XAxisTitleOrient, XAxisTitleStyle, YAxisTitle, YAxisTitleOrient, YAxisTitleStyle.

Chart Legend Methods and Properties

Use chart legend methods and properties for each series legend.

See SetLegend, HasLegend, LegendMaxEntries, LegendPosition, LegendStyle.

Chart Overlay Methods and Properties

Use chart overlay methods and properties to set and manipulate overlay data.

See SetOLData, SetOLDataSeries, SetOLDataXAxis, SetOLDataYAxis, OLLineType, OLType.

Scatter Chart Methods and Properties

Use scatter chart methods and properties to set and manipulate scatter charts and bubble charts.

See SetDataAnnotations, SetDataGlyphScale, SetOLDataAnnotations, SetOLDataGlyphScale, ShowCrossHair.

TrueXY Line Chart Properties

Use trueXY line chart properties to set and manipulate trueXY line charts.

See XAxisCrossPoint, XAxisMax, XAxisMin, XAxisPrecision, XAxisScaleResolution, YAxisCrossPoint, YAxisMax, YAxisMin, YAxisPrecision, YAxisScaleResolution.

Using the Gantt Class

Use the Gantt class to create Gantt charts. A Gantt chart displays tasks along a time line. Gantt charts are frequently used in project management because they provide a graphical illustration of a schedule, which helps in planning, coordinating, and tracking project tasks.

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 formats.

• Work with start and end dates.

• Use Gantt glyphs.

• Use style sheets with Gantt charts.

Understanding Gantt Chart Terms

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

Using Gantt Charts in PeopleSoft Pure Internet Architecture

The Gantt chart consists of two sections: a table section and a 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.

Horizontal scrollbars below the table section support scrolling through the task-related columns; below the task section, they support scrolling through the task bars.

The amount that a 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 percent of the section area if a value is not set).

See SetTableXScrollbar.

Vertical scrollbars support scrolling through the task hierarchy.

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 subtask hierarchy. 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.

Chart Section

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

In the previous example, 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 above the task bar. The milestone date (Graduate in the previous example) is represented with a circle.

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

You can execute custom FieldChange PeopleCode when a user clicks a task bar or a task dependency line.

X-Axis Range

Click the X-Axis Range link on the Gantt toolbar to change the Begin and End dates for the X axis.

User Interaction

A user can interact directly with a chart to change the underlying chart data.

These user actions are supported:

• Resize the task bar.

• Reposition the task bar.

• Reposition a milestone glyph.

• Move the separator between the table section and the chart section.

• Update task details, task start time and end time, and the progress bar.

When a user changes values in the chart section by dragging and dropping bars, the Planned Start, Planned End, and Progress values in the grid column will also be updated if the grid and the chart section use the same record and fields.

You can control the level the user is able to interact with the chart using the Gantt class properties InteractiveStart, InteractiveEnd, InteractiveProgress, and InteractiveMove.

See InteractiveStart, InteractiveEnd, InteractiveProgress, InteractiveMove.

Creating Gantt Charts Using the Gantt Class

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 tasks.

The following methods are required 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, Oracle recommends 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, Oracle 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, then 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; and then hours, at the third level, and so on. Generally, the smallest unit should be on the lowest level. Therefore, if months and years appear, then months appear at the first level and years appear at the second level.

In the following example, days, months, and years are defined at levels 1, 2, and 3, respectively. Therefore, the days of the month (1, 10, 20) appear closest to the chart area, the months appear below them, and the years appear 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.

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 will 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 appears in the table section of the Gantt chart, but no bar appears in the chart section of the Gantt chart, even if one of the dates falls inside the axis dates.

Using Gantt Glyphs

You can use all of the following glyphs with a Gantt chart. You can use either the numeric or constant value.

Using Style Sheets with 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 into another column.

Data Type of a Gantt Object

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

Local Gantt &MyGantt;

Scope of a Gantt Object

A Gantt 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 notification, a Component Interface, and so on.

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.

Using the OrgChart Class

Use the OrgChart class to create organization charts. An organization chart represents hierarchical data as boxes arrayed in levels, which can be oriented top to bottom, with horizontal rows, or left to right, with vertical rows. Connectors show parent and child relationships between boxes on adjacent levels.

You can use this chart type to display many different types of hierarchical relationships, including, but not limited to:

• People in organizations

• Positions in organizations

• Departments in organizations

• Components in bills of materials

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

• Use organization charts in PeopleSoft Pure Internet Architecture.

• Create organization charts.

• Organization chart actions and events.

• Organization chart subrecord definitions.

• Minimum methods.

Understanding Organization Chart Terms

Organization charts can be composed of many different elements, such as the main chart, nodes, connectors, pop-up nodes, and so on. These terms apply specifically to organization charts:

Using Organization Charts in PeopleSoft Pure Internet Architecture

A PeopleSoft organization chart consists of two parts: the main hierarchical chart and pop-ups that enable the user to access additional related data for each node.

An organization chart can be oriented vertically or horizontally.

The following example shows a vertical organization chart:

The following example shows a horizontally oriented organization chart with a pop-up:

The underlying chart is the main organization chart. The chart overlaying the nodes on the right is a pop-up chart.

Main Chart

The main chart can have multiple levels. Each level consists of one or more nodes. Each node represents an individual entity, such as an employee, in the organization. A node has one parent node (except the top-level node, which does not have a parent node) and zero, one, or more child nodes. Each node in the main chart has up to seven descriptors and each descriptor can be configured as a link or as a button associated with a drop-down list box. Application developers can associate FieldChange PeopleCode with each descriptor link or button associated with a linkable drop-down list box.

Internet Explorer 8 Considerations

In Microsoft Internet Explorer 8, organization charts may not display correctly when the browser Document mode is set to Standards mode. Only the Quirks mode is supported for PeopleSoft charts.

See See the TroubleShooting Browser Limitations document on Oracle's MyOracleSupport website.

Pop-up

A pop-up displays a pop-up node with information specifically related to the node from which it was invoked. A connector line visually links the pop-up chart to the predecessor node, the node in the chart from which the pop-up was invoked.

If the pop-up contains more nodes than can be displayed (that is, if MaxPopupDisplayNode is set to a number that is less than the total number of nodes) then a scroll bar appears in the pop-up. In some circumstances when a pop-up has a scroll bar and has more than one level, when a user clicks a link on a level other than the top level the new pop-up may not appear in the display area. If this occurs, the user can scroll down using the scroll bar in the initial pop-up to view the new pop-up node.

Note. The amount of time it takes for a pop-up to appear is proportional to the number of nodes in the pop-up. A pop-up with hundreds of nodes may take a long time to appear. An hourglass appears to let the use know the system is working to retrieve the nodes.

A pop-up is invoked through PeopleCode associated with the FieldChange event for a descriptor link on a main chart node or another pop-up node.

A pop-up consists of a header and one or more nodes with each node having up to eight descriptors. Each descriptor can be configured as a link.

The user can drag-and-drop a pop-up node to reposition it but the new position will not be retained after any action that requires a server trip that reloads the chart.

Creating Organization Charts Using the OrgChart Class

You can populate the organization node information using rowsets linked to existing record data, or you can populate the rowset from PeopleSoft trees using the Tree class APIs.

When you add an organization chart to a page in PeopleSoft Application Designer, you use the chart properties to associate the chart control with a chart record field. You will use this field name to identify the chart in PeopleCode.

You will need to create two records that will be the organization chart node records. The org node record holds the values for the properties and data for each of the nodes of the main chart. The pop-up node record holds the values for the properties and data for each of the pop-up nodes.

The organization chart node records must be in the component buffer at runtime. This means that you will have to place them on a page at level one in the component. You can hide them.

The maximum number of nodes you can create is limited according to browser, as shown in the following table:

The records can have any name, but they must include clones of the PeopleTools-delivered subrecords PTORGNODE_SBR and PTORGPOPUPNODE_SBR. Since the subrecords will carry the FieldChange PeopleCode for the chart, in most cases you should create unique subrecords for each chart.

Your PeopleCode will create and populate two rowsets . These must be component rowsets, linked to the node records of the chart, not standalone rowsets. The org node rowset has one row for each node in the organization chart, and the pop-up node rowset has one row for each pop-up node.

You place FieldChange PeopleCode on the fields of the node records to invoke pop-up charts, update displayed data, process application logic, and refresh the chart.

Using Images with Organization Charts

If your organization chart uses images, such as photographs, then the scroll area or grid with the fields that contain the images must have unlimited occurs count enabled. That is, the Unlimited Occurs Count check box must be selected on any scroll area or grid that includes a record with the fields from PTORGNODE_SBR or PTORGPOPUPNODE_SBR, but only when images are used.

Using Breadcrumbs with Organization Charts

You can configure an organization chart to display breadcrumbs. Typically, breadcrumbs display the names of people in an organization hierarchy. The following example shows an organization chart with breadcrumbs:

An organization chart can have only one set of breadcrumbs. The breadcrumbs appear horizontally at the top of an organization chart, above the chart legend if the legend is set. The breadcrumbs string wraps automatically if it is wider than the organization chart. If a breadcrumb contains a space, the breadcrumb string may wrap at the space, causing the breadcrumb to appear on two lines.

Style classes control the formatting of breadcrumbs. The default style classes are PT_ORGCHART_BRDCRM and PT_ORGCHART_UNLINK_BRDCRM. You can specify your own style classes using the CrumbDescrStyle and UnlinkCrumbDescrStyle properties.

You can specify an image to separate breadcrumb entries. If an image is not specified, the breadcrumbs are separated by three spaces. Each breadcrumb entry can be configured to be linkable. This configuration is similar to linkable text on organization chart nodes.

To implement breadcrumbs in an organization chart, you:

• Clone the breadcrumb subrecord PTORGCRMB_SBR.

• Add the clone of PTORGCRMB_SBR to a work record.

• Add the work record to a page such that it is available in the component buffer so that PeopleCode can be invoked from the record fields.

  One way to accomplish this is to include the record in a level 1 grid on the same page as the organization chart, and hide the grid.

• To make a breadcrumb linkable, set the corresponding PTORGCRMBLINKABLE field to “Y”, in much the same way as you make a descriptor linkable in an organization chart node.

• Add PeopleCode to provide application-specific processing when a linkable breadcrumb is selected.

  When a user clicks a linkable breadcrumb, any FieldEdit and FieldChange PeopleCode in the PTORGCRMBID field executes.

At runtime, your PeopleCode will add rows to the work record that holds the information for each breadcrumb (person).

Each breadcrumb in a chart is defined by a row in the record.

See Organization Chart Subrecord Definitions, CrumbDescrStyle.

Breadcrumb Methods and Properties

The following OrgChart class methods and properties control the appearance of breadcrumbs:

• SetCrumbData

• SetCrumbRecord

• UnlinkCrumbDescrStyle

• CrumbDescrStyle

• CrumbMaxDisplayLength

• CrumbSeparatorImage

Using Drop-Down List Boxes

You can configure an organization chart to include buttons associated with drop-down list boxes for any of the node descriptors, enabling you to present related tasks for a node.

A drop-down list box can be linkable or read-only. If the drop-down list box is linkable, field change PeopleCode associated with the descriptor field, PTNODE_DESCRn, executes when a user clicks on a list item. If the drop-down list box is read-only, field change PeopleCode does not execute.

The width of a drop-down list box is the width of the widest list item that the box contains.

The height of the list item box is defined dynamically. An up-and-down arrow vertical scroll appears when the number of list items is greater than the value specified for the MaxDropdownDisplayItem property. The default value is 7.

A scroll appears if the list extends beyond the visible chart area.

To implement drop-down list boxes:

• Include the subrecord PTORGBOXFLD_SBR at the end of the chart node record.

• Set the PTNDDESCnLINKABLE field to “D” for the descriptor that is to have the linkable drop-down list box. Set the field to “R” is the field is to be read-only.

• Populate the PTDESCRn_DROPDOWN field value in the updated rowset to provide the dropdown box ID for the descriptor that has the PTNDDESCnLINKABLE field set to “D” or “R”.

• Create a derived/work record that contains the subrecord PTORGBOXLIST_SBR, and populate the corresponding rowset with the list information for each of the dropdown box IDs.

• Place FieldChange PeopleCode on the PTNODE_DESCRn field to perform corresponding logic when a list item is selected in the linkable drop-down list box.

Use the DropDownBoxStyle property to specify the style to specify the button position in the node.

Specifying Scroll Type

If an organization chart is larger than the viewable area, the user needs to scroll to view other areas of the chart. You can specify whether the organization chart will use scroll bars or alternative scrolling.

If you specify alternative scrolling, a scroll navigator and a hand cursor appear instead of vertical and horizontal scroll bars.

The arrows on the scroll navigator enable the user to quickly position the right, left, top, or bottom of the chart in the viewable area.

If the user scrolls the chart, the center button of the scroll navigator returns the chart to its initial display position. If the user changes focus by selecting a different node, the chart centers on that node. The center button then returns the chart to display centered on the focus node.

Note. If the breadcrumbs and chart legend are so large that there is not sufficient room to display the scroll navigator in the upper left portion of the chart, it will appear in the lower left corner.

The hand cursor enables the user to grab the background of the chart and move it within the viewable area.

Note. When using the hand cursor to scroll, you must position the hand cursor in the chart area outside the chart nodes and popup nodes. Scrolling does not work if the hand cursor is positioned within a chart node or pop-up node.

Use the ChartScrollType property to specify which type of scrolling to use. The default is scroll bars.

Organization Chart Actions and Events

An organization chart can execute FieldEdit or FieldChange PeopleCode in response to these user actions:

• Select an expand/collapse icon.

• Select a descriptor link or linkable drop-down list item.

• Close a pop-up node.

• Select a breadcrumb.

• Click on a node image.

• Click on a node.

Selecting Expand/Collapse Icons

When the user clicks an expand/collapse icon, the system toggles the EXPANDED_FLAG field value from “Y” to “N” or from “N” to “Y” and changes the icon on the node to collapsed or expanded, correspondingly. This action triggers field change processing (FieldEdit and FieldChange events) on EXPANDED_FLAG. Typically, FieldChange PeopleCode checks the EXPANDED_FLAG and PARENT_FLAG of the node and performs these actions:

• If EXPANDED_FLAG="Y" and PARENT_FLAG="X", loads the child rows into the rowset and sets PARENT_FLAG="Y". The updates appear when the chart is refreshed.

• If EXPAND_FLAG="N" (collapse action), it does nothing.

• If EXPAND_FLAG="Y" (expand action) and PARENT_FLAG="Y" (child data is already in rowset), it does nothing.

Note. If your PeopleCode doesn’t populate the CollapsedImage and ExpandedImage properties of the organization chart, then no expand/collapse icon appears on any nodes in the chart, and the expand/collapse action is disabled for the chart.

Selecting a Descriptor Link or Linkable Drop-Down List Item

When the user clicks a descriptor link or linkable drop-down list item, field change processing is triggered on the PTNODE_DESCRn field in the node record.

For instance, suppose descriptor 2 is linked to a pop-up chart. When the user clicks the descriptor 2 link, FieldChange PeopleCode on the PTNODE_DESCR2 field in the node record performs the following actions:

1. Sets the node’sPTPOPUPEXPAND_FLAG ="Y".

2. Sets the node’s PTPOPUPHDRMAINDESC.

3. Sets the node’s PTPOPUPHDRMAINICON.

4. If the node’s PTHASPOPUP_FLAG ="X", then populates the pop-up node rowset and sets PTHASPOPUP_FLAG ="Y" to indicate that the node’s descriptor was clicked for the first time.

5. Refresh the chart with the pop-up displayed.

Closing a Pop-up Node

When the user closes a pop-up node it triggers field change processing on the PTPOPUPEXPAND_FLAG field.

FieldChange PeopleCode on the PTPOPUPEXPAND_FLAG field would need to restore any changes that were made to the originating node's display characteristics and reset the node’s PTPOPUPEXPAND_FLAG ="N" .

Selecting a Breadcrumb

When a user clicks on a linkable breadcrumb, any FieldEdit and FieldChange PeopleCode in the PTORGCRMBID field executes. Typically PeopleCode is used to redraw the organization giving focus to the node that was clicked.

Clicking on a Photograph

When a user clicks on a node image, field change PeopleCode on the PTNDMAINICON_IMAGE field executes.

Clicking on a Node

When a user clicks on the body of a node -- not on a link, linkable drop-down list, or image -- field change PeopleCode on the PTCHART_NODE field executes.

Organization Chart Subrecord Definitions

This table describes the fields in PTORGNODE_SBR:

This table describes the fields in PTORGPOPUP_SBR.

This table describes the fields in PTORGBOXFLD_SBR:

This table describes the fields in PTORGBOXLIST_SBR:

This table describes the fields in PTORGCRMB_SBR:

Minimum Methods

At a minimum, these methods are needed to create an organization chart:

• SetNodeData

• SetNodeRecord

These methods are required if your organization chart uses pop-ups:

• SetPopUpNodeData

• SetPopUpNodeRecord

These methods are required if your organization chart uses breadcrumbs:

• SetCrumbData

• SetCrumbRecord

These methods are required if your organization chart uses drop-down list boxes:

• SetDropdownData

• SetDropdownRecord

Data Type of an OrgChart Object

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

Local OrgChart &MyOrgChart;

Scope of an OrgChart 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 notification, a Component Interface, and so on.

Using the RatingBoxChart Class

A rating box chart is an interactive chart that displays nodes on a two-dimensional grid. A user can move the nodes from one box to another on the grid. When the user moves a node the underlying data updates automatically.

The rating box chart in this example displays ratings on the dimensions of potential and performance:

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

• Use rating box charts in PeopleSoft Pure Internet Architecture.

• Create rating box charts using the RatingBoxChart class.

• Rating box chart subrecords.

• Minimum methods.

• Minimum properties.

Understanding Rating Box Chart Terms

The following is a list of terms that apply specifically to rating box charts.

Using Rating Box Charts in PeopleSoft Pure Internet Architecture

A rating box chart displays nodes on a chart that is divided into two or more boxes arrayed in a grid.

An application can correlate nodes, represented by icons, with various entities, such as employees, customers, or products, and various attribute pairs, such as potential/performance, cost/benefit, or opportunity/risk.

A user interacts with the rating box by dragging nodes to different boxes. When a node is moved, its underlying X (horizontal) and Y (vertical) values are updated. A user can also interact with the rating box by changing the node X/Y values in the grid that contains the rating box values if the application makes the grid visible and editable.

If a box contains more nodes than the number set in the RatingBoxChart property BoxMaxDisplayItems, the user can click a link at the bottom of the box to launch a pop-up that contains all the nodes. The box border changes color to indicate that the box has a pop-up open. A vertical scrollbar enables the user to scroll through all the nodes in the list.

The View all pop-up automatically closes if the user moves a node to another quadrant.

Using PeopleCode, you can associate each node with an image, or icon, and a description. You can configure a rating box to display nodes with icons and descriptions or with only icons.

See Also

BoxMaxDisplayItems

Creating Rating Box Charts Using the RatingBoxChart Class

When you add a rating box chart to a page in PeopleSoft Application Designer, you use the chart properties to associate the chart control with a record field. You will use this field name to identify the chart in PeopleCode.

You will need to create a record that will be the rating box chart node record. The record can be a standard database record or a derived/work record. The node record holds the values for the properties and data for each of the rating box chart nodes.

The record can have any name, but it must include a clone of the PeopleTools-delivered subrecord PTRATINGBOX_SBR. Since the subrecord will carry the FieldChange PeopleCode for the chart, in most cases you should create a unique subrecord for each chart. The node record must be placed on a page at level one on the component so that its PeopleCode will be loaded into the component buffer. It can be hidden.

In your chart PeopleCode, typically in the Activate event, you will create and populate a rowset linked to the chart’s node record. This must be a component rowset, linked to the chart’s node record, not a standalone rowset. The rowset has one row for each node in the chart.

Actions and Events

When user drags the node from one box to another, PeopleSoft Charting updates the values for the node’s PTXAXISRATINGS and PTYAXISRATINGS values, changing the box’s X and Y values to the new values. This change invokes field change processing on the PTXAXISRATINGS and PTYAXISRATINGS fields on the rating box node record. Typically, FieldChange PeopleCode performs business logic and refreshes the chart display.

Text Orientation

The orientation of the main title in a rating box chart is always horizontal.

The orientation of the X-axis title and X-axis labels is always horizontal.

The orientation of the Y-axis title and Y-axis labels is always vertical.

Rating Box Chart Subrecord Definition

These are the fields in PTRATINGBOX_SBR:

Minimum Methods

At a minimum these methods are needed to create a rating box chart.

• SetRBNodeData

• SetRBNodeRecord

• SetXAxisLabels

• SetYAxisLabels

Minimum Properties

At a minimum, these properties are needed to create a rating box chart.

• XAxisBoxNum

• YAxisBoxNum

These properties are required if the chart includes a view all pop-up:

• PopUpWidth

• PopUpHeight

Data Type of a RatingBoxChart Object

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

Local RatingBoxChart &RatingBoxChart;

Scope of a RatingBoxChart 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 notification, a Component Interface, and so on.

Charting Classes Reference

The Charting Classes Reference contains these topics:

• Charting Classes Built-in Functions.

• Chart Class Methods.

• Chart Class Properties.

• Gantt Class Methods.

• Gantt Class Properties.

• OrgChart Class Methods.

• OrgChart Class Properties.

• RatingBoxChart Class Methods.

• RatingBoxChart Class Properties.

• Creating a Bar Chart Using the Chart Class.

• Creating a Gantt Chart.

• Creating an Organization Chart.

• Creating a Rating Box Chart.

• Creating a Chart Using an iScript.

Charting Classes Built-in Functions

CreateObject

GetChart

GetChartURL

GetGanttChart

GetOrgChart

GetRatingBoxChart

Chart Class Methods

These methods are used by the Chart class. The methods are listed in alphabetical order.

Refresh

Syntax

Refresh()

Description

Note. This method has been deprecated and remains for backward compatibility only. Use the SetData method or SetOLData method instead.

If you make a change to the underlying data of a chart, call the SetData method again to update the chart.

You don’t need to refresh 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 chart is automatically refreshed.

Parameters

None.

Returns

None.

Example

&MyChart.Refresh();

See Also

SetData, SetOLData.

Reset

Syntax

Reset()

Description

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

Parameters

None.

Returns

None.

See Also

Chart class: Refresh method.

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

Use the SetColorArray method for line charts instead of SetDataColor because SetDataColor does not work with line charts. Individual line segments cannot be colored because there are fewer line segments than points. Use SetColorArray instead to color each complete line (series).

Parameters

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

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.

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, call the SetData method again 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 class: SetDataXAxis method, SetDataYAxis method.

SetDataAnnotations

Syntax

SetDataAnnotations(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

Returns

None.

See Also

SetOLDataAnnotations

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 data point must contain either a number or a constant that specifies the color you want to use.

Use the SetColorArray method for line charts instead of SetDataColor because SetDataColor does not work with line charts. Individual line segments cannot be colored because fewer line segments exist than points. Use SetColorArray instead to color each complete line (series).

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

Parameters

See Chart class: SetColorArray method.

Returns

None.

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 for bubble charts (scatter charts). These values are mapped to a range of size values between a predefined minimum and maximum.

This method only affects scatter charts (%ChartType_2DScatter)

Parameters

Returns

None.

See Also

SetOLDataGlyphScale

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 example shows this type of data hints. The tooltips pop-up appears when the cursor hovers over any data value.

Data Hints, Data, and Series

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

Data and Series, but no Data Hints

If you do not specify SetDataHints and do not specify SetDataSeries, then the value of the Y axis and the value of the X axis appear 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:

See Also

Chart 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 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 in quotation marks. You can also specify recordname.fieldname. Use this method for charts created from a chart control or a standalone rowset.

You could use this method 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 region.

&cChart = GetChart(PB_CHART_DUMREC.PB_CHART_FIELD);

&cChart.SetData(Record.PB_CHART_RECORD);
&cChart.SetDataSeries(PB_CHART_RECORD.PB_CHART_PRODUCT);
&cChart.SetDataXAxis(PB_CHART_RECORD.PB_CHART_REGION);
&cChart.SetDataYAxis(PB_CHART_RECORD.PB_CHART_SALES);

See Also

Chart 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 10, the Y-axis labels are given a decimal place. If the greatest Y-axis value is greater than or equal to 10, the Y-axis labels appear as integers.

Note. If you have specified negative numbers in the Y axis, then 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 class: SetDataXAxis method, SetData method.

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 do not 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 not 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 class: SetDataSeries method.

Array Class

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, call the SetOLData method again to update the chart.

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

You can specify two different Y-axis fields, but you must make certain that different data plotted against the same axis makes sense. For example, while plotting two currency amounts would work technically—plotting currency amounts against number of units sold and sharing the same axis— would not look correct.

Parameters

Returns

None.

See Also

Chart class: SetDataXAxis method, SetDataYAxis method, SetData method.

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

Returns

None.

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

Returns

None.

See Also

SetDataGlyphScale

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

Returns

None.

See Also

Chart 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

Returns

None.

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.

This method has no default value.

Parameters

Returns

None.

See Also

Chart class: SetDataXAxis method, SetDataYAxis method.

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 not automatically translated. If you set your own labels, be sure to use translated text, such as message catalog entries.

Parameters

Returns

None.

See Also

Chart class: SetDataXAxis method.

Array Class

Tick Mark Considerations

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 not 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

Returns

None.

See Also

Chart class: SetDataXAxis method, YAxisTicks property, YAxisMax property.

Array Class

Tick Mark Considerations

Chart Class Properties

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

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 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 push button connected with a chart. The push button enables the next set of data to appear with the chart.

You do not need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

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 class: DataStartRow property.

GridLines

Description

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

Note. This property is ignored unless you have set RevertToPre850 to True for the chart.

If you do not specify a value, both horizontal and vertical 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.

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.

Note. This property is ignored unless you have set RevertToPre850 to True for the chart.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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

This property is read-write.

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.

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.

Note. The Height and Width properties must be set to the same value to change the size of a 2D Scatter chart, that is, a chart with the Type property set to %ChartType_2DScatter.

This property is read-write.

See Also

Chart class: Height 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.

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.

Note. The record that contains the PeopleCode must be in the component buffer at runtime.

See Creating a Chart Using the Chart Class.

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.

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 will not be able to click on the chart to trigger an event. In addition, the pop-up data hints will not 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.

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

True XY Line Chart

IsYAxisInteger

Description

Specify whether the Y axis will display integers. Set IsYAxisInteger to True if the Y axis represents integer data, such as number of people or number of tasks.

IsYAxisInteger is not used with pie charts and percentage bar charts.

This property takes a Boolean value.

The default value of this property 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:

This property is read-write.

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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

This property is read-write.

See Also

Chart class: OLLineType property.

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

OLLineType

Description

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

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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

This property is read-write.

See Also

Chart 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.

RevertToPre850

Description

PeopleTools Version 8.50 implements new chart style classes that bring a consistent look and feel to charts.

Use this property to specify whether the chart will revert to the pre-PeopleTools 8.50 chart style classes.

Warning! By default RevertToPre850 is set to False, which means that charts that were created prior to PeopleTools 8.50 will use the new 8.50 chart style classes.

Any custom Chart class properties that were set in PeopleCode for existing charts that use the new 8.50 chart style classes will be ignored if those properties are defined in the 8.50 chart style classes.

Oracle strongly recommends that you review existing charts to verify that they display correctly.

This property takes a Boolean value:

The default is False.

This property is read-write.

See Also

Chart class: OLLineType property.

RotationAngle

Description

Note. This property has been deprecated and remains for backward compatibility only. Use the XRotationAngle, YRotationAngle, and ZRotationAngle properties instead.

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.

You don’t need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

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.

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.

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 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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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 Class 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.

Note. The Height and Width properties must be set to the same value to change the size of a 2D Scatter chart, that is, a chart with the Type property set to %ChartType_2DScatter.

This property is read-write.

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:

This property is read-write.

Example

The following code:

&MyChart.XAxisCross = %ChartXAxisCross_ZeroLineBttm;

produces a chart similar to this:

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

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.

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

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

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

Tick Mark Considerations

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

XRotationAngle

Description

Use this property to specify the angle of rotation about the X axis in degrees.

This property is valid only with 3D-style charts, that is, charts that have the Type property set as %ChartType_3DBar, %ChartType_3DStackedBar, %ChartType_3DPercentBar, or %ChartType_3DPie.

You do not need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

This property takes a string value from “0” to “360”.

The chart is rotated in a clockwise direction.

If a negative value is specified the chart is rotated counter-clockwise.

This property is read-write.

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

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 only applicable to scatter, line, or histogram charts.

This property is read-write.

YAxisMin

Description

Use this property to specify the minimum value of the Y 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 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

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

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

Tick Mark Considerations

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

YRotationAngle

Description

Use this property to specify the angle of rotation about the Y axis in degrees.

This property is valid only with 3D-style charts, that is, charts that have the Type property set as %ChartType_3DBar, %ChartType_3DStackedBar, %ChartType_3DPercentBar, or %ChartType_3DPie.

You do not need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

This property takes a string value from “0” to “360”.

This property is read-write.

ZRotationAngle

Description

Use this property to specify the angle of rotation about the Z axis in degrees.

This property is valid only with 3D-style charts, that is, charts that have the Type property set as %ChartType_3DBar, %ChartType_3DStackedBar, %ChartType_3DPercentBar, or %ChartType_3DPie.

You do not need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

This property takes a string value from “0” to “360”.

This property is read-write.

Gantt Class Methods

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

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. This method has been deprecated and remains for backward compatibility only. Use the SetTaskAppData method or SetTaskData method instead.

You don’t need to refresh 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 chart is automatically refreshed.

Parameters

None.

Returns

None.

Example

&MyChart.Refresh();

See Also

SetTaskAppData, SetTaskData.

Reset

Syntax

Reset()

Description

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

Parameters

None.

Returns

None.

See Also

Chart class: Refresh method.

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 it continues with its normal processing. For these tasks, the overlayed baseline information is not displayed in the chart section.

Parameters

Returns

None.

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

Returns

None.

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

Returns

None.

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

Returns

None.

SetDayFormat

Syntax

SetDayFormat(Format)

Description

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

Parameters

Returns

None.

See Also

SetHourFormat, SetMinuteFormat, SetMonthFormat, SetSecondFormat.

SetHourFormat

Syntax

SetHourFormat(Format)

Description

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

Parameters

Returns

None.

See Also

SetDayFormat, SetMinuteFormat, SetSecondFormat.

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 do not 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 not 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 class: SetDataSeries method.

Array Class

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

Returns

None.

See Also

SetHourFormat, SetSecondFormat.

SetMonthFormat

Syntax

SetMonthFormat(Format)

Description

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

Parameters

Returns

None.

See Also

SetDayFormat, SetYearFormat.

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

Returns

None.

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

Returns

None.

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

Returns

None.

See Also

SetActualTaskBarColor, TaskMilestoneGlyph.

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

Returns

None.

See Also

SetHourFormat, SetMinuteFormat.

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

Returns

None.

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 left-most 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 right-most columns of the table section.

Parameters

Returns

None.

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 left-most 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

Returns

None.

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 overridden 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

Returns

None.

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

Returns

None.

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

Returns

None.

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

Returns

None.

See Also

SetTaskData, SetTaskDependencyChildID, SetTaskDependencyURL, 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

Returns

None.

See Also

SetTaskDependencyChildID, SetTaskDependencyData.

SetTaskDependencyType

Syntax

SetTaskDependencyType(RecordName.FieldName)

Description

Use the SetTaskDependencyType method to specify the type of dependency relationship between predecessor and successor tasks.

The values for type are as follows:

Parameters

Returns

None.

See Also

Gantt class: SetTaskDependencyChildID method, SetTaskDependencyData method, SetTaskDependencyParentID method.

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 overridden 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

Returns

None.

See Also

SetTaskBarURL, SetTaskDependencyChildID, SetTaskDependencyData, SetTaskDependencyParentID.

SetTaskDrill

Syntax

SetTaskDrill(Recordname.FieldName)

Description

Use the SetTaskDrill method to specify for which field PeopleCode FieldEdit and FieldChange events will execute when the user clicks the task bar.

The field can be any field that is loaded in the component buffer.

The system does not change the value in the field when the user clicks the field. Any changes or other processing for the field must be done within the PeopleCode program.

Parameters

Returns

None.

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

Returns

None.

SetTaskHints

Syntax

SetTaskHints(RecordName.FieldName)

Description

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

Parameters

Returns

None.

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

Returns

None.

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

Returns

None.

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

Returns

None.

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

Returns

None.

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 do not specify a task name, the task ID is used in the table section of the Gantt chart.

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

Parameters

Returns

None.

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

Returns

None.

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.

For the progress bar to be visible, its color must contrast with the task bar color. No borders are drawn around the progress bar.

Parameters

Returns

None.

See Also

SetActualTaskBarColor, SetTaskProgress.

SetWBSNumbering

Syntax

SetWBSNumbering(RecordName.FieldName)

Description

Use the SetWBSNumbering method to specify the field in the record that defines the 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

Returns

None.

SetYearFormat

Syntax

SetYearFormat(Format)

Description

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

Parameters

Returns

None.

See Also

SetDayFormat, SetMonthFormat.

Gantt Class Properties

These properties are used by the Gantt class. The properties are described in alphabetic 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.

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 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 push button connected with a chart. The push button enables the next set of data to be displayed with the chart. You don’t need to refresh after setting this property. When a method or property is used, the chart is automatically refreshed.

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 class: DataStartRow property.

GridLines

Description

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

Note. This property is ignored unless you have set RevertToPre850 to True for 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 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.

If you do not 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.

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.

Note. This property is ignored unless you have set RevertToPre850 to True for the chart.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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

This property is read-write.

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.

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.

See Also

Chart class: Height 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.

InteractiveEnd

Description

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

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.

InteractiveMove

Description

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

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

The default value of this property is True.

This property is read-write.

InteractiveProgress

Description

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

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

The default value of this property is True.

This property is read-write.

InteractiveStart

Description

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

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.

IsDrillable

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:

This property takes a Boolean value: True if the end-user can click the chart to initiate an action, and 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.

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 will not be able to click on the chart to trigger an event. In addition, the pop-up data hints will not 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.

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

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.

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 Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

See Also

Style Sheets.

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.

RevertToPre850

Description

PeopleTools Version 8.50 implements new chart style classes that bring a consistent look and feel to charts.

Use this property to specify whether the chart will revert to the pre-PeopleTools 8.50 chart style classes.

Warning! By default RevertToPre850 is set to False, which means that charts that were created prior to PeopleTools 8.50 will use the new 8.50 chart style classes.

Any custom Chart class properties that were set in PeopleCode for existing charts that use the new 8.50 chart style classes will be ignored if those properties are defined in the 8.50 chart style classes.

Oracle strongly recommends that you review existing charts to verify that they display correctly.

This property takes a Boolean value:

The default is False.

This property is read-write.

See Also

Chart class: OLLineType property.

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.

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 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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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.

See Using Style Sheets with PeopleTools Version 8.50 Charts, RevertToPre850.

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 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.

See Also

SetTaskAppDataTitles

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.

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.

OrgChart Class Methods

These methods are used by the OrgChart class. The methods are described in alphabetic order.

SetCrumbData

Syntax

SetCrumbData(&Rowset)

Description

Use the SetCrumbData method to specify the source for the data for the organization chart breadcrumbs. Use an already instantiated and populated level-1 component rowset that contains the breadcrumb data.

Parameters

Returns

None.

SetCrumbRecord

Syntax

SetCrumbRecord(Record.Record_Name)

Description

Use the SetCrumbRecord method to specify the derived/working record name that contains the information about the breadcrumbs.

The breadcrumb record is an application-specific derived/work record created using a clone of the PTORGCRMB_SBR subrecord definition.

Parameters

Returns

None.

SetDropdownData

Syntax

SetDropdownData (&Rowset)

Description

Use the SetDropdownData method to specify the source for the data for the organization chart drop-down list boxes. Use an already instantiated and populated level-1 component rowset that contains the drop-down list data.

Parameters

Returns

None

SetDropdownRecord

Syntax

SetDropDownRecord(Record.RecordName)

Description

Use the SetDropdownRecord method to specify the derived/working record name that contains the information about the dropdown lists.

The dropdown record is an application-specific derived/work record created using a clone of the PTORGBOXLIST_SBR subrecord definition.

Parameters

Returns

None

SetLegend

Syntax

SetLegend(&Array_of_String)

Description

Use the SetLegend method to specify legend text. Legend text labels the images set using SetLegendImg.

If you do not specify an element for an array (that is, a blank or a null) then no legend is listed for that node.

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

Parameters

Returns

None.

Example

&LegendArray = CreateArray("A", "B", C", "D ");
&ocOrgChart.SetLegend (&LegendArray);

See Also

Chart class: SetDataSeries method.

Array Class

SetLegendImg

Syntax

SetLegendImg(&Array_of_String)

Description

Use the SetLegendImg method to specify the legend image names.

Parameters

Returns

None.

SetNodeData

Syntax

SetNodeData(&Rowset)

Description

Use the SetNodeData method to specify the source for the node data for the organization chart. Use an already instantiated and populated level-1 component rowset that contains the node data.

This is a required method to build an organization chart.

If you make a change to the underlying data of a chart, call the SetNodeData method again to update the chart.

Parameters

Returns

None.

SetNodeRecord

Syntax

SetNodeRecord(Record.Record_Name)

Description

Use the SetNodeRecord method to specify the organization node record.

The node record is an application-specific derived/work record created using a clone of the PTORGNODE_SBR subrecord definition.

This method is required to build an organization chart.

Parameters

Returns

None.

SetPopUpNodeData

Syntax

SetPopUpNodeData(&Rowset)

Description

Use the SetPopUpNodeData method to specify the source for the pop-up node data for the organization chart. Use an already instantiated and populated level-1 component rowset that contains the pop-up node data.

This method is not required if no pop-up chart is available to be displayed in the organization chart.

If you make a change to the underlying data of a pop-up chart, call the SetPopUpNodeData method again to update the chart.

Parameters

Returns

None.

SetPopUpNodeRecord

Syntax

SetPopUpNodeRecord(Record.Record_Name)

Description

Use the SetNodeRecord method to specify the pop-up node record.

The node record is an application-specific derived/work record created using a clone of the PTORGPOPUP_SBR subrecord definition.

This method is not required if no pop-up chart is available to be displayed in the organization chart.

Parameters

Returns

None.

OrgChart Class Properties

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

CenterFocusNode

Description

Specify whether the node with focus displays centered in the chart area.

The focus node is not centered if the chart fits in the chart area without a horiztonal scroll, even if CenterFocusNode = 0.

The focus node is not centered if any pop-ups are opened. The display of pop-ups in the visible chart area takes priority over focus node centering.

Note. If multiple pop-ups are opened, the last popup opened is not necessarily set to the visible area. This is determined by the position of the pop-up in the rowset.

The default is 0.

This property is read-write.

ChartScrollType

Description

Specify whether to use scroll bars or alternative scrolling to move the chart within the visible chart area.

Note. To use the mouse hand feature, the chart background color must be specified in the PSORGCHART style sheet. By default, the background color is white.

Note. On an Apple iPad navigation is done using a finger on a touch screen, so scroll bars, the scroll navigator, and mouse hand features are not displayed on an Apple iPad. For an Apple iPad the behavior is the same for both ChartScrollType = 1 and ChartScrollType = 0.

This property takes an integer value.

The default is 0.

This property is read-write.

Collapsed_Msg

Description

Specify the mouseover text message for the collapsed icon image.

An error message is issued if Collapsed_Msg is set but CollapsedImage is not set.

The default is “Expand”.

This property is read-write.

CollapsedImage

Description

Specify the name of the collapsed node image.