|
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 For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
String |
getBackgroundColorBottom()
Get the String representation of the color used at the bottom of the background gradient For example: "#FFFFFF" = white |
String |
getBackgroundColorTop()
Get the String representation of the color used at the top of the background gradient For example: "#FFFFFF" = white |
String |
getCategoryAxisDateFormat()
Get the String used to format dates on the category axis For example: "MMMM dd, yyyy" |
String |
getCategoryAxisDateTimeFormat()
Get the String used to format datetimes on the category axis For example: "MMMM dd, yyyy HH:mm:ss a" |
String |
getCategoryAxisLabelColor()
Get the String representation of the color used for the Category Axis Label text For example: "#FFFFFF" = white |
String |
getCategoryAxisNumberFormat()
Get the String used to format numbers on the category axis For example: "#,##0.00" |
String |
getCategoryAxisTimeFormat()
Get the String used to format times on the category axis For example: "HH:mm:ss a" |
String |
getCategoryAxisTitleColor()
Get the String representation of the color used for the Category Axis Title text For example: "#FFFFFF" = white |
float |
getCategoryFontSize()
Get the font size scalar used to render the category axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 For example: ChartConstants.COLUMN_TYPE_CUBE, COLUMN_TYPE_CONE, etc |
String |
getDataLabelColor()
Get the String representation of the color used for Data Labels For example: "#FFFFFF" = white |
float |
getDataLabelFontSize()
Get the font size scalar used to render the Data Label text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 For example: "#FFFFFF" = white |
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) |
String |
getFontTitle()
Get the String representation of the Font used to render title text. |
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 |
getGridOpacity()
Get the opacity used to render the chart grid |
float |
getGroupSmallValuesThreshold()
Get the Threshold value used to group together smaller values in Pie charts The threshold is a percentage of the total of all series values, where 50.0 is 50% and 100.0 is 100%. |
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 For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
int |
getLegendHeight()
Get the Exact legend height Used when LegendHeightType is "Exact" |
String |
getLegendHeightType()
Get the Legend size type For example: "Stretch", "Fit", "Exact" |
String |
getLegendPosition()
Get the Legend position For example: "Top Left", "Top Right", "Bottom Left", "Bottom Right" |
int |
getLegendWidth()
Get the Exact legend width Used when LegendWidthType is "Exact" |
String |
getLegendWidthType()
Get the Legend size type For example: "Stretch", "Fit", "Exact" |
String |
getLighting()
Get the Lighting type For example: "Default", "Bright", "Dark", "Ambient" |
float |
getLineWidth()
Get the Width of lines in Line Chart |
String |
getMapRange()
Get the String list of ranges for map highlighting For example: "0,100,200,300,400,500" == 0 <= x < 100; 100 <= x < 200; ... |
String |
getMapRangeColors()
Get the String list of colors for map highlighting For example: "red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF" |
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 |
Integer |
getPieExplodeTopSlices()
Get the number of slices to explode, starting with the largest slice and continuing in descending order |
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 For example: "MMMM dd, yyyy" |
String |
getSeriesAxisDateTimeFormat()
Get the String used to format datetimes on the series axis For example: "MMMM dd, yyyy HH:mm:ss a" |
String |
getSeriesAxisLabelColor()
Get the String representation of the color used for the Category Axis Label text For example: "#FFFFFF" = white |
String |
getSeriesAxisNumberFormat()
Get the String used to format numbers on the series axis For example: "#,##0.00" |
String |
getSeriesAxisTimeFormat()
Get the String used to format times on the series axis For example: "HH:mm:ss a" |
String |
getSeriesAxisTitleColor()
Get the String representation of the color used for the Category Axis Title text For example: "#FFFFFF" = white |
float |
getSeriesFontSize()
Get the font size scalar used to render the series axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 |
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 |
getTitleCategory()
Get the Category axis title |
String |
getTitleColor()
Get the String representation of the color used for the Chart Title text For example: "#FFFFFF" = white |
float |
getTitleFontSize()
Get the font size scalar used to render the Title text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
String |
getTitlePosition()
Get the Chart title position |
String |
getTitleValue()
Get the Value axis title |
String |
getValueAxisLabelColor()
Get the String representation of the color used for the Value Axis Label text For example: "#FFFFFF" = white |
String |
getValueAxisNumberFormat()
Get the String used to format numbers on the value axis For example: "#,##0.00" |
String |
getValueAxisTitleColor()
Get the String representation of the color used for the Value Axis Title text For example: "#FFFFFF" = white |
float |
getValueFontSize()
Get the font size scalar used to render the value axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 |
isAxisTitleOnEdge()
Return TRUE if the axes titles should be drawn on the edge of the image Note: This property is only applicable for 2D charts. |
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 |
isPieShowValues()
Return True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total) |
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 For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
void |
setAxisTitleOnEdge(boolean onEdge)
Set to TRUE if the axes titles should be drawn on the edge of the image Note: This property is only applicable for 2D charts. |
void |
setBackgroundColorBottom(String backgroundColorBottom)
Set the color used at the bottom of the background gradient For example: "#FFFFFF" = white |
void |
setBackgroundColorTop(String backgroundColorTop)
Set the color used at the top of the background gradient For example: "#FFFFFF" = white |
void |
setCategoryAxisDateFormat(String categoryAxisDateFormat)
Set the String used to format dates on the category axis For example: "MMMM dd, yyyy" |
void |
setCategoryAxisDateTimeFormat(String categoryAxisDateTimeFormat)
Set the String used to format datetimes on the category axis For example: "MMMM dd, yyyy HH:mm:ss a" |
void |
setCategoryAxisLabelColor(String color)
Set the color used for the Category Axis Label text For example: "#FFFFFF" = white |
void |
setCategoryAxisNumberFormat(String categoryAxisNumberFormat)
Set the String used to format numbers on the category axis For example: "#,##0.00" |
void |
setCategoryAxisTimeFormat(String categoryAxisTimeFormat)
Set the String used to format times on the category axis For example: "HH:mm:ss a" |
void |
setCategoryAxisTitleColor(String color)
Set the color used for the Category Axis Title text For example: "#FFFFFF" = white |
void |
setCategoryFontSize(float fontSize)
Set the font size scalar used to render the category axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size)) |
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 For example: "Close" for the HLC or Candlestick charts |
void |
setChartSubTypeHigh(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render For example: "High" for the HLC or Candlestick charts |
void |
setChartSubTypeLow(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render For example: "Low" for the HLC or Candlestick charts |
void |
setChartSubTypeOpen(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render For example: "Open" for Candlestick chart |
void |
setChartSubTypePosition(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render For example: "Position" for Bubble chart |
void |
setChartSubTypeSize(int seriesNumber)
Set the subtype indicating how this series is used by a chart which requires multiple series to render For example: "Size" for Bubble chart |
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); |
void |
setChartTypeArea(int seriesNumber)
Set the chart type for the specified 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); |
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. |
void |
setChartTypeBar(int seriesNumber)
Set the chart type for the specified series to Bar Bar charts use the ColumnType property to determine the type of geometric primitive used to render each bar. |
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. |
void |
setChartTypeBarCluster(int seriesNumber)
Set the chart type for the specified series to BarCluster Bar Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column. |
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. |
void |
setChartTypeBubble(int seriesNumber)
Set the chart type for the specified 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. |
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. |
void |
setChartTypeCandlestick(int seriesNumber)
Set the chart type for the specified 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. |
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 Column charts use the ColumnType property to determine the type of geometric primitive used to render each column. |
void |
setChartTypeColumn(int seriesNumber)
Set the chart type for the specified series to Column Column charts use the ColumnType property to determine the type of geometric primitive used to render each column. |
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. |
void |
setChartTypeColumnCluster(int seriesNumber)
Set the chart type for the specified series to ColumnCluster Column Cluster charts use the ColumnType property to determine the type of geometric primitive used to render each column.* |
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. |
void |
setChartTypeHighLowClose(int seriesNumber)
Set the chart type for the specified series to HighLowClose 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. |
void |
setChartTypeLine()
Set the chart type for all series to Line The width of the lines is specified with the LineWidth property. |
void |
setChartTypeLine(int seriesNumber)
Set the chart type for the specified 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); |
void |
setChartTypeLine3d()
Set the chart type for all series to Line The line markers are optionally displayed depending on the ShowMarkers property. |
void |
setChartTypeLine3d(int seriesNumber)
Set the chart type for the specified series to Line3d The line markers are optionally displayed depending on the ShowMarkers property. |
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). |
void |
setChartTypeMap(int seriesNumber)
Set the chart type for the specified 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). |
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. |
void |
setChartTypePie(int seriesNumber)
Set the chart type for the specified series to Pie The GroupSmallValues & GroupSmallValuesThreshold properties are used to collect small series values into a single pie slice. |
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); |
void |
setChartTypeScatter(int seriesNumber)
Set the chart type for the specified 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); |
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. |
void |
setChartTypeStacked(int seriesNumber)
Set the chart type for the specified series to Stacked Stacked Column charts use the ColumnType property to determine the type of geometric primitive used to render each column. |
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. |
void |
setChartTypeStackedArea(int seriesNumber)
Set the chart type for the specified series to Stacked Area Stacked Area charts are rendered by plotting Area charts for each series and stacking the results. |
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. |
void |
setChartTypeStackedBar(int seriesNumber)
Set the chart type for the specified series to Stacked Bar Stacked Bar charts use the ColumnType property to determine the type of geometric primitive used to render each column. |
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. |
void |
setChartTypeStackedLine(int seriesNumber)
Set the chart type for the specified series to Stacked Line Stacked Line charts are rendered by plotting Line charts for each series and stacking the results. |
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. |
void |
setChartTypeSurface(int seriesNumber)
Set the chart type for the specified series to Surface Surface charts render a single continuous surface whose vertex coordinates are determined by the series category position and data value. |
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 For example: "cube", "cone", "cylinder", "pyramid" |
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 |
setDataLabelColor(String color)
Set the color used for Data Labels For example: "#FFFFFF" = white |
void |
setDataLabelFontSize(float fontSize)
Set the font size scalar used to render the Data Label text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 For example: "#FFFFFF" = white |
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 |
setFontTitle(String font)
Set the font used to render title text. |
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 |
setGridOpacity(float opacity)
Set the opacity used to render the chart grid |
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 The threshold is a percentage of the total of all series values, where 50.0 is 50% and 100.0 is 100%. |
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 For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
void |
setLegendHeight(int legendVerticalSize)
Set the Explicit legend height Used when LegendHeightType is "Exact" |
void |
setLegendHeightType(String heightType)
Set the Legend size type For example: "Stretch", "Fit", "Exact" |
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 For example: "Top Left", "Top Right", "Bottom Left", "Bottom Right" |
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 Used when LegendWidthType is "Exact" |
void |
setLegendWidthType(String widthType)
Set the Legend size type For example: "Stretch", "Fit", "Exact" |
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 For example: "Default", "Bright", "Dark", "Ambient" |
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 For example: "0,100,200,300,400,500" == 0 <= x < 100; 100 <= x < 200; ... |
void |
setMapRangeColors(String mapRangeColors)
Set the String list of colors for map highlighting For example: "red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF" |
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 |
setPieExplodeTopSlices(Integer count)
Set the number of slices to explode, starting with the largest slice and continuing in descending order |
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 |
setPieShowValues(boolean pieShowValues)
Set to True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total) |
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 For example: "MMMM dd, yyyy" |
void |
setSeriesAxisDateTimeFormat(String seriesAxisDateTimeFormat)
Set the String used to format datetimes on the series axis For example: "MMMM dd, yyyy HH:mm:ss a" |
void |
setSeriesAxisLabelColor(String color)
Set the color used for the Category Axis Label text For example: "#FFFFFF" = white |
void |
setSeriesAxisNumberFormat(String seriesAxisNumberFormat)
Set the String used to format numbers on the series axis For example: "#,##0.00" |
void |
setSeriesAxisTimeFormat(String seriesAxisTimeFormat)
Set the String used to format times on the series axis For example: "HH:mm:ss a" |
void |
setSeriesAxisTitleColor(String color)
Set the color used for the Category Axis Title text For example: "#FFFFFF" = white |
void |
setSeriesFontSize(float fontSize)
Set the font size scalar used to render the series axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 |
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 |
setTitleCategory(String titleCategory)
Set the Category axis title |
void |
setTitleColor(String color)
Set the color used for the Chart Title text For example: "#FFFFFF" = white |
void |
setTitleFontSize(float fontSize)
Set the font size scalar used to render the Title text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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" |
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 |
setUseAxisTitleMargin(boolean useMargin)
Set to TRUE if the Value & Category Axis titles are rendered within a margin |
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. |
void |
setValueAxisLabelColor(String color)
Set the color used for the Value Axis Label text For example: "#FFFFFF" = white |
void |
setValueAxisNumberFormat(String valueAxisNumberFormat)
Set the String used to format numbers on the value axis For example: "#,##0.00" |
void |
setValueAxisTitleColor(String color)
Set the color used for the Value Axis Title text For example: "#FFFFFF" = white |
void |
setValueFontSize(float fontSize)
Set the font size scalar used to render the value axis text For example: 0.5 means scale the currently selected font by 50% (reduce to half size) |
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 |
boolean |
useAxisTitleMargin()
Return TRUE if the Value & Category Axis titles are 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 |
---|
void parsePropertiesString(String propertyString)
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)
functionString
- String representation of a functionboolean isValueAxisVertical()
boolean isMultiSeries()
boolean isStacked()
boolean isClustered()
boolean isPie()
boolean isMap()
String getChartTypeString(int seriesNumber)
seriesNumber
- Zero-based series index
void setChartTypeColumn()
void setChartTypeStacked()
void setChartTypeLine()
void setChartTypeLine3d()
void setChartTypePie()
void setChartTypeBar()
void setChartTypeArea()
void setChartTypeScatter()
void setChartTypeBubble()
void setChartTypeStackedArea()
void setChartTypeStackedLine()
void setChartTypeStackedBar()
void setChartTypeHighLowClose()
void setChartTypeCandlestick()
void setChartTypeCloud()
void setChartTypeColumnCluster()
void setChartTypeBarCluster()
void setChartTypeSurface()
void setChartTypeMap()
void setChartTypeColumn(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeStacked(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeLine(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeLine3d(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypePie(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeBar(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeArea(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeScatter(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeBubble(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeStackedArea(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeStackedLine(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeStackedBar(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeSurface(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeHighLowClose(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeCandlestick(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeCloud(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeColumnCluster(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeBarCluster(int seriesNumber)
seriesNumber
- Series Indexvoid setChartTypeMap(int seriesNumber)
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)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 marginboolean useAxisTitleMargin()
void setUseAxisTitleMargin(boolean useMargin)
useMargin
- set to TRUE if the Value & Category Axis titles are rendered within a marginboolean isAxisTitleOnEdge()
void setAxisTitleOnEdge(boolean onEdge)
onEdge
- set to TRUE if the axes titles should be drawn on the edge of the imagefloat 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)
font
- String representation of the font used to render text (axes, legend, title).String getFontTitle()
void setFontTitle(String font)
font
- String representation of the font used to render title text.float getLegendFontSize()
void setLegendFontSize(float fontSize)
fontSize
- the font size scalar used to render the legend textfloat getSeriesFontSize()
void setSeriesFontSize(float fontSize)
fontSize
- the font size scalar used to render the series axis textfloat getCategoryFontSize()
void setCategoryFontSize(float fontSize)
fontSize
- the font size scalar used to render the category axis textfloat getValueFontSize()
void setValueFontSize(float fontSize)
fontSize
- the font size scalar used to render the value axis textfloat getTitleFontSize()
void setTitleFontSize(float fontSize)
fontSize
- the font size scalar used to render the Title textfloat getAxisTitleFontSize()
void setAxisTitleFontSize(float fontSize)
fontSize
- the font size scalar used to render the Title textfloat getDataLabelFontSize()
void setDataLabelFontSize(float fontSize)
fontSize
- the font size scalar used to render the Data LAbel textString getBackgroundColorTop()
void setBackgroundColorTop(String backgroundColorTop)
backgroundColorTop
- String representation of the color used at the top of the background gradientString getBackgroundColorBottom()
void setBackgroundColorBottom(String backgroundColorBottom)
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()
void setFillGridColor(String fillGridColor)
fillGridColor
- String representation of the color used to fill the chart gridfloat getGridOpacity()
void setGridOpacity(float opacity)
opacity
- Value from 0.0 to 1.0 specifying the transparency of the chart gridboolean isGroupSmallValues()
void setGroupSmallValues(boolean groupSmallValues)
groupSmallValues
- True if small values in Pie charts should be grouped togetherfloat getGroupSmallValuesThreshold()
void setGroupSmallValuesThreshold(float groupSmallValuesThreshold)
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()
void setLegendPosition(String position)
position
- Legend positionvoid setLegendPositionTopLeft()
void setLegendPositionTopCenter()
void setLegendPositionTopRight()
void setLegendPositionLeftCenter()
void setLegendPositionRightCenter()
void setLegendPositionBottomLeft()
void setLegendPositionBottomCenter()
void setLegendPositionBottomRight()
String getLegendWidthType()
void setLegendWidthType(String widthType)
widthType
- Legend size typevoid setLegendWidthTypeStretch()
void setLegendWidthTypeFit()
void setLegendWidthTypeExact()
String getLegendHeightType()
void setLegendHeightType(String heightType)
heightType
- Legend size typevoid setLegendHeightTypeStretch()
void setLegendHeightTypeFit()
void setLegendHeightTypeExact()
int getLegendWidth()
void setLegendWidth(int legendHorizontalSize)
legendHorizontalSize
- Exact legend widthint getLegendHeight()
void setLegendHeight(int legendVerticalSize)
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)
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()
void setLighting(String lighting)
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 slicesboolean isPieShowValues()
void setPieShowValues(boolean pieShowValues)
pieShowValues
- True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total)float getPieExplode()
void setPieExplode(float pieExplode)
pieExplode
- Distance to which pie slices are exploded from the center of the Pie Chartvoid setPieExplodeTopSlices(Integer count)
count
- The number of top slices to explodeInteger getPieExplodeTopSlices()
float 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()
void setValueAxisNumberFormat(String valueAxisNumberFormat)
valueAxisNumberFormat
- String used to format numbers on the value axisString getCategoryAxisDateTimeFormat()
void setCategoryAxisDateTimeFormat(String categoryAxisDateTimeFormat)
categoryAxisDateTimeFormat
- String used to format datetimes on the category axisString getCategoryAxisTimeFormat()
void setCategoryAxisTimeFormat(String categoryAxisTimeFormat)
categoryAxisTimeFormat
- String used to format times on the category axisString getCategoryAxisDateFormat()
void setCategoryAxisDateFormat(String categoryAxisDateFormat)
categoryAxisDateFormat
- String used to format dates on the category axisString getCategoryAxisNumberFormat()
void setCategoryAxisNumberFormat(String categoryAxisNumberFormat)
categoryAxisNumberFormat
- String used to format numbers on the category axisString getSeriesAxisDateTimeFormat()
void setSeriesAxisDateTimeFormat(String seriesAxisDateTimeFormat)
seriesAxisDateTimeFormat
- String used to format datetimes on the series axisString getSeriesAxisTimeFormat()
void setSeriesAxisTimeFormat(String seriesAxisTimeFormat)
seriesAxisTimeFormat
- String used to format times on the series axisString getSeriesAxisDateFormat()
void setSeriesAxisDateFormat(String seriesAxisDateFormat)
seriesAxisDateFormat
- String used to format dates on the series axisString getSeriesAxisNumberFormat()
void setSeriesAxisNumberFormat(String seriesAxisNumberFormat)
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()
void setMapRange(String mapRange)
mapRange
- String list of ranges for map highlightingString getMapRangeColors()
void setMapRangeColors(String mapRangeColors)
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)
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeLow(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeClose(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeOpen(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setChartSubTypePosition(int seriesNumber)
seriesNumber
- Zero-based index of seriesvoid setChartSubTypeSize(int seriesNumber)
seriesNumber
- Zero-based index of seriesString getColumnTypeString(int seriesNumber)
seriesNumber
- Zero-based index of series
void setColumnType(int seriesNumber, String columnType)
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 displayedString 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()
String getTitleColor()
void setTitleColor(String color)
color
- String representation of the color used for the Chart Title textString getDataLabelColor()
void setDataLabelColor(String color)
color
- String representation of the color used for Data LabelsString getValueAxisLabelColor()
void setValueAxisLabelColor(String color)
color
- String representation of the color used for the Value Axis Label textString getCategoryAxisLabelColor()
void setCategoryAxisLabelColor(String color)
color
- String representation of the color used for the Category Axis Label textString getSeriesAxisLabelColor()
void setSeriesAxisLabelColor(String color)
color
- String representation of the color used for the Category Axis Label textString getValueAxisTitleColor()
void setValueAxisTitleColor(String color)
color
- String representation of the color used for the Value Axis Title textString getCategoryAxisTitleColor()
void setCategoryAxisTitleColor(String color)
color
- String representation of the color used for the Category Axis Title textString getSeriesAxisTitleColor()
void setSeriesAxisTitleColor(String color)
color
- String representation of the color used for the Category Axis Title text
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |