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.
Designing a Chart
Chart design is accomplished by calling the appropriate Chart Design subroutines in the appropriate sequence to create a chart specification.
Defining a Dataset
Datasets are defined by calling the appropriate Dataset Design subroutines in the appropriate sequence to create a dataset definition.
Rendering a Chart
A
chart is rendered by calling the Chart Render subroutine for a chart specification and its associated dataset definition(s).
Chart Specifications
Chart Routines - General
Initialize a chart.
Render the "current" chart.
Set the title of the "current" chart.
Set the size (height and width) of the "current" chart.
Set the height of the "current" chart.
Set the width of the "current" chart.
Set the background color of the "current" chart to the "current" color.
Set the pathname of a wallpaper image that is to be tiled within the background area of the "current" chart.
Set the pathname of an image file that is to be positioned within the background area of the "current" chart.
Set the edge color of the "current" chart.
Set the edge effect of the "current" chart.
Set the edge width of the "current" chart. Used in conjunction with Edge Effect.
Set the corner style (Square or Rounded) of the "current" chart.
Set the exterior color for rounded corners and/or the Drop Shadow effect of the "current" chart.
Set the corner radius' of the "current" chart.
Set the radius of the Top Left corner of the "current" chart.
Set the radius of the Top Right corner of the "current" chart.
Set the radius of the Bottom Right corner of the "current" chart.
Set the radius of the Bottom Left corner of the "current" chart.
Set the "current" chart to be a previously initialized chart.
Get the name of the "current" chart.
Not Yet Implemented
Add the "current" chart object to the specified Multi-Chart.
Add the specified chart object to the "current" Multi-Chart.
Set the Shape Anit-Alias to be On or Off for the "current" chart.
Set the Text Anti-Alias Mode for the "current" chart.
Set the Transparency Type for the "current" chart.
Set the Transparency Color for the "Current" chart. This field is usually set in conjunction with the "Single Color" Transparency Type.
Set the Drop Shadow Effect to be On or Off for the "current" chart.
Set the X and Y coordinates of the offset of the Drop Shadow Effect for the "current" chart.
Set the X coordinate of the offset of the Drop Shadow Effect for the "current" chart.
Set the Y coordinate of the offset of the Drop Shadow Effect for the "current" chart.
Set the Blur Radius of the Drop Shadow Effect for the "current" chart.
Set the Color of the Drop Shadow Effect for the "current" chart.
Pie Chart Routines
General
Associate a dataset with the pie chart.
Set the view of the pie to be 2D or 3D.
Set the shape of the pie to be Standard or Donut.
Set the x and y coordinates (horizonal and vertical) of the center of the pie.
Set the x coordinate (horizontal) of the center of the pie.
Set the y coordinate (vertical) of the center of the pie.
Set the radius of the pie.
Set the outer radius of a Donut pie.
Set the inner radius of a Donut pie.
Set the 3D mode to be Standard or Shadow.
Set the 3D depth of the pie.
Set the 3D viewing angle of the pie.
Set the starting angle of the first sector in the pie and the layout direction for the pie sectors.
Set the starting angle of the first sector in the pie.
Set the layout direction for the pie sectors.
Set the Top and Bottom bounds for the pie sector labels (Side Label Layout only).
Set the Top bound for the pie sector labels (Side Label Layout only).
Set the Bottom bound for the pie sector labels (Side Label Layout only).
Pie Chart Sector Routines
The following routines can be used to create or initialize pie sector specs and set the various sector style attributes.
Initialize a specific pie sector spec.
Add a next pie chart sector spec for the "current" pie chart and optionally sets the corresponding data value and the corresponding Label.
Set the "current" pie chart sector to be a previously initialized pie sector of the "current" chart.
Set the Label of an individual pie sector or the "current" sector.
Set the Position (Normal or Exploded) for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.
Set the Explosion Distance for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.
Set the Shading Method for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.
Set the Edge Color for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.
Set the Edge Width for all pie sectors, a range of pie sectors, an individual pie sector, or the current pie sector.
Pie Chart Sector Label Routines
The following routines can be used to set the various label attributes for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.
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.
Set the Distance between the pie perimeter and the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.
Set the Color of the lines that join the pie sector perimeter with the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.
Set the Width of the lines that join the pie sector perimeter with the pie sector labels for all pie sectors, a range of pie sectors, an individual pie sector, or the "current" pie sector.
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.
Data Routines
Dataset Routines
Initialize a Dataset.
Set the "current" Dataset to be a previously initialized Dataset.
Get the name of the "current" Dataset.
Dataset Point Routines
Add a new Point to the "current" Dataset. Also create a corresponding sector spec for the "current" (pie) chart if one does not exist.
Set the value of the "current" Point in the "current" Dataset.
Text Box Routines
General Text Box Routines
Initialize a Text Object
Set the "current" Text Object to be a previously initialized Text Object.
Get the name of the "current" Text Object.
Set the text of the "current" Text Object.
Font Routines
Set the font name and font index for the "current" Text Object.
Set the font index.
Set the font style (normal, bold, italic) for the "current" Text Object.
Set the font size for the "current" Text Object.
Set the height of the font for the "current" Text Object.
Set the width of the font for the "current" Text Object.
Set the font color for the "current" Text Object.
Text Box Routines
Set the background color for the "current" Text Object.
Set the edge color for the "current" Text Object.
Set the edge effect (Flat, Raised, or Depressed) of the "current" Text Object.
Set the edge width of the "current" Text Object.
Set the corner style (Square or Rounded) of the "current" Text Object.
Set the corner radius' of the "current" Text Object.
Set the radius of the Top Left corner of the "current" Text Object.
Set the radius of the Top Right corner of the "current" Text Object.
Set the radius of the Bottom Right corner of the "current" Text Object.
Set the radius of the Bottom Left corner of the "current" Text Object.
Set the location (x and y) of the "current" Text Object.
Set the x coordinate of the location of the "current" Text Object.
Set the y coordinate of the location of the "current" Text Object.
Set the size (height and width) of the "current" Text Object.
Set the height of the "current" Text Object.
Set the width of the "current" Text Object.
Set the Z Order of the "current" Text Object.
Text Format Routines
Set the maximum size (width and height) of the text that can be displayed in the "current" Text Object.
Set the maximum width (in pixels) of the text that can be displayed in the "current" Text Object.
Set the maximum height (in lines) of the text that can be displayed in the "current" Text Object.
Set the margins for the text in the "current" Text Object.
Set the Left margin for the text in the "current" Text Object.
Set the Right margin for the text in the "current" Text Object.
Set the Top margin for the text in the "current" Text Object.
Set the Bottom margin for the text in the "current" Text Object.
Set the rotation angle for the text in the "current" Text Object.
Set the alignment of the text in the "current" Text Object.
Set the layout direction of the text(horizontal or Vertical) in the "current" Text Object.
Color Routines
Initialize a Color Object.
Set the "current" Color Object to be a previously initialized Color Object.
Get the name of the "current" Color Object.
Clear the "current" Color Object.
Set the color of the "current" Color Object.
Set the individual colors of the "current" Color Object.
Set the Red value of the "current" Color Object.
Set the Green value of the "current" Color Object.
Set the Blue value of the "current" Color Object.
Set the Alpha value of the "current" Color Object.
Set the alpha channel of the "current" Color Object to be Transparent.
Set the alpha channel of the "current" Color Object to be Opaque.
--
SteveFrizzell - 2010-02-14