OpenAPI 1.0

com.aquafold.openapi.chart
Interface AQBIChartProperties


public interface AQBIChartProperties

BIChartProperties

Synopsis:

BIChartProperties contains a set of attributes which control the chart's appearance (chart types, lighting, fonts, colors, ...).

Description:
BIChartProperties provide an interface to query and modify attributes of the chart's appearance.


Method Summary
 String getBackgroundColorBottom()
          Get the String representation of the color used at the bottom of the background gradient
 String getBackgroundColorTop()
          Get the String representation of the color used at the top of the background gradient
 String getChartTypeString(int seriesNumber)
          Get the string name of the chart used to render the specified series.
 String getFont()
          Get the String representation of the Font used to render label text.
 String getFontTitle()
          Get the String representation of the Font used to render title text.
 Integer getImageHeight()
          Get the Chart Image height
 Integer getImageWidth()
          Get the Chart Image Width
 String getLegendPosition()
          Get the Legend position
 String getTheme()
          Get the color theme Color themes control the background gradient colors, the per-series colors and the font colors
 String getTitle()
          Get the Chart title
 String getTitlePosition()
          Get the Chart title position
 boolean isShowLegend()
          Return True if the legend is displayed
 boolean isShowLegendBorder()
          Return True if the legend border is displayed
 void setBackgroundColorBottom(String backgroundColorBottom)
          Set the color used at the bottom of the background gradient
 void setBackgroundColorTop(String backgroundColorTop)
          Set the color used at the top of the background gradient
 void setChartTypeArea()
          Set the chart type for all series to Area
 void setChartTypeBar()
          Set the chart type for all series to Bar
 void setChartTypeBarCluster()
          Set the chart type for all series to Bar Cluster
 void setChartTypeBubble()
          Set the chart type for all series to Bubble
 void setChartTypeCandlestick()
          Set the chart type for all series to Candlestick
 void setChartTypeCloud()
          Set the chart type for all series to Cloud
 void setChartTypeColumn()
          Set the chart type for all series to Column
 void setChartTypeColumnCluster()
          Set the chart type for all series to Column Cluster
 void setChartTypeHighLowClose()
          Set the chart type for all series to High Low Close
 void setChartTypeLine()
          Set the chart type for all series to Line
 void setChartTypeLine3d()
          Set the chart type for all series to Line
 void setChartTypeMap()
          Set the chart type for all series to Map
 void setChartTypePie()
          Set the chart type for all series to Pie
 void setChartTypeScatter()
          Set the chart type for all series to Scatter
 void setChartTypeStacked()
          Set the chart type for all series to Stacked Column
 void setChartTypeStackedArea()
          Set the chart type for all series to Stacked Area
 void setChartTypeStackedBar()
          Set the chart type for all series to Stacked Bar
 void setChartTypeStackedLine()
          Set the chart type for all series to Stacked Line
 void setChartTypeSurface()
          Set the chart type for all series to Surface
 void setFont(String font)
          Set the font used to render label text.
 void setFontTitle(String font)
          Set the font used to render title text.
 void setImageHeight(Integer imageHeight)
          Set the Chart Image Height
 void setImageWidth(Integer imageWidth)
          Set the Chart Image Width
 void setLegendPosition(String position)
          Set the Legend position
 void setLegendPositionBottomCenter()
          Place the Legend in the Bottom Center of the rendering area
 void setLegendPositionBottomLeft()
          Place the Legend in the Bottom Left corner of the rendering area
 void setLegendPositionBottomRight()
          Place the Legend in the Bottom Right corner of the rendering area
 void setLegendPositionLeftCenter()
          Place the Legend in the Left Center of the rendering area
 void setLegendPositionRightCenter()
          Place the Legend in the Right Center of the rendering area
 void setLegendPositionTopCenter()
          Place the Legend in the Top Center of the rendering area
 void setLegendPositionTopLeft()
          Place the Legend in the Top Left corner of the rendering area
 void setLegendPositionTopRight()
          Place the Legend in the Top Right corner of the rendering area
 void setShowLegend(boolean showLegend)
          Set to True if the legend is displayed
 void setShowLegendBorder(boolean showLegendBorder)
          Set to True if the legend border is displayed
 void setTheme(String theme)
          Set the color theme Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeApex()
          Set the color theme to 'Apex' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeAspect()
          Set the color theme to 'Aspect' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeCivic()
          Set the color theme to 'Civic' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeConcourse()
          Set the color theme to 'Concourse' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeDefault()
          Set the color theme to the default Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeEquity()
          Set the color theme to 'Equity' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeFlow()
          Set the color theme to 'Flow' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeFoundry()
          Set the color theme to 'Foundry' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeMedian()
          Set the color theme to 'Median' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeMetro()
          Set the color theme to 'Metro' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeModule()
          Set the color theme to 'Module' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeOpulent()
          Set the color theme to 'Opulent' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeOriel()
          Set the color theme to 'Oriel' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeOrigin()
          Set the color theme to 'Origin' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeSolstice()
          Set the color theme to 'Solstice' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeTechnic()
          Set the color theme to 'Technic' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeTrek()
          Set the color theme to 'Trek' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeUrban()
          Set the color theme to 'Urban' Color themes control the background gradient colors, the per-series colors and the font colors
 void setThemeVerve()
          Set the color theme to 'Verve' Color themes control the background gradient colors, the per-series colors and the font colors
 void setTitle(String title)
          Set the Chart Title
 void setTitlePosition(String titlePosition)
          Set the Title position
 void setTitlePositionBottomCenter()
          Set the Chart Title Position Bottom Center
 void setTitlePositionBottomLeft()
          Set the Chart Title Position Bottom Left
 void setTitlePositionBottomRight()
          Set the Chart Title Position Bottom Right
 void setTitlePositionTopCenter()
          Set the Chart Title Position Top Center
 void setTitlePositionTopLeft()
          Set the Chart Title Position Top Left
 void setTitlePositionTopRight()
          Set the Chart Title Position Top Right
 void setUseLegendMargin(boolean useMargin)
          Set to TRUE if the legend is rendered within a margin
 void setUseTitleMargin(boolean useMargin)
          Set to TRUE if the chart title is rendered within a margin Note: This property is only applicable for 2D charts.
 boolean useLegendMargin()
          Return TRUE if the legend is rendered within a margin
 boolean useTitleMargin()
          Return TRUE if the chart title is rendered within a margin
 

Method Detail

getChartTypeString

String getChartTypeString(int seriesNumber)
Get the string name of the chart used to render the specified series.

Parameters:
seriesNumber - Zero-based series index
Returns:
Chart type of specified series

setChartTypeColumn

void setChartTypeColumn()
Set the chart type for all series to Column

Column charts use the ColumnType property to determine the type of geometric primitive used to render each column.

The Column, Line, Area and Scatter charts can be used to create a combination chart in which each series can have a different chart type. For example, to create a chart with three different chart types for three series of data: properties.setChartTypeArea(0); properties.setChartTypeColumn(1); properties.setChartTypeLine(2);


setChartTypeStacked

void setChartTypeStacked()
Set the chart type for all series to Stacked Column

Stacked Column charts use the ColumnType property to determine the type of geometric primitive used to render each column.

Stacked Column charts are rendered by plotting Column charts for each series and stacking the results.


setChartTypeLine

void setChartTypeLine()
Set the chart type for all series to Line

The width of the lines is specified with the LineWidth property. The line markers are optionally displayed depending on the ShowMarkers property.

The Column, Line, Area and Scatter charts can be used to create a combination chart in which each series can have a different chart type.
For example, to create a chart with three different chart types for three series of data:
properties.setChartTypeArea(0);
properties.setChartTypeColumn(1);
properties.setChartTypeLine(2);


setChartTypeLine3d

void setChartTypeLine3d()
Set the chart type for all series to Line

The line markers are optionally displayed depending on the ShowMarkers property.

The Column, Line, Line3d, Area and Scatter charts can be used to create a combination chart in which each series can have a different chart type.
For example, to create a chart with three different chart types for three series of data:
properties.setChartTypeArea(0);
properties.setChartTypeColumn(1);
properties.setChartTypeLine3d(2);


setChartTypePie

void setChartTypePie()
Set the chart type for all series to Pie

The GroupSmallValues & GroupSmallValuesThreshold properties are used to collect small series values into a single pie slice.

The PieExplode property expands the pie chart radially, preserving the size of the pie slices.

The PieLabelDistance property controls the distance between the labels and the pie slices.


setChartTypeBar

void setChartTypeBar()
Set the chart type for all series to Bar

Bar charts use the ColumnType property to determine the type of geometric primitive used to render each bar.


setChartTypeArea

void setChartTypeArea()
Set the chart type for all series to Area

The Column, Line, Area and Scatter charts can be used to create a combination chart in which each series can have a different chart type.
For example, to create a chart with three different chart types for three series of data:
properties.setChartTypeArea(0);
properties.setChartTypeColumn(1);
properties.setChartTypeLine(2);


setChartTypeScatter

void setChartTypeScatter()
Set the chart type for all series to Scatter

The Column, Line, Area and Scatter charts can be used to create a combination chart in which each series can have a different chart type.
For example, to create a chart with three different chart types for three series of data:
properties.setChartTypeArea(0);
properties.setChartTypeColumn(1);
properties.setChartTypeScatter(2);


setChartTypeBubble

void setChartTypeBubble()
Set the chart type for all series to Bubble

Bubble charts use two series of data to render the bubbles, one series to specify the bubble's position on the y-axis and the other series to specify the bubble's size.

To set the series containing the Position values, use this method:
void setChartSubTypePosition(int seriesNumber);

To set the series containing the Size values, use this method:
setChartSubTypeSize(int seriesNumber);


setChartTypeStackedArea

void setChartTypeStackedArea()
Set the chart type for all series to Stacked Area

Stacked Area charts are rendered by plotting Area charts for each series and stacking the results.


setChartTypeStackedLine

void setChartTypeStackedLine()
Set the chart type for all series to Stacked Line

Stacked Line charts are rendered by plotting Line charts for each series and stacking the results.


setChartTypeStackedBar

void setChartTypeStackedBar()
Set the chart type for all series to Stacked Bar

Stacked Bar charts use the ColumnType property to determine the type of geometric primitive used to render each column.

Stacked Bar charts are rendered by plotting Bar charts for each series and stacking the results.


setChartTypeHighLowClose

void setChartTypeHighLowClose()
Set the chart type for all series to High Low Close

High Low Close charts use three series of data to render, one series to specify the high value, a second series to specify the low value and a third series to specify the closing value.

To set the series containing the High values, use this method:
void setChartSubTypeHigh(int seriesNumber);

To set the series containing the Low values, use this method:
setChartSubTypeLow(int seriesNumber);

To set the series containing the Close values, use this method:
setChartSubTypeClose(int seriesNumber);


setChartTypeCandlestick

void setChartTypeCandlestick()
Set the chart type for all series to Candlestick

High Low Close charts use three series of data to render, one series to specify the high value, a second series to specify the low value and a third series to specify the closing value.

To set the series containing the High values, use this method:
void setChartSubTypeHigh(int seriesNumber);

To set the series containing the Low values, use this method:
setChartSubTypeLow(int seriesNumber);

To set the series containing the Open values, use this method:
setChartSubTypeOpen(int seriesNumber);

To set the series containing the Close values, use this method:
setChartSubTypeClose(int seriesNumber);


setChartTypeCloud

void setChartTypeCloud()
Set the chart type for all series to Cloud


setChartTypeColumnCluster

void setChartTypeColumnCluster()
Set the chart type for all series to Column Cluster

Column Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.


setChartTypeBarCluster

void setChartTypeBarCluster()
Set the chart type for all series to Bar Cluster

Bar Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.


setChartTypeSurface

void setChartTypeSurface()
Set the chart type for all series to Surface

Surface charts render a single continuous surface whose vertex coordinates are determined by the series category position and data value.


setChartTypeMap

void setChartTypeMap()
Set the chart type for all series to Map

Map charts organize a series of data based on the country names or ids specified in the category field of each series value (each row of series data has an associated category).

By default, countries are highlighted using the series color, with brightness based on the magnitude of the total of all series values associated with that country.

Colors can also be assigned to specific ranges of values using these methods:
void setMapRange(String mapRange); // mapRange is a String comma-separated list of values, e.g. "0, 100, 200, 300"
void setMapRangeColors(String mapRangeColors); // mapRangeColors is a String comma-separated list of colors, e.g. "red, #00FF00, blue"

Valid country names or ids include:
ISO country name (e.g. United States, Russia, ...)
FIPS (e.g. US, RS, ...)
GMI (e.g. USA, RUS, ...)
ISO2 (e.g. US, RU, ...)
ISO3 (e.g. USA, RUS, ...)

These country names and ids can be customized using the AQChartModel methods:
void resetCountryNameMap();
void clearCountryNameMap();
void addCountryNameMapping(String defaultCountryName, String newCountryNameMapping);
void removeCountryNameMapping(String countryNameMapping);


getImageWidth

Integer getImageWidth()
Get the Chart Image Width

Returns:
Chart Image Width

setImageWidth

void setImageWidth(Integer imageWidth)
Set the Chart Image Width

Parameters:
imageWidth - Width of Image, or null (to use the width of rendering surface)

getImageHeight

Integer getImageHeight()
Get the Chart Image height

Returns:
Image height

setImageHeight

void setImageHeight(Integer imageHeight)
Set the Chart Image Height

Parameters:
imageHeight - Height of Image, or null (to use the height of rendering surface)

useLegendMargin

boolean useLegendMargin()
Return TRUE if the legend is rendered within a margin

Returns:
TRUE if the legend is rendered within a margin

setUseLegendMargin

void setUseLegendMargin(boolean useMargin)
Set to TRUE if the legend is rendered within a margin

Parameters:
useMargin - set to TRUE if the legend is rendered within a margin

useTitleMargin

boolean useTitleMargin()
Return TRUE if the chart title is rendered within a margin

Returns:
TRUE if the chart title is rendered within a margin

setUseTitleMargin

void setUseTitleMargin(boolean useMargin)
Set to TRUE if the chart title is rendered within a margin Note: This property is only applicable for 2D charts.

Parameters:
useMargin - set to TRUE if the chart title is rendered within a margin

getFont

String getFont()
Get the String representation of the Font used to render label text.

Returns:
String representation of the Font used to render label text.

setFont

void setFont(String font)
Set the font used to render label text.

For example:
setFont("ARIAL-BOLD-10")

Parameters:
font - String representation of the font used to render label text.

getFontTitle

String getFontTitle()
Get the String representation of the Font used to render title text.

Returns:
String representation of the Font used to render title text.

setFontTitle

void setFontTitle(String font)
Set the font used to render title text.

For example:
setFont("ARIAL-BOLD-10")

Parameters:
font - String representation of the font used to render title text.

getBackgroundColorTop

String getBackgroundColorTop()
Get the String representation of the color used at the top of the background gradient

For example:
"#FFFFFF" = white

Returns:
String representation of the color used at the top of the background gradient

setBackgroundColorTop

void setBackgroundColorTop(String backgroundColorTop)
Set the color used at the top of the background gradient

For example:
"#FFFFFF" = white

Parameters:
backgroundColorTop - String representation of the color used at the top of the background gradient

getBackgroundColorBottom

String getBackgroundColorBottom()
Get the String representation of the color used at the bottom of the background gradient

For example:
"#FFFFFF" = white

Returns:
String representation of the color used at the bottom of the background gradient

setBackgroundColorBottom

void setBackgroundColorBottom(String backgroundColorBottom)
Set the color used at the bottom of the background gradient

For example:
"#FFFFFF" = white

Parameters:
backgroundColorBottom - String representation of the color used at the bottom of the background gradient

isShowLegend

boolean isShowLegend()
Return True if the legend is displayed

Returns:
True if the legend is displayed

setShowLegend

void setShowLegend(boolean showLegend)
Set to True if the legend is displayed

Parameters:
showLegend - True if the legend is displayed

isShowLegendBorder

boolean isShowLegendBorder()
Return True if the legend border is displayed

Returns:
True if the legend border is displayed

setShowLegendBorder

void setShowLegendBorder(boolean showLegendBorder)
Set to True if the legend border is displayed

Parameters:
showLegendBorder - True if the legend border is displayed

getLegendPosition

String getLegendPosition()
Get the Legend position

For example:
"Top Left", "Top Right", "Bottom Left", "Bottom Right"

Returns:
Legend position

setLegendPosition

void setLegendPosition(String position)
Set the Legend position

For example:
"Top Left", "Top Right", "Bottom Left", "Bottom Right"

Parameters:
position - Legend position

setLegendPositionTopLeft

void setLegendPositionTopLeft()
Place the Legend in the Top Left corner of the rendering area


setLegendPositionTopCenter

void setLegendPositionTopCenter()
Place the Legend in the Top Center of the rendering area


setLegendPositionTopRight

void setLegendPositionTopRight()
Place the Legend in the Top Right corner of the rendering area


setLegendPositionLeftCenter

void setLegendPositionLeftCenter()
Place the Legend in the Left Center of the rendering area


setLegendPositionRightCenter

void setLegendPositionRightCenter()
Place the Legend in the Right Center of the rendering area


setLegendPositionBottomLeft

void setLegendPositionBottomLeft()
Place the Legend in the Bottom Left corner of the rendering area


setLegendPositionBottomCenter

void setLegendPositionBottomCenter()
Place the Legend in the Bottom Center of the rendering area


setLegendPositionBottomRight

void setLegendPositionBottomRight()
Place the Legend in the Bottom Right corner of the rendering area


getTitle

String getTitle()
Get the Chart title

Returns:
Chart title

setTitle

void setTitle(String title)
Set the Chart Title

Parameters:
title - Chart Title

getTitlePosition

String getTitlePosition()
Get the Chart title position

Returns:
Chart title position

setTitlePosition

void setTitlePosition(String titlePosition)
Set the Title position

For example:
"Top Left", "Top Center", "Top Right", "Left Center", "Right Center", "Bottom Left", "Bottom Center", "Bottom Right"

Parameters:
titlePosition - Title position

setTitlePositionTopLeft

void setTitlePositionTopLeft()
Set the Chart Title Position Top Left


setTitlePositionTopCenter

void setTitlePositionTopCenter()
Set the Chart Title Position Top Center


setTitlePositionTopRight

void setTitlePositionTopRight()
Set the Chart Title Position Top Right


setTitlePositionBottomLeft

void setTitlePositionBottomLeft()
Set the Chart Title Position Bottom Left


setTitlePositionBottomCenter

void setTitlePositionBottomCenter()
Set the Chart Title Position Bottom Center


setTitlePositionBottomRight

void setTitlePositionBottomRight()
Set the Chart Title Position Bottom Right


getTheme

String getTheme()
Get the color theme Color themes control the background gradient colors, the per-series colors and the font colors


setTheme

void setTheme(String theme)
Set the color theme Color themes control the background gradient colors, the per-series colors and the font colors

Parameters:
theme -

setThemeDefault

void setThemeDefault()
Set the color theme to the default Color themes control the background gradient colors, the per-series colors and the font colors


setThemeVerve

void setThemeVerve()
Set the color theme to 'Verve' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeTrek

void setThemeTrek()
Set the color theme to 'Trek' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeUrban

void setThemeUrban()
Set the color theme to 'Urban' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeTechnic

void setThemeTechnic()
Set the color theme to 'Technic' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeSolstice

void setThemeSolstice()
Set the color theme to 'Solstice' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeOrigin

void setThemeOrigin()
Set the color theme to 'Origin' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeOriel

void setThemeOriel()
Set the color theme to 'Oriel' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeOpulent

void setThemeOpulent()
Set the color theme to 'Opulent' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeModule

void setThemeModule()
Set the color theme to 'Module' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeMetro

void setThemeMetro()
Set the color theme to 'Metro' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeMedian

void setThemeMedian()
Set the color theme to 'Median' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeFoundry

void setThemeFoundry()
Set the color theme to 'Foundry' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeFlow

void setThemeFlow()
Set the color theme to 'Flow' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeEquity

void setThemeEquity()
Set the color theme to 'Equity' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeConcourse

void setThemeConcourse()
Set the color theme to 'Concourse' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeCivic

void setThemeCivic()
Set the color theme to 'Civic' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeAspect

void setThemeAspect()
Set the color theme to 'Aspect' Color themes control the background gradient colors, the per-series colors and the font colors


setThemeApex

void setThemeApex()
Set the color theme to 'Apex' Color themes control the background gradient colors, the per-series colors and the font colors


OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.