Chart Director API for APPX

Installation Tips

Overview

Chart Director API for APPX

-- Wim Jongejan - 2015-01-27

<--/commentPlugin-->

-- SteveFrizzell - 2010-02-14

Chart Director API for APPX

<--/commentPlugin-->

-- SteveFrizzell - 2010-02-14

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

Overview

Data Routines

Pie Chart Routines

XY Chart Routines

Comments:

Read what other users have said about this page or add your own comments.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

Overview

Data Routines

Chart Director API for APPX

• The .LEGEND SET ICON GAP seems to update the memory file, but unless you also call .LEGEND SET ICON SZ, nothing gets written to the php script.
• The .LEGEND SET TEMPLATE causes the chart to fail to render unless you enclose the text in "'s. When generating the php script, the API should do this automatically.
• Setting the vertical gap via .LEGEND SET GAP:V doesn't work unless you also set the horizontal gap via .LEGEND SET GAP:H. If the horizontal gap is not set, the php script doesn't include the setKeySpacing method, which controls both horizontal & vertical.

• If you pass a 'data point' to .XY SET BAR CLR, funny things happen. It creates a LAYERDGP record & saves the RID. Subsequent calls to .XY SET BAR CLR with no 'data point' will just change the colour on the LAYERDGP record, which probably isn't what the designer wanted. The colours will probably not render correctly on the chart.
• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.
• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?

• .TEXT SET TXT MAX:H has no affect. The memory file is updated, but does not affect the rendered chart. If set via .TEXT SET TXT MAX, then it works.
• The .TEXT SET TXT MARGIN:(T,L,B,R) subroutines apply the specified margin to all margins instead of just the one the routine is designed for.
• Sample Chart Issues:

Overview

Data Routines

Chart Director API for APPX

• Setting a height via .TEXT SET FONT SZ:H and then using the text box in .CHART SET TITLE causes the height to be used for both height and width (the height is used as a paramter on the addTitle method).
• .TEXT SET TXT MAX:H has no affect. The memory file is updated, but does not affect the rendered chart. If set via .TEXT SET TXT MAX, then it works.
• The .TEXT SET TXT MARGIN:(T,L,B,R) subroutines apply the specified margin to all margins instead of just the one the routine is designed for.

Overview

Data Routines

Base Chart Routines

Pie Chart Routines

Chart Director API for APPX

• Setting a height via .TEXT SET FONT SZ:H and then using the text box in .CHART SET TITLE causes the height to be used for both height and width (the height is used as a paramter on the addTitle method).
• .TEXT SET TXT MAX:H has no affect. The memory file is updated, but does not affect the rendered chart. If set via .TEXT SET TXT MAX, then it works.
• The .TEXT SET TXT MARGIN:(T,L,B,R) subroutines apply the specified margin to all margins instead of just the one the routine is designed for.

Pie Chart Routines - General

.PIE SET DATASET

.AXIS SET LBL OFFSET

Set the offset of the labels and the offset units for the the "current" axis. The offset units is an optional second parameter. The default for the offset unit is pixels.

Shape Routines

.SHAPE INITIALIZE

Chart Director API for APPX

• .TEXT SET FONT SZ is supposed to accept a height & width, but only uses height to set font size in the addTitle method.
• Setting a width via .TEXT SET FONT SZ:W and then using the text box in .CHART SET TITLE does not work.
• Setting a height via .TEXT SET FONT SZ:H and then using the text box in .CHART SET TITLE causes the height to be used for both height and width (the height is used as a paramter on the addTitle method).

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

.TEXT SET BX LOC

.TEXT SET BX LOC:X

.TEXT SET BX LOC:Y

.TEXT SET BX SZ

Set the size (height and width) of the "current" Text Object.

Chart Director API for APPX

• Attempting to set the brightness via .COLOR SET BRIGHTNESS results in a php error: PHP Fatal error: Call to undefined function adjustBrightness() in <whatever file> on line <whatever line>. FWIW, adjustBrightness is documented in Chart Director.
• Attempting to set the brightness via .COLOR SET HALF COLOR results in a php error: PHP Fatal error: Call to undefined function halfColor() in <whatever file> on line <whatever line>. FWIW halfColor is documented in Chart Director.
• .COLOR SET DASH LINE accepts hex values with a prefix of '0x', '#' or nothing at all, but the chart will only be rendered if the prefix is '0x'. Either improve the edits, or convert the '#' or no prefix to a '0x' prefix before updating COLRSPEC.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.
• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?
• Consider renaming .LAYER ADD DATASET to something that includes TEMPLATE, since the use of 'dataset' conflicts with the use of 'dataset' when adding data points. Also consider renaming .LAYER LINK DATASET to include the word TEMPLATE.

• .AXIS SET AXIS L has no effect on the length of the axis line.
• .AXIS SET AXIS RND MIN and .AXIS SET AXIS RND MAX don't work unless you use both subroutines. (Sub C.XYCHART,"* Set axis rounded minimum & maximum IF 0CD AXISSPEC AXIS RND MIN NE AND 0CD AXISSPEC AXIS RND MAX NE". Should be an OR?)
• Setting AXISSPEC TICK MAJ DIST and AXISSPEC TICK MIN DIST (via .AXIS SET TICK DENSITY) calls the setMinTickInc method instead of setTickDensity.

Text Box Routines

General Text Box Routines

.TEXT SET CURRENT

Chart Director API for APPX

• Setting AXISSPEC TICK MAJ DIST and AXISSPEC TICK MIN DIST (via .AXIS SET TICK DENSITY) calls the setMinTickInc method instead of setTickDensity.
• The .AXIS SET LBL ROTATION subroutine has no affect. The memory file is updated, but the chart rendering does not use the values.
• The .AXIS SET LBL OFFSET routine accepts Pixel or Scale as a second parameter, but the rendered chart always treats the offset as Scale.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

.PIE SET LAYOUT:DIR

Set the layout direction for the pie sectors.

.PIE SET LBL BOUNDS

Set the Top and Bottom bounds for the pie sector labels (Side Label Layout only).

.COLOR SET BRUSH METAL

.COLOR SET BRIGHTNESS

Set the brightness of the "current" Color Object.

Chart Director API for APPX

.COLOR SET TRANSPARENT

.COLOR SET OPAQUE

.COLOR SET METAL

Set the direction for brightness modulation to create a Metal color effect for the "current" Color Object.

Chart Director API for APPX

• .AXIS SET AXIS RND MIN and .AXIS SET AXIS RND MAX don't work unless you use both subroutines. (Sub C.XYCHART,"* Set axis rounded minimum & maximum IF 0CD AXISSPEC AXIS RND MIN NE AND 0CD AXISSPEC AXIS RND MAX NE". Should be an OR?)
• Setting AXISSPEC TICK MAJ DIST and AXISSPEC TICK MIN DIST (via .AXIS SET TICK DENSITY) calls the setMinTickInc method instead of setTickDensity.
• The .AXIS SET LBL ROTATION subroutine has no affect. The memory file is updated, but the chart rendering does not use the values.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

• .AXIS SET AXIS L has no effect on the length of the axis line.
• .AXIS SET AXIS RND MIN and .AXIS SET AXIS RND MAX don't work unless you use both subroutines. (Sub C.XYCHART,"* Set axis rounded minimum & maximum IF 0CD AXISSPEC AXIS RND MIN NE AND 0CD AXISSPEC AXIS RND MAX NE". Should be an OR?)
• Setting AXISSPEC TICK MAJ DIST and AXISSPEC TICK MIN DIST (via .AXIS SET TICK DENSITY) calls the setMinTickInc method instead of setTickDensity.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Axis Label Routines

.AXIS LABEL ADD NEXT

.AXIS SET LBL FONT NAM

Set the font name and font index for the "current" label of the "current" Axis.

Chart Director API for APPX

Dataset Point Routines

.POINT ADD NEW

.POINT SET VALUE

Set the value of the "current" Point in the "current" Dataset.

General Text Box Routines

.TEXT INITIALIZE

Chart Director API for APPX

.AXIS SET TTL FONT IDX

.AXIS SET TTL FONT STL

.AXIS SET TTL FONT SZ

.AXIS SET TTL FONT CLR

.AXIS SET TTL ALIGN

Set the alignment of the axis title relative to the axis for the "current" axis.

.AXIS SET TTL GAP

Axis Label Routines

.AXIS LABEL ADD NEXT

Add the next label to the "current" Axis of the "current" chart.

.AXIS SET LBL FONT NAM

.AXIS SET LBL FONT IDX

.AXIS SET LBL FONT STL

.AXIS SET LBL FONT SZ

.AXIS SET LBL FONT CLR

.AXIS SET LBL ROTATION

.AXIS SET LBL FORMAT

.AXIS SET LBL GAP

Set the distance between the axis label and the tick in pixels for the "current" axis.

Chart Director API for APPX

Axis Title Routines

.AXIS SET TITLE

.AXIS SET TTL FONT NAM

.AXIS SET TTL FONT IDX

Set the font index for the title of the "current" axis. (set the current textspec to be the axis title TEXTSPEC of the current axis and call .TEXT SET FONT INDEX)

Chart Director API for APPX

• Code examples are supposed to be copy/pasteable into the ILF editor, but there's a good chance lots of them won't work, as this requirement wasn't known when the pages were written. Review all ILF samples to make sure they work?
• .AXIS SET AXIS L has no effect on the length of the axis line.
• .AXIS SET AXIS RND MIN and .AXIS SET AXIS RND MAX don't work unless you use both subroutines. (Sub C.XYCHART,"* Set axis rounded minimum & maximum IF 0CD AXISSPEC AXIS RND MIN NE AND 0CD AXISSPEC AXIS RND MAX NE". Should be an OR?)

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

.CHART SET CNR EXT CLR

Set the exterior color for rounded corners for the "current" chart.

Base Chart Routines - Drop Shadow Options

.CHART SET DROP SHADOW

.CHART SET DS BLUR RAD

Set the Blur Radius of the Drop Shadow Effect for the "current" chart.

Base Chart Routines - Options

.CHART SET TRANS TYPE

Chart Director API for APPX

• Consider renaming .LAYER ADD DATASET to something that includes TEMPLATE, since the use of 'dataset' conflicts with the use of 'dataset' when adding data points. Also consider renaming .LAYER LINK DATASET to include the word TEMPLATE.
• Code examples are supposed to be copy/pasteable into the ILF editor, but there's a good chance lots of them won't work, as this requirement wasn't known when the pages were written. Review all ILF samples to make sure they work?
• .AXIS SET AXIS L has no effect on the length of the axis line.

Overview

.AXIS SET AXIS RND MIN

.AXIS SET AXIS RND MAX

.AXIS SET AXIS VAL DIR

Axis Tick Routines

.AXIS SET TICK CLR

Chart Director API for APPX

• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?
• Consider renaming .LAYER ADD DATASET to something that includes TEMPLATE, since the use of 'dataset' conflicts with the use of 'dataset' when adding data points. Also consider renaming .LAYER LINK DATASET to include the word TEMPLATE.
• Code examples are supposed to be copy/pasteable into the ILF editor, but there's a good chance lots of them won't work, as this requirement wasn't known when the pages were written. Review all ILF samples to make sure they work?

Overview

Chart Director API for APPX

• The .PIE SET SECT EDGE W subroutine sets the value in the memory files, but the rendered chart doesn't look any different. Looks like when setSectorStyle code is generated, the edge width is missing. Also, if you don't also set .PIE SET SECT SHADING, the setSectorStyle code is not generated at all, even if a width was specified.
• If you explode all the sectors in a pie chart via .PIE SET SECT POSITION then you can't adust the distance on specific sectors via .PIE SET SECT EXP DIST. The generated setExplode method does not include the distance parameter or isn't being generated for individual sectors.
• .PIE SET LBL DISTANCE doesn't seem to do anything.

• If you pass a 'data point' to .XY SET BAR CLR, funny things happen. It creates a LAYERDGP record & saves the RID. Subsequent calls to .XY SET BAR CLR with no 'data point' will just change the colour on the LAYERDGP record, which probably isn't what the designer wanted. The colours will probably not render correctly on the chart.
• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.
• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?

Chart Director API for APPX

• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.
• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?
• Consider renaming .LAYER ADD DATASET to something that includes TEMPLATE, since the use of 'dataset' conflicts with the use of 'dataset' when adding data points. Also consider renaming .LAYER LINK DATASET to include the word TEMPLATE.

Overview

.XY SET BAR W

.XY SET BAR W:GROUP

.XY SET BAR W:WITHIN

.XY SET BAR 3D DEPTH

Axis Routines

General

.AXIS SET CURRENT

Chart Director API for APPX

• If you pass a 'data point' to .XY SET BAR CLR, funny things happen. It creates a LAYERDGP record & saves the RID. Subsequent calls to .XY SET BAR CLR with no 'data point' will just change the colour on the LAYERDGP record, which probably isn't what the designer wanted. The colours will probably not render correctly on the chart.
• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.
• Setting custom shapes on the second data group in a multi layer bar chart does not work. The PHP code looks right, possible CD bug?

Overview

Dataset Point Routines

.POINT ADD NEW

Chart Director API for APPX

.DATASET GET NAME

Get the name of the "current" Dataset.

Dataset Point Routines

.POINT ADD NEW

.POINT SET VALUE

Set the value of the "current" Point in the "current" Dataset.

General Text Box Routines

.TEXT INITIALIZE

Chart Director API for APPX

.SHAPE SET SHAPE ID

.SHAPE SET SIDES CNT

.SHAPE SET POINTS CNT

.SHAPE SET WIDTH PCT

.SHAPE SET NEXT POINT

Chart Director API for APPX

• XY Chart - if you try to run it >1 time (ie, set Frame type to 'Repeating' in example program), the 2nd time thru will cancel with 'Error - Record Not in File - Dataset'.
• If you pass a 'data point' to .XY SET BAR CLR, funny things happen. It creates a LAYERDGP record & saves the RID. Subsequent calls to .XY SET BAR CLR with no 'data point' will just change the colour on the LAYERDGP record, which probably isn't what the designer wanted. The colours will probably not render correctly on the chart.
• The .XY SET BAR LBL MIN SZ subroutine is used to set the minimum distance for a label to appear within a bar on a bar chart, but there doesn't seem to be a way to get labels inside the bar on a bar chart in the first place.

Overview

Chart Director API for APPX

.XY SET BAR LBL MIN SZ

.XY SET BAR LEGEND ISZ

Sets the height and width of the icons used in a legend.

.XY SET BAR OLAP

.XY SET BAR OLAP:ORDER

.XY SET BAR OLAP:RATIO

.XY SET BAR SHAPE

Set the shape of the bars in the current Data Point, Data Set, Data Group, or XY Bar Layer

Chart Director API for APPX

• .PIE SET LBL DISTANCE doesn't seem to do anything.
• XY Chart - if you try to run it >1 time (ie, set Frame type to 'Repeating' in example program), the 2nd time thru will cancel with 'Error - Record Not in File - Dataset'.
• If you pass a 'data point' to .XY SET BAR CLR, funny things happen. It creates a LAYERDGP record & saves the RID. Subsequent calls to .XY SET BAR CLR with no 'data point' will just change the colour on the LAYERDGP record, which probably isn't what the designer wanted. The colours will probably not render correctly on the chart.

Overview

.XY SET BAR LEGEND ISZ

Sets the height and width of the icons used in a legend.

.XY SET BAR OLAP

.XY SET BAR OLAP:ORDER

Chart Director API for APPX

.XY SET BAR LEGEND ISZ

.XY SET BAR LEGEND TXT

.XY SET BAR OLAP

Chart Director API for APPX

.XY SET BAR GAP

.XY SET BAR GAP:BTW

.XY SET BAR GAP:WITHIN

.XY SET BAR LBL MIN SZ

.XY SET BAR LEGEND ISZ

Chart Director API for APPX

• If you explode all the sectors in a pie chart via .PIE SET SECT POSITION then you can't adust the distance on specific sectors via .PIE SET SECT EXP DIST. The generated setExplode method does not include the distance parameter or isn't being generated for individual sectors.
• .PIE SET LBL DISTANCE doesn't seem to do anything.
• XY Chart - if you try to run it >1 time (ie, set Frame type to 'Repeating' in example program), the 2nd time thru will cancel with 'Error - Record Not in File - Dataset'.

Overview

Chart Director API for APPX

• The .PIE SET SECT EDGE W subroutine sets the value in the memory files, but the rendered chart doesn't look any different. Looks like when setSectorStyle code is generated, the edge width is missing. Also, if you don't also set .PIE SET SECT SHADING, the setSectorStyle code is not generated at all, even if a width was specified.
• If you explode all the sectors in a pie chart via .PIE SET SECT POSITION then you can't adust the distance on specific sectors via .PIE SET SECT EXP DIST. The generated setExplode method does not include the distance parameter or isn't being generated for individual sectors.
• .PIE SET LBL DISTANCE doesn't seem to do anything.

Overview

Chart Director API for APPX

• • It verifies the file exists only for a full pathname, should verify image directory as well
  • Also check .CHART SET BG WALLPAPR, probably has the same problem.
• The examples in 1CD have the path /var/www/html/ChartDirector/phpdemo hardcoded. This path can vary depending on Windows vs Linux installation. The examples should probably check the server type and use the appropriate default.

• The .CHART SET SHAPE AA seems to update the memory file, but unless you also call .CHART SET TXT AA MODE, nothing gets put in the php script. Even if you call .CHART SET TXT AA MODE, the parameter for shape AA is always true, even if you turned it off via .CHART SET SHAPE AA
• The .LEGEND SET ICON GAP seems to update the memory file, but unless you also call .LEGEND SET ICON SZ, nothing gets written to the php script.
• The .LEGEND SET TEMPLATE causes the chart to fail to render unless you enclose the text in "'s. When generating the php script, the API should do this automatically.

.CHART SET CNR R:BL

Set the radius of the Bottom Left corner of the "current" chart.

Base Chart Routines - Drop Shadow Options

.CHART SET DROP SHADOW

.CHART SET DS BLUR RAD

Set the Blur Radius of the Drop Shadow Effect for the "current" chart.

Base Chart Routines - Options

.CHART SET TRANS TYPE

Chart Director API for APPX

.PIE SET 3D DEPTH

Set the 3D depth of the pie.

.PIE SET 3D VIEW ANGLE

Set the 3D viewing angle of the pie.

.PIE SET LAYOUT:DIR

Set the layout direction for the pie sectors.

.PIE SET LBL BOUNDS

Set the Top and Bottom bounds for the pie sector labels (Side Label Layout only).

Chart Director API for APPX

• .PIE SET LBL BOUNDS (and the routines to set upper/lower individually) appear to work and the generated PHP code looks right, but it seems to have no effect on the generated chart.
• The .PIE SET SECT EDGE W subroutine sets the value in the memory files, but the rendered chart doesn't look any different. Looks like when setSectorStyle code is generated, the edge width is missing. Also, if you don't also set .PIE SET SECT SHADING, the setSectorStyle code is not generated at all, even if a width was specified.
• If you explode all the sectors in a pie chart via .PIE SET SECT POSITION then you can't adust the distance on specific sectors via .PIE SET SECT EXP DIST. The generated setExplode method does not include the distance parameter or isn't being generated for individual sectors.

Overview

Chart Director API for APPX

• .PIE SET LBL LAYOUT accepts 'INSIDE' as an argument to put the labels inside the sectors, but it doesn't work.
• .PIE SET LBL BOUNDS (and the routines to set upper/lower individually) appear to work and the generated PHP code looks right, but it seems to have no effect on the generated chart.
• The .PIE SET SECT EDGE W subroutine sets the value in the memory files, but the rendered chart doesn't look any different. Looks like when setSectorStyle code is generated, the edge width is missing. Also, if you don't also set .PIE SET SECT SHADING, the setSectorStyle code is not generated at all, even if a width was specified.

Overview

Chart Director API for APPX

• Setting the vertical gap via .LEGEND SET GAP:V doesn't work unless you also set the horizontal gap via .LEGEND SET GAP:H. If the horizontal gap is not set, the php script doesn't include the setKeySpacing method, which controls both horizontal & vertical.
• .PIE SET LBL LAYOUT accepts 'INSIDE' as an argument to put the labels inside the sectors, but it doesn't work.
• .PIE SET LBL BOUNDS (and the routines to set upper/lower individually) appear to work and the generated PHP code looks right, but it seems to have no effect on the generated chart.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

.PIE SET LBL BOUNDS:B

Set the Bottom bound for the pie sector labels (Side Label Layout only).

.PIE SECT INITIALIZE

Initialize a specific pie sector spec.

.PIE SECT SET CURRENT

Set the "current" pie chart sector to be a previously initialized pie sector of the "current" chart.

.PIE SET SECT BG CLR

Set the background color for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT SHADING

Set the Shading Method for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT EDGE CLR

Set the Edge Color for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT EDGE W

Set the Edge Width for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT POSITION

Set the Position (Normal or Exploded) for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT EXP DIST

Set the Explosion Distance for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT LABEL

.PIE SET LBL FORMAT

Set the Format for the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.

.PIE SET LBL FONT NAM

.PIE SET LBL ROTATION

Set the rotation angle for all sectors of the current pie chart.

.XY SET PLOT AREA

Set the position and size of the plot area.

.XY SET BAR 3D DEPTH

Set the 3D depth of the current bar layer.

.AXIS SET CURRENT

Set the specified axis ("x", "y") of the "current" chart to be the "current" axis. (a second optional parameter can specify "Primary" or "Secondary")

.AXIS SET AXIS VAL DIR

Set the direction for the values of the "current" axis. (NORMAL or REVERSE)

.AXIS SET TICK CLR

Set the color of the (major and minor) ticks on the "current" axis.

.AXIS SET TICK DENSITY

Set the distance in pixels between major ticks and minor ticks on the "current" axis.

.AXIS SET TITLE

Set a title for the "current" axis. (creates a TEXTSPEC record which then becomes the current TEXT spec similar to .CHART SET TITLE)

.AXIS SET TTL GAP

Set the gap between the axis title and the axis for the "current" axis. Note: Title gap does not seem to work correctly in all cases. Possible bug in Chart Director.

.AXIS LABEL ADD NEXT

Add the next label to the "current" Axis of the "current" chart.

.AXIS SET LBL OFFSET

Set the offset of the labels and the offset units for the the "current" axis. The offset units is an optional second parameter. The default for the offset unit is pixels.

.DATASET INITIALIZE

Initialize a Dataset.

.DATASET GET NAME

Get the name of the "current" Dataset.

.POINT ADD NEW

Add a new Point to the "current" Dataset. Also create a corresponding sector spec for the "current" (pie) chart if one does not exist.

.POINT SET VALUE

Set the value of the "current" Point in the "current" Dataset.

.TEXT INITIALIZE

Initialize a Text Object

.TEXT SET TEXT

Set the text of the "current" Text Object.

.TEXT SET FONT NAME

Set the font name and font index for the "current" Text Object.

.TEXT SET FONT CLR

Set the font color for the "current" Text Object.

.TEXT SET BX BG CLR

Set the background color for the "current" Text Object.

.TEXT SET BX Z ORDER

Set the Z Order of the "current" Text Object.

.TEXT SET TXT MAX SZ

Set the maximum size (width and height) of the text that can be displayed in the "current" Text Object.

Chart Director API for APPX

• The .LEGEND SET ICON GAP seems to update the memory file, but unless you also call .LEGEND SET ICON SZ, nothing gets written to the php script.
• The .LEGEND SET TEMPLATE causes the chart to fail to render unless you enclose the text in "'s. When generating the php script, the API should do this automatically.
• Setting the vertical gap via .LEGEND SET GAP:V doesn't work unless you also set the horizontal gap via .LEGEND SET GAP:H. If the horizontal gap is not set, the php script doesn't include the setKeySpacing method, which controls both horizontal & vertical.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

Chart Director API for APPX

• The .CHART SET EXT CLR routine is mentioned here but does not exist.
• The .CHART SET SHAPE AA seems to update the memory file, but unless you also call .CHART SET TXT AA MODE, nothing gets put in the php script. Even if you call .CHART SET TXT AA MODE, the parameter for shape AA is always true, even if you turned it off via .CHART SET SHAPE AA
• The .LEGEND SET ICON GAP seems to update the memory file, but unless you also call .LEGEND SET ICON SZ, nothing gets written to the php script.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

• The examples in 1CD have the path /var/www/html/ChartDirector/phpdemo hardcoded. This path can vary depending on Windows vs Linux installation. The examples should probably check the server type and use the appropriate default.
• The .CHART SET EXT CLR routine is mentioned here but does not exist.
• The .CHART SET SHAPE AA seems to update the memory file, but unless you also call .CHART SET TXT AA MODE, nothing gets put in the php script. Even if you call .CHART SET TXT AA MODE, the parameter for shape AA is always true, even if you turned it off via .CHART SET SHAPE AA

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

.LEGEND SET ICON SZ:H

.LEGEND SET ICON GAP

Set the distance between the Legend icon and the Legend text.

.LEGEND SET KEY GAP

.LEGEND SET KEY GAP:H

.LEGEND SET KEY GAP:V

Set the vertical gap (line spacing) between the legend keys of the "current" Legend Box.

Chart Director API for APPX

• • Also check .CHART SET BG WALLPAPR, probably has the same problem.
• The examples in 1CD have the path /var/www/html/ChartDirector/phpdemo hardcoded. This path can vary depending on Windows vs Linux installation. The examples should probably check the server type and use the appropriate default.
• The .CHART SET EXT CLR routine is mentioned here but does not exist.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

.CHART SET DS COLOR

Set the Color of the Drop Shadow Effect for the "current" chart.

.CHART SET DS LOC:X

Chart Director API for APPX

• • It verifies the file exists only for a full pathname, should verify image directory as well
  • Also check .CHART SET BG WALLPAPR, probably has the same problem.
• The examples in 1CD have the path /var/www/html/ChartDirector/phpdemo hardcoded. This path can vary depending on Windows vs Linux installation. The examples should probably check the server type and use the appropriate default.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

• The .CHART SET BG IMAGE routine does not pick up images in the default image directory, only a full pathname works
  • It verifies the file exists only for a full pathname, should verify image directory as well
  • Also check .CHART SET BG WALLPAPR, probably has the same problem.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

Known Issues

• The pointer files (PTR1/2) are not initialized when .CHART INITIALIZE is called, so each time you call .CHART RENDER, the previously defined pointers appear as well as the one(s) you intended for the current chart.
• The PRT1/2 files are not linked to a particular CHTSPEC record, so if you are working with multiple charts of this type, when you render a chart the pointer(s) will appear on all charts, not just the current one.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

.CHART SET SHAPE AA

.CHART SET TXT AA MODE

Set the Text Anti-Alias Mode for the "current" chart.

.PIE SET LBL FORMAT

Set the Format for the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.

.PIE SET LBL FONT NAM

.XY SET PLOT AREA:H

.XY SET PA BG CLR

Set the Plot Area background colors.

.AXIS SET AXIS MARGIN

.AXIS SET AXIS MODE

Set the axis mode of the "current" axis to be INDENTED or DEFAULT.

.AXIS SET TTL GAP

Axis Label Routines

.AXIS LABEL ADD NEXT

.TEXT SET BX CNR R

.TEXT SET BX CNR R:TL

Set the radius of the Top Left corner of the "current" Text Object.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

• The PRT1/2 files are not linked to a particular CHTSPEC record, so if you are working with multiple charts of this type, when you render a chart the pointer(s) will appear on all charts, not just the current one.

Overview

Using the API

There are some key concepts you should understand before using the Chart Design subroutines.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

• The PRT1/2 files are not linked to a particular CHTSPEC record, so if you are working with multiple charts of this type, when you render a chart the pointer(s) will appear on all charts, not just the current one.

Overview

Using the API

Designing a Chart

Chart design is accomplished by calling the appropriate Chart Design subroutines in the appropriate sequence to create a chart specification.

Chart Director API for APPX

• The pointer files (PTR1/2) are not initialized when .CHART INITIALIZE is called, so each time you call .CHART RENDER, the previously defined pointers appear as well as the one(s) you intended for the current chart.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Designing a Chart

Chart design is accomplished by calling the appropriate Chart Design subroutines in the appropriate sequence to create a chart specification.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

Overview

Release 5.1.0 of the APPX Utility includes a new designer API which can be used to create charts within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to design charts, define datasets, and render charts using datasets. These charts can then be dynamically embedded in APPX menus, input screens, and PDF reports.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.SHAPE SET SHAPE ID

Set the Shape ID of the "current" Shape Object.

.SHAPE SET POINTS CNT

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.SHAPE SET DEFAULT

Clear the "current" Shape Object.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.XY SET BAR CLR:DG

Set the color of the bars for the current Data Group

.XY SET BAR GAP

.XY SET BAR SHAPE

.XY SET BAR W

.XY SET BAR W:GROUP

.COLOR SET DASH LINE

Set the dash line pattern for the "current" Color Object.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.XY ADD BAR LAYER

Adds a Bar layer to the current chart spec.

.XY SET BAR GAP

Set the horizontal gap between the bars.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.XY SET BAR CLR

Set the color of the bars in the current bar layer.

.XY SET BAR 3D DEPTH

Set the 3D depth of the current bar layer.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.COLOR SET BRUSH METAL

Set the strength of the texture to create a Brushed Metal Effect for the "current" Color Object. Must be None, Light, Medium, or Strong. This routine is usually called in conjunction with .COLOR SET METAL.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

.COLOR SET OPAQUE

Set the alpha channel of the "current" Color Object to be Opaque.

Chart Director API for APPX

This API can be used by an APPX designer to create business charts within an APPX application.

Rendering a Chart

A chart is rendered by calling the Chart Render subroutine for a chart specification and its associated dataset definition(s).

.CHART INITIALIZE

Initialize a chart.

.CHART RENDER

Render the "current" chart.

.CHART SET TITLE

Set the title of the "current" chart.

.CHART SET LEGEND BOX

Set a Legend Box at the specified X and Y coordinates of the "current" chart.

.CHART SET BG COLOR

Set the background color of the "current" chart to the "current" color.

.CHART SET BG IMAGE

Set the pathname of an image file that is to be positioned within the background area of the "current" chart.

.CHART SET EDGE COLOR

Set the edge color of the "current" chart.

.CHART SET EDGE WIDTH

Set the edge width of the "current" chart. Used in conjunction with Edge Effect.

.CHART SET CNR STYLE

Set the corner style (Square or Rounded) of the "current" chart.

.CHART SET CNR R

Set the corner radius' of the "current" chart.

.CHART SET CNR R:BL

Set the radius of the Bottom Left corner of the "current" chart.

.LEGEND SET TEMPLATE

Set the template of the legend text for the "current" Legend Box.

.LEGEND SET KEY STYLE

Set the key style for the "current" Legend Box.

.LEGEND KEY ADD NEXT

Add the next legend box key to the "current" Legend Box.

.LEGEND KEY SET LN W

Set the line width for a legend key that represents lines in line charts at the specified legend key position for the "current" Legend Box.

.PIE SECT INITIALIZE

Initialize a specific pie sector spec.

.PIE SECT SET CURRENT

Set the "current" pie chart sector to be a previously initialized pie sector of the "current" chart.

.PIE SET SECT SHADING

Set the Shading Method for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT EDGE CLR

Set the Edge Color for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET SECT EDGE W

Set the Edge Width for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.

.PIE SET LBL LAYOUT

Set the Label Layout Method (Inside, Circular, Side) for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.

.PIE SET LBL FORMAT

Set the Format for the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.

XY Chart Routines

General

.XY SET PLOT AREA