Difference: CDChartDirectorDesignerAPI (106 vs. 107)

Revision 1072011-11-24 - JeanNeron

 			 META TOPICPARENT 
			 name="APPX510Features" 
		
 Chart Director API for APPX
- META TOPICPARENT
+ name="APPX510Features"
  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
->
>
+ 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.
 Using the API
->
>
+ Data Routines
-<
<
+There are some key concepts you should understand before using the Chart Design subroutines.
 Designing a Chart
->
>
+ Text Object Routines
-<
<
+Chart design is accomplished by calling the appropriate Chart Design subroutines in the appropriate sequence to create a chart specification.
 Defining a Dataset
->
>
+ Color Routines
-<
<
+Datasets are defined by calling the appropriate Dataset Design subroutines in the appropriate sequence to create a dataset definition.
 Rendering a Chart
->
>
+ Base Chart Routines
-<
<
+A chart is rendered by calling the Chart Render subroutine for a chart specification and its associated dataset definition(s).
 Base Chart Routines 
 Base Chart Routines - General 
 .CHART INITIALIZE 

Initialize a chart.
 .CHART RENDER 

Render the "current" chart.
 .CHART SET CURRENT 

Set the "current" chart to be a previously initialized chart.
 .CHART GET NAME 

Get the name of 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.
 Base Chart Routines - Background 
 .CHART SET BG SIZE 

Set the size (height and width) of the "current" chart.
 .CHART SET BG SIZE:H 

Set the height of the "current" chart.
 .CHART SET BG SIZE:W 

Set the width of the "current" chart.
 .CHART SET BG COLOR 

Set the background color of the "current" chart to the "current" color.
 .CHART SET BG WALLPAPR 

Set the pathname of a wallpaper image that is to be tiled within the background area of the "current" chart.
 .CHART SET BG IMAGE 

Set the pathname of an image file that is to be positioned within the background area of the "current" chart.
 Base Chart Routines - Edge Options 
 .CHART SET EDGE COLOR 

Set the edge color of the "current" chart.
 .CHART SET EDGE EFFECT 

Set the edge effect of the "current" chart.
 .CHART SET EDGE WIDTH 

Set the edge width of the "current" chart. Used in conjunction with Edge Effect.
 Base Chart Routines - Corner Options 
 .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:TL 

Set the radius of the Top Left corner of the "current" chart.
 .CHART SET CNR R:TR 

Set the radius of the Top Right corner of the "current" chart.
 .CHART SET CNR R:BR 

Set the radius of the Bottom Right corner of the "current" chart.
 .CHART SET CNR R:BL 

Set the radius of the Bottom Left corner of the "current" chart.
 .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 

Set the Drop Shadow Effect to be On or Off for the "current" chart.
 .CHART SET DS COLOR 

Set the Color of the Drop Shadow Effect for the "current" chart.
 .CHART SET DS LOC 

Set the X and Y coordinates of the offset of the Drop Shadow Effect for the "current" chart.
 .CHART SET DS LOC:X 

Set the X coordinate of the offset of the Drop Shadow Effect for the "current" chart.
 .CHART SET DS LOC:Y 

Set the Y coordinate of the offset of the Drop Shadow Effect for the "current" chart.
 .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 

Set the Transparency Type for the "current" chart.
 .CHART SET TRANS COLOR 

Set the Transparency Color for the "Current" chart. This field is usually set in conjunction with the "Single Color" Transparency Type.
 .CHART SET SHAPE AA 

Set the Shape Anti-Alias to be On or Off for the "current" chart.
 .CHART SET TXT AA MODE 

Set the Text Anti-Alias Mode for the "current" chart.
 Not Yet Implemented 
 .CHART ADD TO MULTI 

Add the "current" chart object to the specified Multi-Chart.
 .CHART ADD EM CHART 

Add the specified chart object to the "current" Multi-Chart.
 Base Chart Routines - Legend Box 
 .LEGEND SET TEMPLATE 

Set the template of the legend text for the "current" Legend Box.
 .LEGEND SET KEY LAYOUT 

Set the Layout Method for the Legend Keys for the "current" Legend Box.
 .LEGEND SET KEY COLS 

Set the number of columns to be used with the "Columnar" Key Layout Method for the "current" Legend Box.
 .LEGEND SET KEY ORDER 

Set the key order to be ascending or descending for the "current" Legend Box.
 .LEGEND SET ICON SZ 

Set the width and height of the legend key icons for the "current" Legend Box.
 .LEGEND SET ICON SZ:W 

Set the width of the legend key icons for the "current" Legend Box.
 .LEGEND SET ICON SZ:H 

Set the height of the legend key icons for the "current" Legend Box.
 .LEGEND SET ICON GAP 

Set the distance between the Legend icon and the Legend text.
 .LEGEND SET KEY GAP 

Set the horizontal gap between two legend entries for horizontal legend layout and the vertical gap (line spacing) between the legend keys for the "current" Legend Box.
 .LEGEND SET KEY GAP:H 

Set the horizontal gap between two legend entries for horizontal legend layout for the "current" Legend Box.
 .LEGEND SET KEY GAP:V 

Set the vertical gap (line spacing) between the legend keys of the "current" Legend Box.
 .LEGEND SET ICON E CLR 

Set the edge color for the key icons for the "current" Legend Box. Applies only to rectangular icons.
 .LEGEND SET ICON E EFF 

Set the edge effect for the key icons for the "current" Legend Box. Applies only to rectangular icons.
 .LEGEND SET ICON E W 

Set the edge width for the key icons for the "current" Legend Box. Used in conjunction with Edge Effect.
 .LEGEND SET KEY STYLE 

Set the key style for the "current" Legend Box.
 Base Chart Routines - Legend Box Keys 
 .LEGEND KEY ADD NEXT 

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

Initialize a legend box key at the specified position for 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 Chart Routines
->
>
+ Pie Chart Routines 
 Pie Chart Routines
  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.
-<
<
+ Data Routines 
 Dataset Routines 
 .DATASET INITIALIZE 

Initialize a Dataset.
 .DATASET SET CURRENT 

Set the "current" Dataset to be a previously initialized Dataset.
 .DATASET GET NAME 

Get the name of the "current" Dataset.

.LAYER ADD DATA GROUP

Adds a data group to the current chart layer

.LAYER ADD DATASET

Adds a dataset template to the current data group

.LAYER LINK DATASET

Links a set of data points to a dataset template.
 Dataset Point Routines 
 .POINT ADD NEW 

Add a new Point to the "current" Dataset.
 .POINT SET VALUE 

Set the value of the "current" Point in the "current" Dataset.
 Text Box Routines 
 General Text Box Routines 
 .TEXT INITIALIZE 

Initialize a Text Object
 .TEXT SET CURRENT 

Set the "current" Text Object to be a previously initialized Text Object.
 .TEXT GET NAME 

Get the name of the "current" Text Object.
 .TEXT SET TEXT 

Set the text of the "current" Text Object.
 Font Routines 
 .TEXT SET FONT NAME 

Set the font name and font index for the "current" Text Object.
 .TEXT SET FONT INDEX 

Set the font index.
 .TEXT SET FONT STYLE 

Set the font style (normal, bold, italic) for the "current" Text Object.
 .TEXT SET FONT SZ 

Set the font size for the "current" Text Object.
 .TEXT SET FONT SZ:H 

Set the height of the font for the "current" Text Object.
 .TEXT SET FONT SZ:W 

Set the width of the font for the "current" Text Object.
 .TEXT SET FONT CLR 

Set the font color for the "current" Text Object.
 Text Box Routines 
 .TEXT SET BX BG CLR 

Set the background color for the "current" Text Object.
 .TEXT SET BX EDGE CLR 

Set the edge color for the "current" Text Object.
 .TEXT SET BX EDGE EFF 

Set the edge effect (Flat, Raised, or Depressed) of the "current" Text Object.
 .TEXT SET BX EDGE W 

Set the edge width of the "current" Text Object.
 .TEXT SET BX CNR STYLE 

Set the corner style (Square or Rounded) of the "current" Text Object.
 .TEXT SET BX CNR R 

Set the corner radius of the "current" Text Object.
 .TEXT SET BX CNR R:TL 

Set the radius of the Top Left corner of the "current" Text Object.
 .TEXT SET BX CNR R:TR 

Set the radius of the Top Right corner of the "current" Text Object.
 .TEXT SET BX CNR R:BR 

Set the radius of the Bottom Right corner of the "current" Text Object.
 .TEXT SET BX CNR R:BL 

Set the radius of the Bottom Left corner of the "current" Text Object.
 .TEXT SET BX LOC 

Set the offset (x and y) of the "current" Text Object.
 .TEXT SET BX LOC:X 

Set the x offset of the "current" Text Object.
 .TEXT SET BX LOC:Y 

Set the y offset of the "current" Text Object.
 .TEXT SET BX SZ 

Set the size (height and width) of the "current" Text Object.
 .TEXT SET BX SZ:H 

Set the height of the "current" Text Object.
 .TEXT SET BX SZ:W 

Set the width of the "current" Text Object.
 .TEXT SET BX Z ORDER 

Set the Z Order of the "current" Text Object.
 Text Format Routines 
 .TEXT SET TXT MAX SZ 

Set the maximum size (width and height) of the text that can be displayed in the "current" Text Object.
 .TEXT SET TXT MAX SZ:W 

Set the maximum width (in pixels) of the text that can be displayed in the "current" Text Object.
 .TEXT SET TXT MAX SZ:H 

Set the maximum height (in lines) of the text that can be displayed in the "current" Text Object.
 .TEXT SET TXT MARGIN 

Set the margins for the text in the "current" Text Object.
 .TEXT SET TXT MARGIN:L 

Set the Left margin for the text in the "current" Text Object.
 .TEXT SET TXT MARGIN:R 

Set the Right margin for the text in the "current" Text Object.
 .TEXT SET TXT MARGIN:T 

Set the Top margin for the text in the "current" Text Object.
 .TEXT SET TXT MARGIN:B 

Set the Bottom margin for the text in the "current" Text Object.
 .TEXT SET TXT ROTATION 

Set the rotation angle for the text in the "current" Text Object.
 .TEXT SET TXT ALIGN 

Set the alignment of the text in the "current" Text Object.
 .TEXT SET TXT LAYOUT 

Set the layout direction of the text(horizontal or Vertical) in the "current" Text Object.
 Color Routines 
 .COLOR INITIALIZE 

Initialize a Color Object.
 .COLOR SET CURRENT 

Set the "current" Color Object to be a previously initialized Color Object.
 .COLOR GET NAME 

Get the name of the "current" Color Object.
 .COLOR SET DEFAULT 

Clear the "current" Color Object.
 .COLOR SET COLOR 

Set the color of the "current" Color Object.
 .COLOR SET COLOR:RGB 

Set the individual colors of the "current" Color Object.
 .COLOR SET COLOR:R 

Set the Red value of the "current" Color Object.
 .COLOR SET COLOR:G 

Set the Green value of the "current" Color Object.
 .COLOR SET COLOR:B 

Set the Blue value of the "current" Color Object.
 .COLOR SET COLOR:A 

Set the Alpha value of the "current" Color Object.
 .COLOR SET TRANSPARENT 

Set the "current" Color Object to be Transparent.
 .COLOR SET OPAQUE 

Set the "current" Color Object to be Opaque.
 .COLOR SET METAL 

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

Sets the color of the "current" Color Object to be Yellow (FFEE44) and sets the direction for brightness modulation to create a Gold Metal color effect.
 .COLOR SET SILVER 

Sets the color of the "current" Color Object to be Grey (DDDDDD) and sets the direction for brightness modulation to create a Silver Metal color effect.
 .COLOR SET BRUSH METAL 

Set the strength of the texture to create a Brushed Metal Effect for the "current" Color Object.
 .COLOR SET BRIGHTNESS 

Set the brightness of the "current" Color Object.
 .COLOR SET HALF COLOR 

Set the intensity of the "current" Color Object to be one half of the normal intensity.
 .COLOR SET DASH LINE 

Set the dash line pattern for the "current" Color Object.
  Shape Routines 
 .SHAPE INITIALIZE

View topic | History: r114 < r113 < r112 < r111 | More topic actions...