OrgChart Class Methods
These methods are used by the OrgChart class. The methods are described in alphabetic order.
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
|
Field or Control |
Definition |
|---|---|
| &Rowset |
A level-1 rowset populated with the breadcrumbs data. |
Returns
None.
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
|
Field or Control |
Definition |
|---|---|
| Record.Record_Name |
Specify the name of the derived/work record that contains the data for the breadcrumbs. You must include the Record keyword. |
Returns
None.
Syntax
SetDropdownData (&Rowset)
Description
Use the SetDropdownData method to specify the source for the data for the organization chart drop-down menus/lists. Use an already instantiated and populated level-1 component rowset that contains the drop-down list data.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Rowset |
A level-1 rowset populated with the drop-down list data. |
Returns
None
Syntax
SetDropDownRecord(Record.RecordName)
Description
Use the SetDropdownRecord method to specify the derived/working record name that contains the information about the dropdown menus/lists.
The dropdown record is an application-specific derived/work record created using a clone of the PTORGBOXLST_SBR subrecord definition.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name |
Specify the name of the derived/work record that contains the data for the drop down lists. You must include the Record keyword. |
Returns
None
Syntax
SetIMData (&rsRowset)
Description
Use the SetIMData method to specify the source for the IM data for the organization chart. Use a standalone rowset that contains the IM data.
This method is required for an organization chart that implements IM presence.
Parameters
|
Field or Control |
Definition |
|---|---|
| &rsRowset |
A standalone rowset populated with the node display data. This rowset references the IM record of the organization chart. |
Returns
None.
Syntax
SetIMRecord(Record.Record_Name)
Description
Use the SetIMRecord method to specify the IM data record.
The IM data record is an application-specific derived/work record created using a clone of the PTORGIM_SBR subrecord definition.
This method is required for an organization chart that implements IM presence.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record.Record_Name |
Specify the name of the derived/work record that contains the IM data for the organization chart. You must include the Record keyword. |
Returns
None.
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
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string, containing the text that you want to use for the legend. |
Returns
None.
Example
&LegendArray = CreateArray("A", "B", C", "D ");
&ocOrgChart.SetLegend (&LegendArray);
Syntax
SetLegendImg(&Array_of_String)
Description
Use the SetLegendImg method to specify the legend image names.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
An already instantiated array containing the names of the images that you want to use with the legend. |
Returns
None.
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
|
Field or Control |
Definition |
|---|---|
| &Rowset |
A level-1 component rowset populated with the node data. This rowset references the node record of the chart. |
Returns
None.
Syntax
SetNodeDisplayDataRecord(Record.Record_Name)
Description
Use the SetNodeDisplayDataRecord method to specify the node display record.
The node display record is an application-specific derived/work record created using a clone of the PTNODE_DISP_SBR subrecord definition.
This method is required for an organization chart that implements node display templates.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record.Record_Name |
Specify the name of the derived/work record that contains the node display data for the organization chart. You must include the Record keyword. |
Returns
None.
Syntax
SetNodeDisplayData(&rsRowset)
Description
Use the SetNodeDisplayData method to specify the source for the node display data for the organization chart. Use an already instantiated and populated level-1 standalone rowset that contains the node display data.
This method is required for an organization chart that implements node display templates.
If you make a change to the node display data of a chart, call the SetNodeDisplayData method again to update the chart.
Parameters
|
Field or Control |
Definition |
|---|---|
| &rsRowset |
A level-1 component rowset populated with the node display data. This rowset references the node display record of the organization chart. |
Returns
None.
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
|
Field or Control |
Definition |
|---|---|
| Record.Record_Name |
Specify the name of the derived/work record that contains the data for the organization node. You must include the Record keyword. |
Returns
None.
Syntax
SetNodeViewEntries(&NodeViewArray)
Description
Use this method to specify the array of string representing the node view IDs.
Parameters
|
Field or Control |
Definition |
|---|---|
| &NodeViewArray |
Specifies an array of string representing the node view IDs. |
Returns
None.
Example
&OrgChart.SetNodeViewEntries(&NodeViewArray);
&OrgChart.SetNodeViewText(&DataHintArray);
&OrgChart.InitialView="VIEW1";Syntax
SetNodeViewText(&DataHintArray)
Description
Use this method to specify the array of string representing the data hint (mouse-over text) for each node view.
Parameters
|
Field or Control |
Definition |
|---|---|
| &DataHintArray |
Specifies an array of string representing the data hint (mouse-over text) for each node view. |
Returns
None.
Example
&OrgChart.SetNodeViewEntries(&NodeViewArray);
&OrgChart.SetNodeViewText(&DataHintArray);
&OrgChart.InitialView="VIEW1";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
|
Field or Control |
Definition |
|---|---|
| &Rowset |
A level-1 rowset populated with the pop-up node data. This rowset references the pop-up node record of the chart. |
Returns
None.
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
|
Field or Control |
Definition |
|---|---|
| Record.Record_Name |
Specify the name of the derived/work record that contains the data for the pop-up node. You must include the Record keyword. |
Returns
None.
Syntax
SetSchemaLevels(&Array) ;
Description
Use this method to specify the schema levels for an organization chart. Use an array of instantiated SchemalLevel instances. The size of the array is the total number of the schemas defined for this organization chart.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array |
An array of instantiated SchemalLevel instances. |
Returns
None.
Example
SchemaLevel &oSchemaLevel1 = Createobject("SchemaLevel");
SchemaLevel &oSchemaLevel2 = Createobject("SchemaLevel");
SchemaLevel &oSchemaLevel3 = Createobject("SchemaLevel");
SchemaLevel &oSchemaLevel4 = Createobject("SchemaLevel");
/*** Create an instance of of schema zoom level 1 class and instantiate it ***/
SchemaLevel &oSchemaLevel1 =Createobject("SchemaLevel");
&oSchemaLevel1.ID=1;
& oSchemaLevel1.ImageHeight=0;
.... (add code to instantiate &oSchemaLevel1, &oSchemaLevel2,
&oSchemaLevel3, &oSchemaLevel4 instances).
&SchemaLevels=CreateArray(&oSchemaLevel1, &oSchemaLevel2, &oSchemaLevel3, &oSchemaLevel4)
&ocOrgChart.SetZoomSchemaLevels(&SchemaLevls)