Chart parameters available to different chart types.

Obj.dbMagicLayout="(;,#~|)ID; CHART_Index, Codebase, Width, Height, Start, Interval, Stop; ChartDataSet; DataSetMagicMacro; PARAMS"

CHART_Index (Index = 1 to 31)

Index	Type	Example
1	areaApp
2	barApp
3	barLineApp
4	barAreaApp
5	columnApp
6	dateAreaApp
7	dateLineApp
8	disLineApp
9	finComboApp
10	hHiLoBarApp
11	hiLoBarApp
12	hiLoCloseApp
13	hSpeedoApp
14	hyperBar
15	hyperColumn
16	hyperPie
17	indBarApp
18	indColumnApp
19	labelLineApp
20	lineApp
21	pieApp
22	polarApp
23	regressApp
24	scrollingLine
25	speedoApp
26	spinningPie
27	stackBarApp
28	stackColumnApp
29	stickApp
30	zoomLine
31	bubbleApp

The following parameters are shared by the entire applet collections, and are related to general charting features. This table and those that follow use these conventions for describing the kind of argument each parameter requires:

• anything
  • anything goes here. Really. These parameters are usually for turning something on or off, so for clarity's sake you might want to use something like PARAM name=legendOn value="true"

• String
  • This is a word or phrase, like "My Title"
   
• color
  • this field expects a color name, or a hexadecimal color definition (in RGB). Valid colors in these applets include black, white, gray, darkGray, lightGray, red, pink, orange, yellow, green, magenta, cyan, and blue. A valid hex definition for white is "ffffff"

• font
  • font parameters include information for the font name, the font size, and the font style. Any valid Java font works here, but we start with a default of TimesRoman 12pt in most cases to ensure that the font is available. A font parameter looks like this: param name=xAxisLabelFont value="Arial,18,2". This instructs KavaChart to use 18 point Arial italic fonts for this chart's X axis labels. 0 is plain, 1 bold, and 2 italic.

• integer
  • this parameter requires an number, generally a number between 0 and 1. The applets use these to describe percentages, e.g. .5 = 50%

• double
  • this parameter requires an number, generally a number between 0 and 1. The applets use these to describe percentages, e.g. .5 = 50%

• list
  • a few parameters require a list of arguments. These include things like axis labels and data values, but they also include lists of axis options.

Parameters Skipping

Single parameters can be skipped by either leave a blank. Multiple sequential parameters can be skipped by issuing a carat (^) followed by a number (n) where n is the number of parameters to be skipped. For example, the following are identical.

legend=Ture|||||0.0|0.0
legend=Ture|^4|0.0|0.0

General Parameters

Syntax: Title=titleString|titleFont|titleColor|subTitleString|subTitleFont|subTitleColor
Syntax: Legend=LegendOn|LegendColor|legendHorizontal|legendLabelFont|legendLabelColor|legendllX|legendllY
Syntax: Icon=iconWidth|iconHeight|iconGap
Syntax: Plotarea=PlotAreaTop|PlotAreaBottom|PlotAreaLeft|PlotAreaRight|PlotAreaColor
Syntax: Effect=delimiter|defaultFont|3D|BackGroundColor|xDepth|yDepth|backgroundImage|locale
Syntax: Dwell=dwellLabelsOn| dwellUseLabelString| dwellUseXValue| dwellUseYValue| dwellXString| dwellYString| dwellLabelPrecision| dwellLabelFormat

Bubble Chart Specific Parameters

Syntax: BubbleChart=setZScale | zAutoScaleOff | maxDiameter | fillBubbles | crossAxes | xCrossVal | yCrossVal

Bubble Chart - Step by Step

You must be in the maintenance program in order to get updated files. Check the date of the Designer2002.exe and ASPdbGold.DLL. They must be after 01/14/02. You should also either received or downloaded the new set of  2002 Jar files or at least the bubbleApp.jar file is in the Jars directory. Do not over write your Jars directory with the new files. Rename it to Jars01 and the create a new Jar directory for the new files. Fire up the designer and goto the Chart Form. In the General Tab - Chose Chart Type=31.  Title=Bubble Chart Title Font=TimesRoman,12,0 and change the 12 to 20 User Data=Checked; Test Chart=Checked Set #=0;  DataSet Param=Name; User Data=DotNet Set #=0;  DataSet Param=xValues; User Data=-1,0,1 Set #=0;  DataSet Param=yValues; User Data=234,345,-500 Set #=0;  DataSet Param=y2Values; User Data=100,200,300 Set #=0;  DataSet Param=Links; User Data=http://www.usintertech.com,http://www.usintertech.com,http://www.usintertech.com Set #=1;  DataSet Param=Name; User Data=ASP-db Set #=1;  DataSet Param=xValues; User Data=-1.5,0.2,1.2 Set #=1;  DataSet Param=yValues; User Data=321,432,456 Set #=1;  DataSet Param=y2Values; User Data=100,200,300 Set #=1;  DataSet Param=Links; User Data=http://www.aspdb.com,http://www.aspdb.com,http://www.aspdb.com In the Charts Tab - Take the defaults for Bubble Chart Dwell - UseXValue=Uncheck USeYValue=Uncheck; Use Label String=Checked PlotArea - Color=Cyan Legend - Legend On=checked In Axes - effect tab - ChartBGColor=green. The above settngs will produce the bubble chart on the left.

Line and Regression Chart Specific Parameters

Syntax: LineChart=plotLinesOff| dataset0Image| labelsOn| labelAngle| labelFormat| labelPrecision| dataset0URLLabels

Finance Chart (finCombo) Specific Parameters

Note: This chart extends DateLineChart functionality, and includes other parameters specific to Date axes. This chart takes it's data from a single file. The first column in the file contains dates. Additional columns are processed as follows: Line and Stick consume one column each, HLOC consumes 3 columns. BarLine Chart (baeLine) Specific Parameters

Note: This chart extends LabelLineChart functionality, and includes other parameters specific to both labelLineApp and barApp.

BarArea Chart (barArea) Specific Parameters

Note: This chart extends AreaChart functionality, and includes other parameters specific to both areaApp and barApp.

Bar Chart Specific Parameters

The following table contains parameters that can be used with any kind of bar or column chart. These include bar, column, indBar, indColumn, stackBar, and stackColumn

Syntax: Bar=barLabelsOn|barBaseline|barClusterWidth|barLabelAngle|labelFormat|labelPrecision

Pie Chart Specific Parameters

The following table contains parameters only used by pie charts. Other chart types ignore these parameters. Note: Pie Charts use the "|" character in a data label to break a label into more than one line. This feature is unique to PieCharts

Syntax: Pie=explodeSlice| textLabelsOn| valueLabelsOn| percentLabelsOff| labelPosition| labelFormat| labelPrecision| startDegrees| xLoc| yLoc| pieWidth| pieHeight| labelColor| labelFont

Speedo Chart Specific Parameters

Speedo charts have adjustable axis locations and styles, as well as adjustable needle styles. This applet can be particularly useful in conjunction with an image background to superimpose a dial and needle on a scanned image of a physical gauge. The following table contains parameters only used by speedo charts. Other chart types ignore these parameters. This chart draws only the first value of dataset 0. HSpeedoApp adds a "high-water mark" to show where the maximum value of the gauge was.

Syntax: Speedo=needleStyle|speedoPosition|labelsOutside|watermarkColor

Polar Chart Specific Parameters

The following table contains parameters only used by polar charts. Other chart types ignore these parameters

Syntax: Polar=manualSpoking|numSpokes

Axis Parameters (X, Y, aux)

If you're modifying an X Axis (usually on the top or bottom of a chart), use xAxisParameterName instead of yAxisParameterName. X Axes are on the left and right for Horizontal Bar Type charts. X axes can be on the top or bottom of a chart. Speedo and Polar charts have a single Axis, which is a Y Axis.

If you're modifying an Auxiliary Y Axis (charts that have left and right axes, for example), use auxAxisParameterName instead of yAxisParameterName.

Syntax: Yaxis=yAxisTitle| yAxisTitleFont| yAxisTitleColor| yAxisLabels| yAxisLabelFont| yAxisLabelColor| yAxisLabelAngle| yAxisLabelFormat| yAxisLabelPrecision| yAxisLineColor| yAxisTickColor| yAxisGridColor| yAxisColor| yAxisTickLength| yAxisMinTickLength| yAxisStart| yAxisEnd| yAxisLabelCount| yAxisTickCount| yAxisMinTickCount| yAxisGridTickCount

Axis Option Lists

The following lists include various options for adjusting the look of an X or Y axis. Use these parameters in a list.

Syntax: Xaxisoption=noautoScale,rotateTitle, logScaling, lineOff, tickOff, minTickOn, labelsOff, gridOn ,topAxis

Syntax: Yaxisoption=noautoScale, rotateTitle, logScaling, lineOff, tickOff, minTickOn, labelsOff, gridOn , rightAxis

Example: xAxisOptions=gridOff,tickOff,lineOn

Dataset Specification

Datasets can vary a great deal from chart to chart. Some kinds of charts only use Y values, others use both X and Y values. Some charts use a color to represent an entire dataset (bar charts, line graphs), and some use a color for each data value (pie charts, individual bar charts). In general, every chart must define a list of numbers for Y data. Charts that don't define this data will use an internally generated fake dataset, which is pretty useless. For additional ways to define data, see the table on URL datasets. The code column is an abbreviated substitute for the dataset names (lists) for quick entry.The formatis XX## where XX is a two character code and ## is a two digit dataset number.

Syntax: Dataset=set|dataset?xValues|dataset?yValues|dataset?y2Values|dataset?xyValues| dataset?dateValues|dataset?Name|dataset?Labels|dataset?Color|dataset?Colors| 
dataset?Image|dataset?LineWidth|dataset?LabelFont|dataset?LabelColor|dataset?Links| dataset?xURL|dataset?yURL|dataset?Type|dataset?URLLabels

X.dbMagicLayout="(;,#~|)2;CHART_24,http://localhost,300,300,1,1;LB00~YV00; #0#~#1#;Title=NorthWind Products Unit Price|Arial,12,5~Legend=True|^4|0.0|0.0|0.03|0.04~Effect=^2|True~Pie=^2|True||1|^3|0.6|0.6|0.5|0.5"

is equivalent to

X.dbMagicLayout="(;,#~|)2;CHART_24,http://localhost,300,300,1,1;dataset0Labels~dataset0yValues; #0#~#1#;Title=NorthWind Products Unit Price|Arial,12,5~Legend=True|^4|0.0|0.0|0.03|0.04~Effect=^2|True~Pie=^2|True||1|^3|0.6|0.6|0.5|0.5"

• ?=set number (0 to 39) e.g.dataset0xValues, dataset39xValues
• If set="" then set=0
• Repeat this parameter fo rmultiple data sets

URL Dataset Parameters

Data URLs can be files, but more often, they point to CGIs or ASPs that generate data dynamically. This mechanism lets you keep your overall chart definition unchanged while modifying the data to meet your requirements.

Applets can also use the networkInterval parameter to re-read data from the URL, updating the chart as necessary.

Syntax: URLdata=URLDataBlock|URLXYDataRows|URLXYDataColumns|networkInterval|customDatasetHandler

Date Chart Parameters

The following list contains general charting options for Time/Date X axes, such as those used for dateLineApp.class and dateAreaApp.class, as well as financial chart types like stickApp.class and hiLoCloseApp.class.

Syntax: DateParams=startData|endData|inputDateFormat|incrementalDataURL

Parameter	Type	Effect
startData	String	Ignore any data earlier than this time/date. Note: this string is passed into Java's "Date" class to be translated into a machine independent time stamp. Many time-stamp formats will work. If you need to use a specific input format, see the Date Format section below.
endData	String	Ignore any data later than this time/date. Note: this string is passed into Java's "Date" class to be translated into a machine independent time stamp. Many time-stamp formats will work. If you need to use a specific input format, see the Date Format section below.
inputDateFormat	String	Use this pattern to read any incoming data. For more information on how to construct this string, see the Date Format section below.
incrementalDataURL	URL	A URL to poll for additional data points. Date oriented charts read initial data from the URL or file specified in "customDatasetHandler". Subsequent observations can be added to applets by polling the URL specified in this parameter. This URL will be checked each networkInterval.

Date Axis Parameters

Syntax: DateAxis=startDate|endDate|axisDateFormat|axisSecondaryDateFormat|scalingType

Date Format Patterns

The actual string values for each format are determined by locale and the time being formatted.
 

Active Applet Parameters

This is a collection of parameters for the various active Chart applets. Line oriented applets also take all Line parameters, Bar applets take Bar parameters, and so on.

Syntax: Active=scrollWindows|dataset0Links|backgroundImage

Example: Active=|Drill.asp?X=Frank,Drill.asp?X=Polly,C42_Drill.asp?X=Ivy,C42_Drill.asp?X=Irene