|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQChartProperties
ChartProperties
Synopsis: ChartProperties contains a set of attributes which control the chart's appearance (chart types, lighting, fonts, colors, camera pan & zoom, ...). Description:
Method Summary | |
---|---|
void |
addFunctionSeries()
Add a series of data generated by a function |
void |
addFunctionSeries(String functionString)
Add a series of data generated by a function. |
void |
copy(AQChartProperties properties)
Copy the specified properties into this properties instance |
float |
getAxisTitleFontSize()
Get the font size scalar used to render the Axis Title text |
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 |
getCategoryAxisDateFormat()
Get the String used to format dates on the category axis |
String |
getCategoryAxisDateTimeFormat()
Get the String used to format datetimes on the category axis |
String |
getCategoryAxisNumberFormat()
Get the String used to format numbers on the category axis |
String |
getCategoryAxisTimeFormat()
Get the String used to format times on the category axis |
float |
getCategoryFontSize()
Get the font size scalar used to render the category axis text |
Integer |
getCategoryRangeEnd()
Get the Index of the last row to be displayed |
Integer |
getCategoryRangeStart()
Get the Index of the first row to be displayed |
float |
getCategorySpacing()
Get the Spacing between category geometry (in world coordinate units) |
Integer |
getCategoryTextLength()
Get the maximum text length (in characters) of the labels on the Category axis. |
String |
getChartSubTypeString(int seriesNumber)
Get the Subtype indicating how this series is used by a multi-series chart (e.g. |
String |
getChartTypeString(int seriesNumber)
Get the string name of the chart used to render the specified series. |
String |
getColor(int seriesNumber)
Get the Color used to render series geometry |
String |
getColumnTypeString(int seriesNumber)
Get the Type of geometry to use when rendering a column or bar chart |
float |
getDataLabelFontSize()
Get the font size scalar used to render the Data Label text |
float |
getDepth()
Get the Depth of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default depth is 5, so setting depth to 10 would double the depth of the chart grid (rather than the image containing the chart). |
String |
getFillGridColor()
Get the String representation of the color used to fill the chart grid |
int |
getFixedCategoryCount()
Get the Number of categories being displayed |
String |
getFont()
Get the String representation of the Font used to render text (axes, legend, title) |
AQSeriesFunction |
getFunction(int seriesNumber)
Get the Function used to generate this series |
String |
getFunctionName(int seriesNumber)
Get the Name of function used to generate this series |
String |
getFunctionParametersString(int seriesNumber)
Get the String containing function name and parameters |
float |
getGridLineWidth()
Return the width of the grid lines |
float |
getGroupSmallValuesThreshold()
Get the Threshold value used to group together smaller values in Pie charts |
float |
getHeight()
Get the Height of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default height is 10, so setting height to 20 would double the height of the chart grid (rather than the image containing the chart). |
Integer |
getImageHeight()
Get the Chart Image height |
Integer |
getImageWidth()
Get the Chart Image Width |
float |
getLegendFontSize()
Get the font size scalar used to render the legend text |
int |
getLegendHeight()
Get the Exact legend height |
String |
getLegendHeightType()
Get the Legend size type |
String |
getLegendPosition()
Get the Legend position |
int |
getLegendWidth()
Get the Exact legend width |
String |
getLegendWidthType()
Get the Legend size type |
String |
getLighting()
Get the Lighting type |
float |
getLineWidth()
Get the Width of lines in Line Chart |
String |
getMapRange()
Get the String list of ranges for map highlighting |
String |
getMapRangeColors()
Get the String list of colors for map highlighting |
Double |
getMax(int seriesNumber)
Get the Maximum value on this series' value axis (overrides maximum value found in data model) |
Double |
getMergeSeriesMax()
Get the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model) |
Double |
getMergeSeriesMin()
Get the Minimum value on the merged value axis shared by all series (overrides minimum value found in data model) |
Double |
getMin(int seriesNumber)
Get the Minimum value on this series' value axis (overrides minimum value found in data model) |
String |
getNameAlias(int seriesNumber)
Get the Alternate name for the specified series (default name is obtained from model) |
float |
getOpacity()
Get the opacity used to render chart geometry |
float |
getPanX()
Get the camera pan on the X-axis |
float |
getPanY()
Get the camera pan on the Y-axis |
float |
getPieExplode()
Get the Distance to which pie slices are exploded from the center of the Pie Chart |
float |
getPieLabelDistance()
Get the Distance at which labels are placed from their corresponding pie slices |
int |
getRotationX()
Get the camera rotation around X-axis |
int |
getRotationY()
Get the camera rotation around X-axis |
int |
getRotationZ()
Get the camera rotation around Z-axis |
String |
getSeriesAxisDateFormat()
Get the String used to format dates on the series axis |
String |
getSeriesAxisDateTimeFormat()
Get the String used to format datetimes on the series axis |
String |
getSeriesAxisNumberFormat()
Get the String used to format numbers on the series axis |
String |
getSeriesAxisTimeFormat()
Get the String used to format times on the series axis |
float |
getSeriesFontSize()
Get the font size scalar used to render the series axis text |
float |
getSeriesSpacing()
Get the Spacing between series geometry (in world coordinate units) |
Integer |
getSeriesTextLength()
Get the maximum text length (in characters) of the labels on the Series axis. |
String |
getTitle()
Get the Chart title |
String |
getTitleCategory()
Get the Category axis title |
float |
getTitleFontSize()
Get the font size scalar used to render the Title text |
String |
getTitlePosition()
Get the Chart title position |
String |
getTitleValue()
Get the Value axis title |
String |
getValueAxisNumberFormat()
Get the String used to format numbers on the value axis |
float |
getValueFontSize()
Get the font size scalar used to render the value axis text |
float |
getWidth()
Get the Width of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default width is 16, so setting width to 32 would double the width of the chart grid (rather than the image containing the chart). |
float |
getZoom()
Get the camera zoom |
boolean |
isClustered()
Return true if the current chart type is a clustered chart (e.g. |
boolean |
isFillGrid()
Return True if the grid is filled, False if only the grid lines are shown |
boolean |
isFitChartToImage()
Return True if the chart should be rendered flush with the edges of the image area |
boolean |
isFunctionSeries(int seriesNumber)
Return True if this series is a function series (instead of data from the model) |
boolean |
isGroupSmallValues()
Return True if small values in Pie charts should be grouped together |
boolean |
isMap()
Return true if the current chart type is a map chart |
boolean |
isMapShowBackground()
Return True if the map background should be displayed |
boolean |
isMapShowDetails()
Return True if country details should be displayed in the tooltip |
boolean |
isMergeAxis()
Return True if all series should share a common value axis, False if each series should have its own value axis |
boolean |
isMultiSeries()
Return true if the current chart renders multiple series (e.g. |
boolean |
isNumericCategoryAxis()
Return True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced) |
boolean |
isPie()
Return true if the current chart type is a pie chart |
boolean |
isPieShowLines()
Return True if the Pie Chart displays lines connecting the labels and the pie slices |
boolean |
isReverseValueAxis()
Return True if the value axis should be reversed (with values increasing from top to bottom or right to left) |
boolean |
isShowCategoryAxis()
Return True if the category axis labels are displayed |
boolean |
isShowCategoryAxisLines()
Return True if the Category axis lines are displayed |
boolean |
isShowCategoryAxisTicks()
Return True if the category axis tick marks are displayed |
boolean |
isShowDataLabels()
Return True if labels should be displayed at each data point |
boolean |
isShowDataLabels(int seriesNumber)
Return True if labels should be displayed at each data point |
boolean |
isShowFixedCategoryCount()
Return True if there is a fixed number of categories being displayed, False if no limits are imposed |
boolean |
isShowFunctionMetaData(int seriesNumber)
Return True if function metadata is displayed |
boolean |
isShowGrid()
Return True if the grid is shown, False if the grid is hidden |
boolean |
isShowLegend()
Return True if the legend is displayed |
boolean |
isShowLegendBorder()
Return True if the legend border is displayed |
boolean |
isShowMarkers()
Return True if markers are shown on Line Charts |
boolean |
isShowSeriesAxis()
Return True if the series axis labels are displayed |
boolean |
isShowValueAxis()
Return True if the value axis labels are displayed |
boolean |
isShowValueAxisLines()
Return True if the value axis lines are displayed |
boolean |
isShowValueAxisTicks()
Return True if the value axis tick marks are displayed |
boolean |
isStacked()
Return true if the current chart type is a stacked chart (e.g. |
boolean |
isStackedPercent()
Return True if stacked charts should render each series value as a percentage of the total value for all series |
boolean |
isValueAxisVertical()
Return true if the value axis is oriented vertically or horizontally. |
boolean |
isView2D()
Return True if the chart is rendered in 2D, False if rendered in 3D |
void |
loadProperty(String key,
String value)
Update a chart property using the specified string values |
void |
parsePropertiesString(String propertyString)
Update the chart properties by parsing the specified string into name-value pairs. |
void |
setAxisTitleFontSize(float fontSize)
Set the font size scalar used to render the Title text |
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 |
setCategoryAxisDateFormat(String categoryAxisDateFormat)
Set the String used to format dates on the category axis |
void |
setCategoryAxisDateTimeFormat(String categoryAxisDateTimeFormat)
Set the String used to format datetimes on the category axis |
void |
setCategoryAxisNumberFormat(String categoryAxisNumberFormat)
Set the String used to format numbers on the category axis |
void |
setCategoryAxisTimeFormat(String categoryAxisTimeFormat)
Set the String used to format times on the category axis |
void |
setCategoryFontSize(float fontSize)
Set the font size scalar used to render the category axis text |
void |
setCategoryRange(Integer startRow,
Integer endRow)
Display only the categories & values between the specified rows (inclusive) |
void |
setCategoryRangeEnd(Integer endRow)
Display only the categories & values before the specified row (inclusive) |
void |
setCategoryRangeStart(Integer startRow)
Display only the categories & values after the specified row (inclusive) |
void |
setCategorySpacing(float spacingX)
Set the Spacing between category geometry (in world coordinate units) |
void |
setCategoryTextLength(Integer textLength)
Set the maximum text length (in characters) of the labels on the Category axis. |
void |
setChartSubType(int seriesNumber,
String chartSubType)
Set the subtype indicating how this series is used by a multi-series chart (e.g. |
void |
setChartSubTypeClose(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartSubTypeHigh(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartSubTypeLow(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartSubTypeOpen(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartSubTypePosition(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartSubTypeSize(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render |
void |
setChartTypeArea()
Set the chart type for all series to Area |
void |
setChartTypeArea(int seriesNumber)
Set the chart type for the specified series to Area |
void |
setChartTypeBar()
Set the chart type for all series to Bar |
void |
setChartTypeBar(int seriesNumber)
Set the chart type for the specified series to Bar |
void |
setChartTypeBarCluster()
Set the chart type for all series to Bar Cluster |
void |
setChartTypeBarCluster(int seriesNumber)
Set the chart type for the specified series to BarCluster |
void |
setChartTypeBubble()
Set the chart type for all series to Bubble |
void |
setChartTypeBubble(int seriesNumber)
Set the chart type for the specified series to Bubble |
void |
setChartTypeCandlestick()
Set the chart type for all series to Candlestick |
void |
setChartTypeCandlestick(int seriesNumber)
Set the chart type for the specified series to Candlestick |
void |
setChartTypeCloud()
Set the chart type for all series to Cloud |
void |
setChartTypeCloud(int seriesNumber)
Set the chart type for the specified series to Cloud |
void |
setChartTypeColumn()
Set the chart type for all series to Column |
void |
setChartTypeColumn(int seriesNumber)
Set the chart type for the specified series to Column |
void |
setChartTypeColumnCluster()
Set the chart type for all series to Column Cluster |
void |
setChartTypeColumnCluster(int seriesNumber)
Set the chart type for the specified series to ColumnCluster |
void |
setChartTypeHighLowClose()
Set the chart type for all series to High Low Close |
void |
setChartTypeHighLowClose(int seriesNumber)
Set the chart type for the specified series to HighLowClose |
void |
setChartTypeLine()
Set the chart type for all series to Line |
void |
setChartTypeLine(int seriesNumber)
Set the chart type for the specified series to Line |
void |
setChartTypeLine3d()
Set the chart type for all series to Line |
void |
setChartTypeLine3d(int seriesNumber)
Set the chart type for the specified series to Line3d |
void |
setChartTypeMap()
Set the chart type for all series to Map |
void |
setChartTypeMap(int seriesNumber)
Set the chart type for the specified series to Map |
void |
setChartTypePie()
Set the chart type for all series to Pie |
void |
setChartTypePie(int seriesNumber)
Set the chart type for the specified series to Pie |
void |
setChartTypeScatter()
Set the chart type for all series to Scatter |
void |
setChartTypeScatter(int seriesNumber)
Set the chart type for the specified series to Scatter |
void |
setChartTypeStacked()
Set the chart type for all series to Stacked Column |
void |
setChartTypeStacked(int seriesNumber)
Set the chart type for the specified series to Stacked |
void |
setChartTypeStackedArea()
Set the chart type for all series to Stacked Area |
void |
setChartTypeStackedArea(int seriesNumber)
Set the chart type for the specified series to Stacked Area |
void |
setChartTypeStackedBar()
Set the chart type for all series to Stacked Bar |
void |
setChartTypeStackedBar(int seriesNumber)
Set the chart type for the specified series to Stacked Bar |
void |
setChartTypeStackedLine()
Set the chart type for all series to Stacked Line |
void |
setChartTypeStackedLine(int seriesNumber)
Set the chart type for the specified series to Stacked Line |
void |
setChartTypeSurface()
Set the chart type for all series to Surface |
void |
setChartTypeSurface(int seriesNumber)
Set the chart type for the specified series to Surface |
void |
setColor(int seriesNumber,
String color)
Set the color used to render series geometry |
void |
setColumnType(int seriesNumber,
String columnType)
Set the type of geometry to use when rendering a column or bar chart |
void |
setColumnTypeCone(int seriesNumber)
Set the type of geometry (Cone) to use when rendering a column or bar chart |
void |
setColumnTypeCube(int seriesNumber)
Set the type of geometry (Cube) to use when rendering a column or bar chart |
void |
setColumnTypeCylinder(int seriesNumber)
Set the type of geometry (Cylinder) to use when rendering a column or bar chart |
void |
setColumnTypePyramid(int seriesNumber)
Set the type of geometry (Pyramid) to use when rendering a column or bar chart |
void |
setDataLabelFontSize(float fontSize)
Set the font size scalar used to render the Data Label text |
void |
setDepth(float depth)
Set the Depth of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default depth is 5, so setting depth to 10 would double the depth of the chart grid (rather than the image containing the chart). |
void |
setFillGrid(boolean fillGrid)
Set to True to fill the grid, False to only show the grid lines |
void |
setFillGridColor(String fillGridColor)
Set the color used to fill the chart grid |
void |
setFitChartToImage(boolean fitChartToImage)
Set to True if the chart should be rendered flush with the edges of the image area |
void |
setFixedCategoryCount(int topCount)
Set the Number of categories being displayed |
void |
setFont(String font)
Set the font used to render text (axes, legend, title). |
void |
setFunction(int seriesNumber,
String function)
Set the Function used to generate this series |
void |
setGridLineWidth(float lineWidth)
Set the width of the grid lines |
void |
setGroupSmallValues(boolean groupSmallValues)
Set to True if small values in Pie charts should be grouped together |
void |
setGroupSmallValuesThreshold(float groupSmallValuesThreshold)
Set the Threshold value used to group together smaller values in Pie charts |
void |
setHeight(float height)
Set the Height of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default height is 10, so setting height to 20 would double the height of the chart grid (rather than the image containing the chart). |
void |
setImageHeight(Integer imageHeight)
Set the Chart Image Height |
void |
setImageWidth(Integer imageWidth)
Set the Chart Image Width |
void |
setLegendFontSize(float fontSize)
Set the font size scalar used to render the legend text |
void |
setLegendHeight(int legendVerticalSize)
Set the Explicit legend height |
void |
setLegendHeightType(String heightType)
Set the Legend size type |
void |
setLegendHeightTypeExact()
Use the LegendHeight property to specify the exact height of the Legend |
void |
setLegendHeightTypeFit()
Resize the Legend to fit its contents |
void |
setLegendHeightTypeStretch()
Stretch the Legend to span the height of the rendering area |
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 |
setLegendWidth(int legendHorizontalSize)
Set the Exact legend width |
void |
setLegendWidthType(String widthType)
Set the Legend size type |
void |
setLegendWidthTypeExact()
Use the LegendWidth property to specify the exact width of the Legend |
void |
setLegendWidthTypeFit()
Resize the Legend to fit its contents |
void |
setLegendWidthTypeStretch()
Stretch the Legend to span the width of the rendering area |
void |
setLighting(String lighting)
Set the lighting type |
void |
setLightingAmbient()
Use ambient lighting when rendering the chart |
void |
setLightingBright()
Use bright lighting when rendering the chart |
void |
setLightingDark()
Use dark lighting when rendering the chart |
void |
setLightingDefault()
Use default lighting when rendering the chart |
void |
setLineWidth(float lineWidth)
Set the Width of lines in Line Chart |
void |
setMapRange(String mapRange)
Set the String list of ranges for map highlighting |
void |
setMapRangeColors(String mapRangeColors)
Set the String list of colors for map highlighting |
void |
setMapShowBackground(boolean mapShowBackground)
Set to True if the map background should be displayed |
void |
setMapShowDetails(boolean mapShowDetails)
Set to True if country details should be displayed in the tooltip |
void |
setMax(int seriesNumber,
Double max)
Set the Maximum value on this series' value axis (overrides maximum value found in data model) |
void |
setMergeAxis(boolean multiAxis)
Set to True if all series should share a common value axis, False if each series should have its own value axis |
void |
setMergeSeriesMax(Double mergeSeriesMax)
Set the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model) |
void |
setMergeSeriesMin(Double mergeSeriesMin)
Set the Minimum value on the merged value axis shared by all series (overrides minimum value found in data model) |
void |
setMin(int seriesNumber,
Double min)
Set the Minimum value on this series' value axis (overrides minimum value found in data model) |
void |
setNameAlias(int seriesNumber,
String nameAlias)
Set the Alternate name for the specified series (default name is obtained from model) |
void |
setNumericCategoryAxis(boolean numericCategoryAxis)
Set to True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced) |
void |
setOpacity(float opacity)
Set the opacity used to render chart geometry |
void |
setPanX(float panX)
Set the camera pan on the X-axis |
void |
setPanY(float panY)
Set the camera pan on the Y-axis |
void |
setPieExplode(float pieExplode)
Set the Distance to which pie slices are exploded from the center of the Pie Chart |
void |
setPieLabelDistance(float pieLabelDistance)
Set the Distance at which labels are placed from their corresponding pie slices |
void |
setPieShowLines(boolean pieShowLines)
Set to True if the Pie Chart displays lines connecting the labels and the pie slices |
void |
setReverseValueAxis(boolean reverse)
Set to True if the value axis should be reversed (with values increasing from top to bottom and right to left, instead of from bottom to top and left to right) |
void |
setRotationX(int rotationX)
Set the camera rotation around X-axis |
void |
setRotationY(int rotationY)
Set the camera rotation around Y-axis |
void |
setRotationZ(int rotationZ)
Set the camera rotation around Z-axis |
void |
setSeriesAxisDateFormat(String seriesAxisDateFormat)
Set the String used to format dates on the series axis |
void |
setSeriesAxisDateTimeFormat(String seriesAxisDateTimeFormat)
Set the String used to format datetimes on the series axis |
void |
setSeriesAxisNumberFormat(String seriesAxisNumberFormat)
Set the String used to format numbers on the series axis |
void |
setSeriesAxisTimeFormat(String seriesAxisTimeFormat)
Set the String used to format times on the series axis |
void |
setSeriesFontSize(float fontSize)
Set the font size scalar used to render the series axis text |
void |
setSeriesSpacing(float spacingZ)
Set the Spacing between series geometry (in world coordinate units) |
void |
setSeriesTextLength(Integer textLength)
Set the maximum text length (in characters) of the labels on the Series axis. |
void |
setShowCategoryAxis(boolean showCategoryAxis)
Set to True if the category axis labels are displayed |
void |
setShowCategoryAxisLines(boolean showCategoryAxisLines)
Set to True if the Category axis lines are displayed |
void |
setShowCategoryAxisTicks(boolean showCategoryAxisTicks)
Set to True if the category axis tick marks are displayed |
void |
setShowDataLabels(boolean showDataLabels)
Set to True if labels should be displayed at each data point |
void |
setShowDataLabels(int seriesNumber,
boolean showDataLabels)
Set to True if labels should be displayed at each data point |
void |
setShowFixedCategoryCount(boolean showTopCount)
Set to True if there is a fixed number of categories being displayed, False if no limits are imposed |
void |
setShowFunctionMetaData(int seriesNumber,
boolean showFunctionMetaData)
Set to True if function metadata is displayed |
void |
setShowGrid(boolean showGrid)
Set to True if the grid is shown, False if the grid is hidden |
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 |
setShowMarkers(boolean showMarkers)
Set to True if markers are shown on Line Charts |
void |
setShowSeriesAxis(boolean showSeriesAxis)
Set to True if the series axis labels are displayed |
void |
setShowValueAxis(boolean showValueAxis)
Set to True if the value axis labels are displayed |
void |
setShowValueAxisLines(boolean showValueAxisLines)
Set to True if the value axis lines are displayed |
void |
setShowValueAxisTicks(boolean showValueAxisTicks)
Set to True if the value axis tick marks are displayed |
void |
setStackedPercent(boolean stackedPercent)
Set to True if stacked charts should render each series value as a percentage of the total value for all series |
void |
setTitle(String title)
Set the Chart Title |
void |
setTitleCategory(String titleCategory)
Set the Category axis title |
void |
setTitleFontSize(float fontSize)
Set the font size scalar used to render the Title text |
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 |
setTitleValue(String titleValue)
Set the Value axis title |
void |
setValueAxisNumberFormat(String valueAxisNumberFormat)
Set the String used to format numbers on the value axis |
void |
setValueFontSize(float fontSize)
Set the font size scalar used to render the value axis text |
void |
setView2D(boolean view2D)
Set to True if the chart is rendered in 2D, False if rendered in 3D |
void |
setWidth(float width)
Set the Width of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height) The default width is 16, so setting width to 32 would double the width of the chart grid (rather than the image containing the chart). |
void |
setZoom(float zoom)
Set the camera zoom |
Method Detail |
---|
void parsePropertiesString(String propertyString)
An example string:
Chart="{column}",
RotX=325,
RotY=0,
RotZ=0,
ZoomScalar=1.0,
ShowLegend=true,
ShowLegendBorder=true,
ShowGrid=true,
FillGrid=true,
GridLineWidth=1.0,
PieExplode=0.0,
GroupSmallValues=true,
SmallValuesThreshold=3.0,
PieLabelDistance=3.0,
PieShowLines=false,
LineWidth=1.0,
ShowMarkers=true,
MapShowBackground=false,
MapShowDetails=false,
Width=16.0,
Height=10.0,
Depth=5.0,
SeriesSpacing=1.0,
CategorySpacing=1.0,
Font=ARIAL-BOLD-10,
LegendFontSize=0.8,
SeriesFontSize=1,
CategoryFontSize=1,
ValueFontSize=1,
TitleFontSize=1,
AxisTitleFontSize=1,
DataLabelFontSize=1,
TopColor=#ebf0f5,
BottomColor=#d7dcf5,
PanX=0.0,
PanY=0.0,
Lighting=Default,
Opacity=1.0,
View2D=false,
StackedPercent=false,
ShowValueAxis=true,
ShowValueAxisTicks=true,
ShowValueAxisLines=true,
ShowDataLabels=true,
ShowSeriesDataLabels="true",
ReverseValueAxis=false,
ShowCategoryAxis=true,
ShowCategoryAxisTicks=true,
ShowCategoryAxisLines=true,
ShowSeriesAxis=true,
NumericCategoryAxis=false,
MergeAxis=false,
SeriesAlias="default",
SeriesSubType="",
SeriesColumnType="Cube",
SeriesMin="default",
SeriesMax="default",
SeriesColor="default",
SeriesFunctionMetaData="true",
LegendPosition=Top Right,
LegendWidthType=Fit,
LegendWidth=100,
LegendHeightType=Fit,
LegendHeight=160,
ShowFixedCategoryCount=false,
FixedCategoryCount=0
Title=""
TitlePosition="Bottom Center"
propertyString
- String containing name-value pairs in the format: 'title="My Chart", Chart="{column}"'void loadProperty(String key, String value)
key
- String property keyvalue
- String property valuevoid copy(AQChartProperties properties)
properties
- Properties to be copiedvoid addFunctionSeries()
void addFunctionSeries(String functionString)
For Example:
Add(0, 1) For each row, Add the values in the first series (series 0) to the second series (series 1)
Subtract(0, 1) For each row, Subtract the values in second series from the first series
Scalar(0, 10) For each row, Multiply values in the first series by 10
Average(0) Find the Average of all values in the first series, and place that value in every row
Moving Average(0, 5) For each row, find the Moving Average of the previous 5 elements (inclusive) in the first series
Power(0, 2) For each row, raise the value in the first series to the 2nd power
Log(0, 10) For each row, find the logarithm of value in the first series using base 10
Linear Regression(0, 10) Perform regression analysis on all series values, then compute the function series values using the slope & y-intercept
functionString
- String representation of a functionboolean isValueAxisVertical()
Most charts have a vertical value axis (e.g. Column, Area, Stacked, Line, Scatter,...)
The Bar charts have a horizontal value axis (e.g. Bar, Stacked Bar, Bar Cluster)
boolean isMultiSeries()
boolean isStacked()
boolean isClustered()
boolean isPie()
boolean isMap()
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);
void setChartTypeColumn(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeStacked(int seriesNumber)
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.
seriesNumber
- Series Indexvoid setChartTypeLine(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeLine3d(int seriesNumber)
The line markers are optionally displayed depending on the ShowMarkers property.
The Column, 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);
seriesNumber
- Series Indexvoid setChartTypePie(int seriesNumber)
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.
seriesNumber
- Series Indexvoid setChartTypeBar(int seriesNumber)
Bar charts use the ColumnType property to determine the type of geometric primitive used to render each bar.
seriesNumber
- Series Indexvoid setChartTypeArea(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeScatter(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeBubble(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeStackedArea(int seriesNumber)
Stacked Area charts are rendered by plotting Area charts for each series and stacking the results.
seriesNumber
- Series Indexvoid setChartTypeStackedLine(int seriesNumber)
Stacked Line charts are rendered by plotting Line charts for each series and stacking the results.
seriesNumber
- Series Indexvoid setChartTypeStackedBar(int seriesNumber)
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.
seriesNumber
- Series Indexvoid setChartTypeSurface(int seriesNumber)
Surface charts render a single continuous surface whose vertex coordinates are determined by the series category position and data value.
seriesNumber
- Series Indexvoid setChartTypeHighLowClose(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeCandlestick(int seriesNumber)
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);
seriesNumber
- Series Indexvoid setChartTypeCloud(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeColumnCluster(int seriesNumber)
Column Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.*
seriesNumber
- Series Indexvoid setChartTypeBarCluster(int seriesNumber)
Bar Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.
seriesNumber
- Series Indexvoid setChartTypeMap(int seriesNumber)
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);
seriesNumber
- Series Indexint getRotationX()
void setRotationX(int rotationX)
rotationX
- Camera rotation around X-axisint getRotationY()
void setRotationY(int rotationY)
rotationY
- Camera rotation around Y-axisint getRotationZ()
void setRotationZ(int rotationZ)
rotationZ
- Camera rotation around Z-axisfloat getZoom()
void setZoom(float zoom)
zoom
- Camera zoomfloat getPanX()
void setPanX(float panX)
panX
- Camera pan on the X-axisfloat getPanY()
void setPanY(float panY)
panY
- Camera pan on the Y-axisInteger 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)float getWidth()
void setWidth(float width)
width
- Width of chart (in world coordinate units, where each grid cell is 1.0 units in width & height)float getHeight()
void setHeight(float height)
height
- Height of chart chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height)float getDepth()
void setDepth(float depth)
depth
- Depth of chart (in world coordinate units, where each grid cell is 1.0 units in width & height)float getCategorySpacing()
void setCategorySpacing(float spacingX)
spacingX
- Spacing between category geometry (in world coordinate units)float getSeriesSpacing()
void setSeriesSpacing(float spacingZ)
spacingZ
- Spacing between series geometry (in world coordinate units)Integer getCategoryTextLength()
void setCategoryTextLength(Integer textLength)
textLength
- Maximum length of category label text (in characters)Integer getSeriesTextLength()
void setSeriesTextLength(Integer textLength)
textLength
- Maximum length of series label text (in characters)String getFont()
void setFont(String font)
For example:
setFont("ARIAL-BOLD-10")
font
- String representation of the font used to render text (axes, legend, title).float getLegendFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setLegendFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the legend textfloat getSeriesFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setSeriesFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the series axis textfloat getCategoryFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setCategoryFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size))
fontSize
- the font size scalar used to render the category axis textfloat getValueFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setValueFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the value axis textfloat getTitleFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setTitleFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the Title textfloat getAxisTitleFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setAxisTitleFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the Title textfloat getDataLabelFontSize()
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
void setDataLabelFontSize(float fontSize)
For example:
0.5 means scale the currently selected font by 50% (reduce to half size)
fontSize
- the font size scalar used to render the Data LAbel textString 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 isShowGrid()
void setShowGrid(boolean showGrid)
showGrid
- True if the grid is shown, False if the grid is hiddenfloat getGridLineWidth()
void setGridLineWidth(float lineWidth)
lineWidth
- Grid Line Widthboolean isFillGrid()
void setFillGrid(boolean fillGrid)
fillGrid
- True to fill the grid, False to only show the grid linesString getFillGridColor()
For example:
"#FFFFFF" = white
void setFillGridColor(String fillGridColor)
For example:
"#FFFFFF" = white
fillGridColor
- String representation of the color used to fill the chart gridboolean isGroupSmallValues()
void setGroupSmallValues(boolean groupSmallValues)
groupSmallValues
- True if small values in Pie charts should be grouped togetherfloat getGroupSmallValuesThreshold()
The threshold is a percentage of the total of all series values, where 50.0 is 50% and 100.0 is 100%.
For each series value, find the percentage of that value to the total for the entire series.
If the percentage is less than the specified threshold (0.0 to 100.0), then the value is added to an aggregate pie slice labelled Other.
void setGroupSmallValuesThreshold(float groupSmallValuesThreshold)
The threshold is a percentage of the total of all series values, where 50.0 is 50% and 100.0 is 100%.
For each series value, find the percentage of that value to the total for the entire series.
If the percentage is less than the specified threshold (0.0 to 100.0), then the value is added to an aggregate pie slice labelled Other.
groupSmallValuesThreshold
- Threshold value used to group together smaller values in Pie chartsboolean isMergeAxis()
void setMergeAxis(boolean multiAxis)
multiAxis
- True if all series should share a common value axis, False if each series should have its own value axisboolean isShowFixedCategoryCount()
void setShowFixedCategoryCount(boolean showTopCount)
showTopCount
- True if there is a fixed number of categories being displayed, False if no limits are imposedint getFixedCategoryCount()
void setFixedCategoryCount(int topCount)
topCount
- Number of categories being displayedvoid setCategoryRange(Integer startRow, Integer endRow)
startRow
- Index of first row to be displayed, or null to use the default starting row index (0)endRow
- Index of last row to be displayed, or null to use the default ending row index (rowCount - 1)void setCategoryRangeStart(Integer startRow)
startRow
- Index of first row to be displayed, or null to use the default starting row index (0)void setCategoryRangeEnd(Integer endRow)
endRow
- Index of last row to be displayed, or null to use the default ending row index (rowCount - 1)Integer getCategoryRangeStart()
Integer getCategoryRangeEnd()
float getLineWidth()
void setLineWidth(float lineWidth)
lineWidth
- Width of lines in Line Chartboolean isView2D()
void setView2D(boolean view2D)
view2D
- True if the chart is rendered in 2D, False if rendered in 3Dboolean isFitChartToImage()
void setFitChartToImage(boolean fitChartToImage)
fitChartToImage
- True if the chart should be rendered flush with the edges of the image areaboolean 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 getLegendWidthType()
For example:
"Stretch", "Fit", "Exact"
void setLegendWidthType(String widthType)
For example:
"Stretch", "Fit", "Exact"
widthType
- Legend size typevoid setLegendWidthTypeStretch()
void setLegendWidthTypeFit()
void setLegendWidthTypeExact()
String getLegendHeightType()
For example:
"Stretch", "Fit", "Exact"
void setLegendHeightType(String heightType)
For example:
"Stretch", "Fit", "Exact"
heightType
- Legend size typevoid setLegendHeightTypeStretch()
void setLegendHeightTypeFit()
void setLegendHeightTypeExact()
int getLegendWidth()
Used when LegendWidthType is "Exact"
void setLegendWidth(int legendHorizontalSize)
Used when LegendWidthType is "Exact"
legendHorizontalSize
- Exact legend widthint getLegendHeight()
Used when LegendHeightType is "Exact"
void setLegendHeight(int legendVerticalSize)
Used when LegendHeightType is "Exact"
legendVerticalSize
- Explicit legend heightDouble getMergeSeriesMin()
void setMergeSeriesMin(Double mergeSeriesMin)
mergeSeriesMin
- Minimum value on the merged value axis shared by all series (overrides minimum value found in data model), or null to use the model's calculated min valueDouble getMergeSeriesMax()
void setMergeSeriesMax(Double mergeSeriesMax)
mergeSeriesMax
- Maximum value on the merged value axis shared by all series (overrides maximum value found in data model), or null to use the model's calculated max valueString 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 getTitleCategory()
void setTitleCategory(String titleCategory)
titleCategory
- Category axis titleString getTitleValue()
void setTitleValue(String titleValue)
titleValue
- Value axis titleString getLighting()
For example:
"Default", "Bright", "Dark", "Ambient"
void setLighting(String lighting)
For example:
"Default", "Bright", "Dark", "Ambient"
lighting
- String representation of lighting typevoid setLightingDefault()
void setLightingBright()
void setLightingDark()
void setLightingAmbient()
float getOpacity()
void setOpacity(float opacity)
opacity
- Value from 0.0 to 1.0 specifying the transparency of chart geometry.boolean isPieShowLines()
void setPieShowLines(boolean pieShowLines)
pieShowLines
- True if the Pie Chart displays lines connecting the labels and the pie slicesfloat getPieExplode()
void setPieExplode(float pieExplode)
pieExplode
- Distance to which pie slices are exploded from the center of the Pie Chartfloat getPieLabelDistance()
void setPieLabelDistance(float pieLabelDistance)
pieLabelDistance
- Distance at which labels are placed from their corresponding pie slicesboolean isStackedPercent()
void setStackedPercent(boolean stackedPercent)
stackedPercent
- True if stacked charts should render each series value as a percentage of the total value for all seriesboolean isShowValueAxis()
void setShowValueAxis(boolean showValueAxis)
showValueAxis
- True if the value axis labels are displayedboolean isShowValueAxisTicks()
void setShowValueAxisTicks(boolean showValueAxisTicks)
showValueAxisTicks
- True if the value axis tick marks are displayedboolean isShowValueAxisLines()
void setShowValueAxisLines(boolean showValueAxisLines)
showValueAxisLines
- True if the value axis lines are displayedboolean isShowDataLabels()
void setShowDataLabels(boolean showDataLabels)
showDataLabels
- True if labels should be displayed at each data pointboolean isShowDataLabels(int seriesNumber)
seriesNumber
- Zero-based index of series
void setShowDataLabels(int seriesNumber, boolean showDataLabels)
seriesNumber
- Zero-based index of seriesshowDataLabels
- True if labels should be displayed at each data pointboolean isShowCategoryAxis()
void setShowCategoryAxis(boolean showCategoryAxis)
showCategoryAxis
- True if the category axis labels are displayedboolean isShowCategoryAxisTicks()
void setShowCategoryAxisTicks(boolean showCategoryAxisTicks)
showCategoryAxisTicks
- True if the category axis tick marks are displayedboolean isShowCategoryAxisLines()
void setShowCategoryAxisLines(boolean showCategoryAxisLines)
showCategoryAxisLines
- True if the Category axis lines are displayedboolean isShowSeriesAxis()
void setShowSeriesAxis(boolean showSeriesAxis)
showSeriesAxis
- True if the series axis labels are displayedboolean isShowMarkers()
void setShowMarkers(boolean showMarkers)
showMarkers
- True if markers are shown on Line Chartsboolean isReverseValueAxis()
void setReverseValueAxis(boolean reverse)
reverse
- True if the value axis should be reversed (with values increasing from top to bottom and right to left, instead of from bottom to top and left to right)String getValueAxisNumberFormat()
For example:
"#,##0.00"
void setValueAxisNumberFormat(String valueAxisNumberFormat)
For example:
"#,##0.00"
valueAxisNumberFormat
- String used to format numbers on the value axisString getCategoryAxisDateTimeFormat()
For example:
"MMMM dd, yyyy HH:mm:ss a"
void setCategoryAxisDateTimeFormat(String categoryAxisDateTimeFormat)
For example:
"MMMM dd, yyyy HH:mm:ss a"
categoryAxisDateTimeFormat
- String used to format datetimes on the category axisString getCategoryAxisTimeFormat()
For example:
"HH:mm:ss a"
void setCategoryAxisTimeFormat(String categoryAxisTimeFormat)
For example:
"HH:mm:ss a"
categoryAxisTimeFormat
- String used to format times on the category axisString getCategoryAxisDateFormat()
For example:
"MMMM dd, yyyy"
void setCategoryAxisDateFormat(String categoryAxisDateFormat)
For example:
"MMMM dd, yyyy"
categoryAxisDateFormat
- String used to format dates on the category axisString getCategoryAxisNumberFormat()
For example:
"#,##0.00"
void setCategoryAxisNumberFormat(String categoryAxisNumberFormat)
For example:
"#,##0.00"
categoryAxisNumberFormat
- String used to format numbers on the category axisString getSeriesAxisDateTimeFormat()
For example:
"MMMM dd, yyyy HH:mm:ss a"
void setSeriesAxisDateTimeFormat(String seriesAxisDateTimeFormat)
For example:
"MMMM dd, yyyy HH:mm:ss a"
seriesAxisDateTimeFormat
- String used to format datetimes on the series axisString getSeriesAxisTimeFormat()
For example:
"HH:mm:ss a"
void setSeriesAxisTimeFormat(String seriesAxisTimeFormat)
For example:
"HH:mm:ss a"
seriesAxisTimeFormat
- String used to format times on the series axisString getSeriesAxisDateFormat()
For example:
"MMMM dd, yyyy"
void setSeriesAxisDateFormat(String seriesAxisDateFormat)
For example:
"MMMM dd, yyyy"
seriesAxisDateFormat
- String used to format dates on the series axisString getSeriesAxisNumberFormat()
For example:
"#,##0.00"
void setSeriesAxisNumberFormat(String seriesAxisNumberFormat)
For example:
"#,##0.00"
seriesAxisNumberFormat
- String used to format numbers on the series axisboolean isNumericCategoryAxis()
void setNumericCategoryAxis(boolean numericCategoryAxis)
numericCategoryAxis
- True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced)boolean isMapShowBackground()
void setMapShowBackground(boolean mapShowBackground)
mapShowBackground
- True if the map background should be displayedboolean isMapShowDetails()
void setMapShowDetails(boolean mapShowDetails)
mapShowDetails
- True if country details should be displayed in the tooltipString getMapRange()
For example:
"0,100,200,300,400,500" == 0 <= x < 100; 100 <= x < 200; ... ; 400 <= x <= 500
void setMapRange(String mapRange)
For example:
"0,100,200,300,400,500" == 0 <= x < 100; 100 <= x < 200; ... ; 400 <= x <= 500
mapRange
- String list of ranges for map highlightingString getMapRangeColors()
For example:
"red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF"
void setMapRangeColors(String mapRangeColors)
For example:
"red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF"
mapRangeColors
- String list of colors for map highlightingString getNameAlias(int seriesNumber)
seriesNumber
- Zero-based index of series
void setNameAlias(int seriesNumber, String nameAlias)
seriesNumber
- Zero-based index of seriesnameAlias
- Alternate name for the specified series, or null to use the default name obtained from the modelString getColor(int seriesNumber)
seriesNumber
- Zero-based index of series
void setColor(int seriesNumber, String color)
seriesNumber
- Zero-based index of seriescolor
- String name of color used to render series geometry, or null to use the default color schemeDouble getMin(int seriesNumber)
seriesNumber
- Zero-based index of series
void setMin(int seriesNumber, Double min)
seriesNumber
- Zero-based index of seriesmin
- Minimum value on this series' value axis (overrides minimum value found in data model), or null to use the model's calculated min valueDouble getMax(int seriesNumber)
seriesNumber
- Zero-based index of series
void setMax(int seriesNumber, Double max)
seriesNumber
- Zero-based index of seriesmax
- Maximum value on this series' value axis (overrides maximum value found in data model), or null to use the model's calculated max valueString getChartSubTypeString(int seriesNumber)
seriesNumber
- Zero-based index of series
void setChartSubType(int seriesNumber, String chartSubType)
seriesNumber
- Zero-based index of serieschartSubType
- String name of subtype indicating how this series is used by a chart which requires multiple series to render (e.g. bubble, candlestick, high-low-close)void setChartSubTypeHigh(int seriesNumber)
For example:
"High" for the HLC or Candlestick charts
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeLow(int seriesNumber)
For example:
"Low" for the HLC or Candlestick charts
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeClose(int seriesNumber)
For example:
"Close" for the HLC or Candlestick charts
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeOpen(int seriesNumber)
For example:
"Open" for Candlestick chart
seriesNumber
- Zero-based index of seriesvoid setChartSubTypePosition(int seriesNumber)
For example:
"Position" for Bubble chart
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeSize(int seriesNumber)
For example:
"Size" for Bubble chart
seriesNumber
- Zero-based index of seriesString getColumnTypeString(int seriesNumber)
For example:
ChartConstants.COLUMN_TYPE_CUBE, COLUMN_TYPE_CONE, etc
seriesNumber
- Zero-based index of series
void setColumnType(int seriesNumber, String columnType)
For example:
"cube", "cone", "cylinder", "pyramid"
seriesNumber
- Zero-based index of seriescolumnType
- String name of type of geometry to use when rendering a column or bar chartvoid setColumnTypeCube(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setColumnTypeCone(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setColumnTypeCylinder(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setColumnTypePyramid(int seriesNumber)
seriesNumber
- Zero-based index of seriesboolean isFunctionSeries(int seriesNumber)
seriesNumber
- Zero-based index of series
AQSeriesFunction getFunction(int seriesNumber)
seriesNumber
- Zero-based index of series
String getFunctionName(int seriesNumber)
seriesNumber
- Zero-based index of series
String getFunctionParametersString(int seriesNumber)
seriesNumber
- Zero-based index of series
void setFunction(int seriesNumber, String function)
seriesNumber
- Zero-based index of seriesfunction
- Function used to generate this seriesboolean isShowFunctionMetaData(int seriesNumber)
seriesNumber
- Zero-based index of series
void setShowFunctionMetaData(int seriesNumber, boolean showFunctionMetaData)
seriesNumber
- Zero-based index of seriesshowFunctionMetaData
- True if function metadata is displayed
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |