|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQBIChartProperties
BIChartProperties
Synopsis: BIChartProperties contains a set of attributes which control the chart's appearance (chart types, lighting, fonts, colors, ...). Description:
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 |
---|
String getChartTypeString(int seriesNumber)
seriesNumber
- Zero-based series index
void setChartTypeColumn()
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);
void setChartTypeStacked()
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.
void setChartTypeLine()
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);
void setChartTypeLine3d()
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);
void setChartTypePie()
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.
void setChartTypeBar()
Bar charts use the ColumnType property to determine the type of geometric primitive used to render each bar.
void setChartTypeArea()
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);
void setChartTypeScatter()
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);
void setChartTypeBubble()
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);
void setChartTypeStackedArea()
Stacked Area charts are rendered by plotting Area charts for each series and stacking the results.
void setChartTypeStackedLine()
Stacked Line charts are rendered by plotting Line charts for each series and stacking the results.
void setChartTypeStackedBar()
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.
void setChartTypeHighLowClose()
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);
void setChartTypeCandlestick()
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);
void setChartTypeCloud()
void setChartTypeColumnCluster()
Column Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.
void setChartTypeBarCluster()
Bar Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.
void setChartTypeSurface()
Surface charts render a single continuous surface whose vertex coordinates are determined by the series category position and data value.
void setChartTypeMap()
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);
Integer getImageWidth()
void setImageWidth(Integer imageWidth)
imageWidth
- Width of Image, or null (to use the width of rendering surface)Integer getImageHeight()
void setImageHeight(Integer imageHeight)
imageHeight
- Height of Image, or null (to use the height of rendering surface)boolean useLegendMargin()
void setUseLegendMargin(boolean useMargin)
useMargin
- set to TRUE if the legend is rendered within a marginboolean useTitleMargin()
void setUseTitleMargin(boolean useMargin)
useMargin
- set to TRUE if the chart title is rendered within a marginString getFont()
void setFont(String font)
For example:
setFont("ARIAL-BOLD-10")
font
- String representation of the font used to render label text.String getFontTitle()
void setFontTitle(String font)
For example:
setFont("ARIAL-BOLD-10")
font
- String representation of the font used to render title text.String getBackgroundColorTop()
For example:
"#FFFFFF" = white
void setBackgroundColorTop(String backgroundColorTop)
For example:
"#FFFFFF" = white
backgroundColorTop
- String representation of the color used at the top of the background gradientString getBackgroundColorBottom()
For example:
"#FFFFFF" = white
void setBackgroundColorBottom(String backgroundColorBottom)
For example:
"#FFFFFF" = white
backgroundColorBottom
- String representation of the color used at the bottom of the background gradientboolean isShowLegend()
void setShowLegend(boolean showLegend)
showLegend
- True if the legend is displayedboolean isShowLegendBorder()
void setShowLegendBorder(boolean showLegendBorder)
showLegendBorder
- True if the legend border is displayedString getLegendPosition()
For example:
"Top Left", "Top Right", "Bottom Left", "Bottom Right"
void setLegendPosition(String position)
For example:
"Top Left", "Top Right", "Bottom Left", "Bottom Right"
position
- Legend positionvoid setLegendPositionTopLeft()
void setLegendPositionTopCenter()
void setLegendPositionTopRight()
void setLegendPositionLeftCenter()
void setLegendPositionRightCenter()
void setLegendPositionBottomLeft()
void setLegendPositionBottomCenter()
void setLegendPositionBottomRight()
String getTitle()
void setTitle(String title)
title
- Chart TitleString getTitlePosition()
void setTitlePosition(String titlePosition)
For example:
"Top Left", "Top Center", "Top Right", "Left Center", "Right Center", "Bottom Left", "Bottom Center", "Bottom Right"
titlePosition
- Title positionvoid setTitlePositionTopLeft()
void setTitlePositionTopCenter()
void setTitlePositionTopRight()
void setTitlePositionBottomLeft()
void setTitlePositionBottomCenter()
void setTitlePositionBottomRight()
String getTheme()
void setTheme(String theme)
theme
- void setThemeDefault()
void setThemeVerve()
void setThemeTrek()
void setThemeUrban()
void setThemeTechnic()
void setThemeSolstice()
void setThemeOrigin()
void setThemeOriel()
void setThemeOpulent()
void setThemeModule()
void setThemeMetro()
void setThemeMedian()
void setThemeFoundry()
void setThemeFlow()
void setThemeEquity()
void setThemeConcourse()
void setThemeCivic()
void setThemeAspect()
void setThemeApex()
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |