Interface AQChartProperties


  • 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:
    ChartProperties provide an interface to query and modify attributes of the chart's appearance.

    Chart Type
    The type of chart used to render the model data

    • column
    • columncluster
    • stacked
    • bar
    • barcluster
    • stackedbar
    • line
    • line3d
    • stackedline
    • area
    • stackedarea
    • pie
    • surface
    • scatter
    • bubble
    • highlowclose
    • candlestick
    • cloud
    • map

    Rotation X
    Rotation around the X-axis (in screen space, the horizontal axis pointing left and right)

    Rotation Y
    Rotation around the Y-axis (in screen space, the vertical axis pointing up and down)

    Rotation Z
    Rotation around the Z-axis (in screen space, the axis pointing out of the screen)

    Zoom
    Camera zoom, specified as a floating point value in which
    1.0 is the default (no zoom)
    0.5 zooms out by 50% (objects appear smaller)
    2.0 zooms in by 2x (objects appear larger)

    ShowLegend
    If True, then the Legend is visible
    If False, then the Legend is hidden

    ShowLegendBorder
    If True, then the Legend Border is visible
    If False, then the Legend Border is hidden

    ShowGrid
    If True, then the Grid is visible
    If False, then the Grid is hidden

    FillGrid
    If True, then fill the Grid with alternating colors
    If False, then only render the grid lines

    GridLineWidth
    Width of Grid Lines

    PieExplode
    Explodes pie chart slices by the specified amount (floating point distance from the pie center)

    GroupSmallValues
    If True, then group small values into a single pie slice

    SmallValuesThreshold
    If GroupSmallValues is True, then all values less than this this threshold are grouped into a single pie slice

    PieLabelDistance
    Distance between pie slice and its label

    PieShowLines
    If True, then show lines connecting the pie slice and its label

    LineWidth
    Width of lines in Line charts

    ShowMarkers
    If True, then show markers/dots in Line charts

    MapShowBackground
    If True, then show the a background map image

    MapShowDetails
    If True, then show country details in the mouseover tooltip (e.g. population, currency & area in square miles)

    Width
    Width of chart grid (on X-axis)

    Height
    Height of chart grid (on Y-axis)

    Depth
    Depth of chart grid (on Z-axis)

    SeriesSpacing
    Space between series geometry (on Z-axis)

    CategorySpacing
    Space between category geometry (on X-axis)

    Font
    Font used to render text

    LegendFontSize
    Font size used in Legend

    SeriesFontSize
    Font size used on Series Axis

    CategoryFontSize
    Font size used on Category Axis

    ValueFontSize
    Font size used on Value Axis

    TitleFontSize
    Font size used for the Chart Title

    AxisTitleFontSize
    Font size used for the Axis Titles

    DataLabelFontSize
    Font size used for the Data Labels

    TopColor
    Color used for top of background gradient

    BottomColor
    Color used for bottom of background gradient

    PanX
    Camera panning on the X-axis

    PanY
    Camera panning on the Y-axis

    Lighting
    Lighting model used to illuminate chart geometry

    • Default: Objects are lit with a medium-intensity light source
    • Bright: Objects are lit with a bright light source
    • Dark: Objects are lit with a dim light source
    • Ambient: Objects are lit uniformly, without shading

    Opacity
    Value from 0.0 to 1.0 specifying the transparency of chart geometry.

    View2D
    If True, then render the chart in 2D
    If False, then render the chart in 3D (the default)

    StackedPercent
    If True, then Stacked charts are scaled to fit the range of 0 to 100% (where 100% is the sum of the max values for each series)

    ShowDataLabels
    If True, then labels should be displayed at each data point

    ShowValueAxis
    If True, then show the Value axis

    ShowValueAxisTicks
    If True, then show the Value axis tick marks

    ShowValueAxisLines
    If True, then show the Value axis grid lines

    ReverseValueAxis
    If True, then reverse the order of the value axis (so values are displayed in descending order as the Y value increases)

    ShowCategoryAxis
    If True, then show the Category axis

    ShowCategoryAxisTicks
    If True, then show the Category axis tick marks

    ShowCategoryAxisLines
    If True, then show the Category axis grid lines

    ShowSeriesAxis
    If True, then show the Series axis

    NumericCategoryAxis
    If True, then plot categories on a numeric category axis

    MergeAxis
    If True, then plot all series on the same value axis
    If False, then plot each series on its own value axis

    CategoryTextLength
    Maximum text length (in characters) of the labels on the Category axis

    SeriesTextLength
    Maximum text length (in characters) of the labels on the Series axis

    SeriesAlias
    List of one or more alternate string names for each series

    SeriesFunction
    Functions used to create additional series of calculated values

    • Zero: For each row, return zero
    • Add: For each row, add the value of the first series to the value of the second series
    • Subtract: For each row, subtract the value of the second series from the value of the first series
    • Scalar: For each row, multiply the series value by the specified scalar
    • Power: For each row, raise the series value to the specified power
    • Log: For each row, find the logarithm of the series value using the specified base
    • Average: Compute the average of all series values, and place that value into every row
    • Moving Average: For each row, find the average of all series values within the specified range
    • Linear Regression: Perform regression analysis on all series values, then compute the function series values using the slope & y-intercept

    SeriesSubType
    Descriptor indicating how series values are to be applied to a multi-series chart
    Migh-Low-Close supports three types: High, Low and CLose
    Bubble supports two types: Position and Size
    Candlestick supports four types: High, Low, Open and Close

    SeriesColumnType
    Geometric primitive used to render column charts

    • Cube
    • Cone
    • Cylinder
    • Pyramid

    SeriesMin
    Min value for one or more series. If Default, then use the min calculated from the model data.

    SeriesMax
    Max value for one or more series. If Default, then use the max calculated from the model data.

    SeriesColor
    List of colors for each series

    SeriesFunctionMetaData
    If True, then show any metadata generated by a series function

    LegendPosition
    Position of Legend

    • Top Right
    • Top Center
    • Top Left
    • Left Center
    • Right Center
    • Bottom Right
    • Bottom Center
    • Bottom Left

    LegendWidthType
    Method of setting legend width

    • Fit: Find the minimum width that fits the content of the legend
    • Stretch: Stretch the legend to fit the width of the chart rendering area
    • Exact: Set the width to value specified in the LegendWidth property

    LegendWidth
    Width of chart when Width Type is Exact

    LegendHeightType
    Method of setting legend height

    • Fit: Find the minimum height that fits the content of the legend
    • Stretch: Stretch the legend to fit the height of the chart rendering area
    • Exact: Set the height to value specified in the LegendWidth property

    LegendHeight
    Height of chart when Height Type is Exact

    ShowFixedCategoryCount
    If True, then only display the specified number of categories

    FixedCategoryCount
    The number of categories to be displayed

    CategoryAxisNumberFormat
    String used to format numbers on the Category axis

    CategoryAxisDateFormat
    String used to format dates on the Category axis

    CategoryAxisDateTimeFormat
    String used to format datetimes on the Category axis

    CategoryAxisTimeFormat
    String used to format times on the Category axis

    SeriesAxisNumberFormat
    String used to format numbers on the Series axis

    SeriesAxisDateFormat
    String used to format dates on the Series axis

    SeriesAxisDateTimeFormat
    String used to format datetimes on the Series axis

    SeriesAxisTimeFormat
    String used to format times on the Series axis

    Title
    The Chart Title

    Title Position
    The position of the Chart Title

    • Top Left
    • Top Center
    • Top Right
    • Left Center
    • Right Center
    • Bottom Left
    • Bottom Center
    • Bottom Right
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addFunctionSeries()
      Add a series of data generated by a function
      void addFunctionSeries​(java.lang.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
      java.lang.String getBackgroundColorBottom()
      Get the String representation of the color used at the bottom of the background gradient
      java.lang.String getBackgroundColorTop()
      Get the String representation of the color used at the top of the background gradient
      java.lang.String getCategoryAxisDateFormat()
      Get the String used to format dates on the category axis
      java.lang.String getCategoryAxisDateTimeFormat()
      Get the String used to format datetimes on the category axis
      java.lang.String getCategoryAxisLabelColor()
      Get the String representation of the color used for the Category Axis Label text
      java.lang.String getCategoryAxisNumberFormat()
      Get the String used to format numbers on the category axis
      java.lang.String getCategoryAxisTimeFormat()
      Get the String used to format times on the category axis
      java.lang.String getCategoryAxisTitleColor()
      Get the String representation of the color used for the Category Axis Title text
      float getCategoryFontSize()
      Get the font size scalar used to render the category axis text
      java.lang.Integer getCategoryRangeEnd()
      Get the Index of the last row to be displayed
      java.lang.Integer getCategoryRangeStart()
      Get the Index of the first row to be displayed
      float getCategorySpacing()
      Get the Spacing between category geometry (in world coordinate units)
      java.lang.Integer getCategoryTextLength()
      Get the maximum text length (in characters) of the labels on the Category axis.
      java.lang.String getChartSubTypeString​(int seriesNumber)
      Get the Subtype indicating how this series is used by a multi-series chart (e.g.
      java.lang.String getChartTypeString​(int seriesNumber)
      Get the string name of the chart used to render the specified series.
      java.lang.String getColor​(int seriesNumber)
      Get the Color used to render series geometry
      java.lang.String getColumnTypeString​(int seriesNumber)
      Get the Type of geometry to use when rendering a column or bar chart
      java.lang.String getDataLabelColor()
      Get the String representation of the color used for Data Labels
      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).
      java.lang.String getFillGridColor()
      Get the String representation of the color used to fill the chart grid
      int getFixedCategoryCount()
      Get the Number of categories being displayed
      java.lang.String getFont()
      Get the String representation of the Font used to render text (axes, legend, title)
      java.lang.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
      java.lang.String getFunctionName​(int seriesNumber)
      Get the Name of function used to generate this series
      java.lang.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
      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).
      java.lang.Integer getImageHeight()
      Get the Chart Image height
      java.lang.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
      java.lang.String getLegendHeightType()
      Get the Legend size type
      java.lang.String getLegendPosition()
      Get the Legend position
      int getLegendWidth()
      Get the Exact legend width
      java.lang.String getLegendWidthType()
      Get the Legend size type
      java.lang.String getLighting()
      Get the Lighting type
      float getLineWidth()
      Get the Width of lines in Line Chart
      java.lang.String getMapRange()
      Get the String list of ranges for map highlighting
      java.lang.String getMapRangeColors()
      Get the String list of colors for map highlighting
      java.lang.Double getMax​(int seriesNumber)
      Get the Maximum value on this series' value axis (overrides maximum value found in data model)
      java.lang.Double getMergeSeriesMax()
      Get the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model)
      java.lang.Double getMergeSeriesMin()
      Get the Minimum value on the merged value axis shared by all series (overrides minimum value found in data model)
      java.lang.Double getMin​(int seriesNumber)
      Get the Minimum value on this series' value axis (overrides minimum value found in data model)
      java.lang.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
      java.lang.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
      java.lang.String getSeriesAxisDateFormat()
      Get the String used to format dates on the series axis
      java.lang.String getSeriesAxisDateTimeFormat()
      Get the String used to format datetimes on the series axis
      java.lang.String getSeriesAxisLabelColor()
      Get the String representation of the color used for the Category Axis Label text
      java.lang.String getSeriesAxisNumberFormat()
      Get the String used to format numbers on the series axis
      java.lang.String getSeriesAxisTimeFormat()
      Get the String used to format times on the series axis
      java.lang.String getSeriesAxisTitleColor()
      Get the String representation of the color used for the Category Axis Title text
      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)
      java.lang.Integer getSeriesTextLength()
      Get the maximum text length (in characters) of the labels on the Series axis.
      java.lang.String getTheme()
      Get the color theme Color themes control the background gradient colors, the per-series colors and the font colors
      java.lang.String getTitle()
      Get the Chart title
      java.lang.String getTitleCategory()
      Get the Category axis title
      java.lang.String getTitleColor()
      Get the String representation of the color used for the Chart Title text
      float getTitleFontSize()
      Get the font size scalar used to render the Title text
      java.lang.String getTitlePosition()
      Get the Chart title position
      java.lang.String getTitleValue()
      Get the Value axis title
      java.lang.String getValueAxisLabelColor()
      Get the String representation of the color used for the Value Axis Label text
      java.lang.String getValueAxisNumberFormat()
      Get the String used to format numbers on the value axis
      java.lang.String getValueAxisTitleColor()
      Get the String representation of the color used for the Value Axis Title text
      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 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​(java.lang.String key, java.lang.String value)
      Update a chart property using the specified string values
      void parsePropertiesString​(java.lang.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 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​(java.lang.String backgroundColorBottom)
      Set the color used at the bottom of the background gradient
      void setBackgroundColorTop​(java.lang.String backgroundColorTop)
      Set the color used at the top of the background gradient
      void setCategoryAxisDateFormat​(java.lang.String categoryAxisDateFormat)
      Set the String used to format dates on the category axis
      void setCategoryAxisDateTimeFormat​(java.lang.String categoryAxisDateTimeFormat)
      Set the String used to format datetimes on the category axis
      void setCategoryAxisLabelColor​(java.lang.String color)
      Set the color used for the Category Axis Label text
      void setCategoryAxisNumberFormat​(java.lang.String categoryAxisNumberFormat)
      Set the String used to format numbers on the category axis
      void setCategoryAxisTimeFormat​(java.lang.String categoryAxisTimeFormat)
      Set the String used to format times on the category axis
      void setCategoryAxisTitleColor​(java.lang.String color)
      Set the color used for the Category Axis Title text
      void setCategoryFontSize​(float fontSize)
      Set the font size scalar used to render the category axis text
      void setCategoryRange​(java.lang.Integer startRow, java.lang.Integer endRow)
      Display only the categories & values between the specified rows (inclusive)
      void setCategoryRangeEnd​(java.lang.Integer endRow)
      Display only the categories & values before the specified row (inclusive)
      void setCategoryRangeStart​(java.lang.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​(java.lang.Integer textLength)
      Set the maximum text length (in characters) of the labels on the Category axis.
      void setChartSubType​(int seriesNumber, java.lang.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, java.lang.String color)
      Set the color used to render series geometry
      void setColumnType​(int seriesNumber, java.lang.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 setDataLabelColor​(java.lang.String color)
      Set the color used for Data Labels
      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​(java.lang.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​(java.lang.String font)
      Set the font used to render text (axes, legend, title).
      void setFontTitle​(java.lang.String font)
      Set the font used to render title text.
      void setFunction​(int seriesNumber, java.lang.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
      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​(java.lang.Integer imageHeight)
      Set the Chart Image Height
      void setImageWidth​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String mapRange)
      Set the String list of ranges for map highlighting
      void setMapRangeColors​(java.lang.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, java.lang.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​(java.lang.Double mergeSeriesMax)
      Set the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model)
      void setMergeSeriesMin​(java.lang.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, java.lang.Double min)
      Set the Minimum value on this series' value axis (overrides minimum value found in data model)
      void setNameAlias​(int seriesNumber, java.lang.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​(java.lang.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​(java.lang.String seriesAxisDateFormat)
      Set the String used to format dates on the series axis
      void setSeriesAxisDateTimeFormat​(java.lang.String seriesAxisDateTimeFormat)
      Set the String used to format datetimes on the series axis
      void setSeriesAxisLabelColor​(java.lang.String color)
      Set the color used for the Category Axis Label text
      void setSeriesAxisNumberFormat​(java.lang.String seriesAxisNumberFormat)
      Set the String used to format numbers on the series axis
      void setSeriesAxisTimeFormat​(java.lang.String seriesAxisTimeFormat)
      Set the String used to format times on the series axis
      void setSeriesAxisTitleColor​(java.lang.String color)
      Set the color used for the Category Axis Title text
      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​(java.lang.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​(java.lang.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​(java.lang.String title)
      Set the Chart Title
      void setTitleCategory​(java.lang.String titleCategory)
      Set the Category axis title
      void setTitleColor​(java.lang.String color)
      Set the color used for the Chart Title text
      void setTitleFontSize​(float fontSize)
      Set the font size scalar used to render the Title text
      void setTitlePosition​(java.lang.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​(java.lang.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​(java.lang.String color)
      Set the color used for the Value Axis Label text
      void setValueAxisNumberFormat​(java.lang.String valueAxisNumberFormat)
      Set the String used to format numbers on the value axis
      void setValueAxisTitleColor​(java.lang.String color)
      Set the color used for the Value Axis Title text
      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
      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

      • parsePropertiesString

        void parsePropertiesString​(java.lang.String propertyString)
        Update the chart properties by parsing the specified string into name-value pairs.

        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"

        Parameters:
        propertyString - String containing name-value pairs in the format: 'title="My Chart", Chart="{column}"'
      • loadProperty

        void loadProperty​(java.lang.String key,
                          java.lang.String value)
        Update a chart property using the specified string values
        Parameters:
        key - String property key
        value - String property value
      • copy

        void copy​(AQChartProperties properties)
        Copy the specified properties into this properties instance
        Parameters:
        properties - Properties to be copied
      • addFunctionSeries

        void addFunctionSeries()
        Add a series of data generated by a function
      • addFunctionSeries

        void addFunctionSeries​(java.lang.String functionString)
        Add a series of data generated by a function.

        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

        Parameters:
        functionString - String representation of a function
      • isValueAxisVertical

        boolean isValueAxisVertical()
        Return true if the value axis is oriented vertically or horizontally.

        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)

        Returns:
        True if the value axis is vertical or horizontal (e.g. bar charts use a horizontal value axis)
      • isMultiSeries

        boolean isMultiSeries()
        Return true if the current chart renders multiple series (e.g. Pie, Map, High-Low-Close, Candlestick, Bubble, ...)
        Returns:
        True if the current chart type renders multiple series
      • isStacked

        boolean isStacked()
        Return true if the current chart type is a stacked chart (e.g. Stacked, Stacked Line, Stacked Bar)
        Returns:
        True if the current chart type is a stacked chart
      • isClustered

        boolean isClustered()
        Return true if the current chart type is a clustered chart (e.g. Column Cluster, Bar Cluster)
        Returns:
        True if the current chart type is a clustered chart
      • isPie

        boolean isPie()
        Return true if the current chart type is a pie chart
        Returns:
        True if the current chart type is a pie chart
      • isMap

        boolean isMap()
        Return true if the current chart type is a map chart
        Returns:
        True if the current chart type is a map chart
      • getChartTypeString

        java.lang.String getChartTypeString​(int seriesNumber)
        Get the string name of the chart used to render the specified series.
        Parameters:
        seriesNumber - Zero-based series index
        Returns:
        Chart type of specified series
      • setChartTypeColumn

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

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

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

      • setChartTypeStacked

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

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

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

      • setChartTypeLine

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

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

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

      • setChartTypeLine3d

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

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

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

      • setChartTypePie

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

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

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

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

      • setChartTypeBar

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

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

      • setChartTypeArea

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

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

      • setChartTypeScatter

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

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

      • setChartTypeBubble

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

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

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

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

      • setChartTypeStackedArea

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

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

      • setChartTypeStackedLine

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

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

      • setChartTypeStackedBar

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

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

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

      • setChartTypeHighLowClose

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

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

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

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

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

      • setChartTypeCandlestick

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

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

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

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

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

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

      • setChartTypeCloud

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

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

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

      • setChartTypeBarCluster

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

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

      • setChartTypeSurface

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

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

      • setChartTypeMap

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

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

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

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

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

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

      • setChartTypeColumn

        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.

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeStacked

        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.

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

        Parameters:
        seriesNumber - Series Index
      • setChartTypeLine

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeLine3d

        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.

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypePie

        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.

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeBar

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeArea

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeScatter

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeBubble

        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.

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeStackedArea

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeStackedLine

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeStackedBar

        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.

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

        Parameters:
        seriesNumber - Series Index
      • setChartTypeSurface

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeHighLowClose

        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.

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeCandlestick

        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.

        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);

        Parameters:
        seriesNumber - Series Index
      • setChartTypeCloud

        void setChartTypeCloud​(int seriesNumber)
        Set the chart type for the specified series to Cloud
        Parameters:
        seriesNumber - Series Index
      • setChartTypeColumnCluster

        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.*

        Parameters:
        seriesNumber - Series Index
      • setChartTypeBarCluster

        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.

        Parameters:
        seriesNumber - Series Index
      • setChartTypeMap

        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).

        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);

        Parameters:
        seriesNumber - Series Index
      • getRotationX

        int getRotationX()
        Get the camera rotation around X-axis
        Returns:
        Camera rotation around X-axis
      • setRotationX

        void setRotationX​(int rotationX)
        Set the camera rotation around X-axis
        Parameters:
        rotationX - Camera rotation around X-axis
      • getRotationY

        int getRotationY()
        Get the camera rotation around X-axis
        Returns:
        Camera rotation around X-axis
      • setRotationY

        void setRotationY​(int rotationY)
        Set the camera rotation around Y-axis
        Parameters:
        rotationY - Camera rotation around Y-axis
      • getRotationZ

        int getRotationZ()
        Get the camera rotation around Z-axis
        Returns:
        Camera rotation around Z-axis
      • setRotationZ

        void setRotationZ​(int rotationZ)
        Set the camera rotation around Z-axis
        Parameters:
        rotationZ - Camera rotation around Z-axis
      • getZoom

        float getZoom()
        Get the camera zoom
        Returns:
        Camera zoom
      • setZoom

        void setZoom​(float zoom)
        Set the camera zoom
        Parameters:
        zoom - Camera zoom
      • getPanX

        float getPanX()
        Get the camera pan on the X-axis
        Returns:
        Camera pan on the X-axis
      • setPanX

        void setPanX​(float panX)
        Set the camera pan on the X-axis
        Parameters:
        panX - Camera pan on the X-axis
      • getPanY

        float getPanY()
        Get the camera pan on the Y-axis
        Returns:
        Camera pan on the Y-axis
      • setPanY

        void setPanY​(float panY)
        Set the camera pan on the Y-axis
        Parameters:
        panY - Camera pan on the Y-axis
      • getImageWidth

        java.lang.Integer getImageWidth()
        Get the Chart Image Width
        Returns:
        Chart Image Width
      • setImageWidth

        void setImageWidth​(java.lang.Integer imageWidth)
        Set the Chart Image Width
        Parameters:
        imageWidth - Width of Image, or null (to use the width of rendering surface)
      • getImageHeight

        java.lang.Integer getImageHeight()
        Get the Chart Image height
        Returns:
        Image height
      • setImageHeight

        void setImageHeight​(java.lang.Integer imageHeight)
        Set the Chart Image Height
        Parameters:
        imageHeight - Height of Image, or null (to use the height of rendering surface)
      • useLegendMargin

        boolean useLegendMargin()
        Return TRUE if the legend is rendered within a margin
        Returns:
        TRUE if the legend is rendered within a margin
      • setUseLegendMargin

        void setUseLegendMargin​(boolean useMargin)
        Set to TRUE if the legend is rendered within a margin
        Parameters:
        useMargin - set to TRUE if the legend is rendered within a margin
      • useTitleMargin

        boolean useTitleMargin()
        Return TRUE if the chart title is rendered within a margin
        Returns:
        TRUE if the chart title is rendered within a margin
      • setUseTitleMargin

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

        boolean useAxisTitleMargin()
        Return TRUE if the Value & Category Axis titles are rendered within a margin Note: This property is only applicable for 2D charts.
        Returns:
        TRUE if the Value & Category Axis titles are rendered within a margin
      • setUseAxisTitleMargin

        void setUseAxisTitleMargin​(boolean useMargin)
        Set to TRUE if the Value & Category Axis titles are rendered within a margin
        Parameters:
        useMargin - set to TRUE if the Value & Category Axis titles are rendered within a margin
      • isAxisTitleOnEdge

        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.
        Returns:
        TRUE if the axes titles should be drawn on the edge of the image
      • setAxisTitleOnEdge

        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.
        Parameters:
        onEdge - set to TRUE if the axes titles should be drawn on the edge of the image
      • getWidth

        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).
        Returns:
        Width of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • setWidth

        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).
        Parameters:
        width - Width of chart (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • getHeight

        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).
        Returns:
        Height of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • setHeight

        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).
        Parameters:
        height - Height of chart chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • getDepth

        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).
        Returns:
        Depth of the chart grid (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • setDepth

        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).
        Parameters:
        depth - Depth of chart (in world coordinate units, where each grid cell is 1.0 units in width & height)
      • getCategorySpacing

        float getCategorySpacing()
        Get the Spacing between category geometry (in world coordinate units)
        Returns:
        Spacing between category geometry (in world coordinate units)
      • setCategorySpacing

        void setCategorySpacing​(float spacingX)
        Set the Spacing between category geometry (in world coordinate units)
        Parameters:
        spacingX - Spacing between category geometry (in world coordinate units)
      • getSeriesSpacing

        float getSeriesSpacing()
        Get the Spacing between series geometry (in world coordinate units)
        Returns:
        Spacing between series geometry (in world coordinate units)
      • setSeriesSpacing

        void setSeriesSpacing​(float spacingZ)
        Set the Spacing between series geometry (in world coordinate units)
        Parameters:
        spacingZ - Spacing between series geometry (in world coordinate units)
      • getCategoryTextLength

        java.lang.Integer getCategoryTextLength()
        Get the maximum text length (in characters) of the labels on the Category axis.
        Returns:
        Maximum length of category label text (in characters)
      • setCategoryTextLength

        void setCategoryTextLength​(java.lang.Integer textLength)
        Set the maximum text length (in characters) of the labels on the Category axis.
        Parameters:
        textLength - Maximum length of category label text (in characters)
      • getSeriesTextLength

        java.lang.Integer getSeriesTextLength()
        Get the maximum text length (in characters) of the labels on the Series axis.
        Returns:
        Maximum length of series label text (in characters)
      • setSeriesTextLength

        void setSeriesTextLength​(java.lang.Integer textLength)
        Set the maximum text length (in characters) of the labels on the Series axis.
        Parameters:
        textLength - Maximum length of series label text (in characters)
      • getFont

        java.lang.String getFont()
        Get the String representation of the Font used to render text (axes, legend, title)
        Returns:
        String representation of the Font used to render text (axes, legend, title)
      • setFont

        void setFont​(java.lang.String font)
        Set the font used to render text (axes, legend, title).

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

        Parameters:
        font - String representation of the font used to render text (axes, legend, title).
      • getFontTitle

        java.lang.String getFontTitle()
        Get the String representation of the Font used to render title text.
        Returns:
        String representation of the Font used to render title text.
      • setFontTitle

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

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

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

        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)

        Returns:
        the font size scalar used to render the legend text
      • setLegendFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the legend text
      • getSeriesFontSize

        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)

        Returns:
        the font size scalar used to render the series axis text
      • setSeriesFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the series axis text
      • getCategoryFontSize

        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)

        Returns:
        the font size scalar used to render the category axis text
      • setCategoryFontSize

        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))

        Parameters:
        fontSize - the font size scalar used to render the category axis text
      • getValueFontSize

        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)

        Returns:
        the font size scalar used to render the value axis text
      • setValueFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the value axis text
      • getTitleFontSize

        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)

        Returns:
        the font size scalar used to render the Title text
      • setTitleFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the Title text
      • getAxisTitleFontSize

        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)

        Returns:
        the font size scalar used to render the Axis Title text
      • setAxisTitleFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the Title text
      • getDataLabelFontSize

        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)

        Returns:
        the font size scalar used to render the Data Label text
      • setDataLabelFontSize

        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)

        Parameters:
        fontSize - the font size scalar used to render the Data LAbel text
      • getBackgroundColorTop

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

        For example:
        "#FFFFFF" = white

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

        void setBackgroundColorTop​(java.lang.String backgroundColorTop)
        Set the color used at the top of the background gradient

        For example:
        "#FFFFFF" = white

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

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

        For example:
        "#FFFFFF" = white

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

        void setBackgroundColorBottom​(java.lang.String backgroundColorBottom)
        Set the color used at the bottom of the background gradient

        For example:
        "#FFFFFF" = white

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

        boolean isShowGrid()
        Return True if the grid is shown, False if the grid is hidden
        Returns:
        True if the grid is shown
      • setShowGrid

        void setShowGrid​(boolean showGrid)
        Set to True if the grid is shown, False if the grid is hidden
        Parameters:
        showGrid - True if the grid is shown, False if the grid is hidden
      • getGridLineWidth

        float getGridLineWidth()
        Return the width of the grid lines
        Returns:
        the width of the grid lines
      • setGridLineWidth

        void setGridLineWidth​(float lineWidth)
        Set the width of the grid lines
        Parameters:
        lineWidth - Grid Line Width
      • isFillGrid

        boolean isFillGrid()
        Return True if the grid is filled, False if only the grid lines are shown
        Returns:
        True if the grid is filled, False if only the grid lines are shown
      • setFillGrid

        void setFillGrid​(boolean fillGrid)
        Set to True to fill the grid, False to only show the grid lines
        Parameters:
        fillGrid - True to fill the grid, False to only show the grid lines
      • getFillGridColor

        java.lang.String getFillGridColor()
        Get the String representation of the color used to fill the chart grid

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used to fill the chart grid
      • setFillGridColor

        void setFillGridColor​(java.lang.String fillGridColor)
        Set the color used to fill the chart grid

        For example:
        "#FFFFFF" = white

        Parameters:
        fillGridColor - String representation of the color used to fill the chart grid
      • getGridOpacity

        float getGridOpacity()
        Get the opacity used to render the chart grid
        Returns:
        Value from 0.0 to 1.0 specifying the transparency of the chart grid
      • setGridOpacity

        void setGridOpacity​(float opacity)
        Set the opacity used to render the chart grid
        Parameters:
        opacity - Value from 0.0 to 1.0 specifying the transparency of the chart grid
      • isGroupSmallValues

        boolean isGroupSmallValues()
        Return True if small values in Pie charts should be grouped together
        Returns:
        True if small values in Pie charts should be grouped together
      • setGroupSmallValues

        void setGroupSmallValues​(boolean groupSmallValues)
        Set to True if small values in Pie charts should be grouped together
        Parameters:
        groupSmallValues - True if small values in Pie charts should be grouped together
      • getGroupSmallValuesThreshold

        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%.

        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.

        Returns:
        Threshold value used to group together smaller values in Pie charts
      • setGroupSmallValuesThreshold

        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%.

        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.

        Parameters:
        groupSmallValuesThreshold - Threshold value used to group together smaller values in Pie charts
      • isMergeAxis

        boolean isMergeAxis()
        Return True if all series should share a common value axis, False if each series should have its own value axis
        Returns:
        True if all series should share a common value axis, False if each series should have its own value axis
      • setMergeAxis

        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
        Parameters:
        multiAxis - True if all series should share a common value axis, False if each series should have its own value axis
      • isShowFixedCategoryCount

        boolean isShowFixedCategoryCount()
        Return True if there is a fixed number of categories being displayed, False if no limits are imposed
        Returns:
        True if there is a fixed number of categories being displayed, False if no limits are imposed
      • setShowFixedCategoryCount

        void setShowFixedCategoryCount​(boolean showTopCount)
        Set to True if there is a fixed number of categories being displayed, False if no limits are imposed
        Parameters:
        showTopCount - True if there is a fixed number of categories being displayed, False if no limits are imposed
      • getFixedCategoryCount

        int getFixedCategoryCount()
        Get the Number of categories being displayed
        Returns:
        Number of categories being displayed
      • setFixedCategoryCount

        void setFixedCategoryCount​(int topCount)
        Set the Number of categories being displayed
        Parameters:
        topCount - Number of categories being displayed
      • setCategoryRange

        void setCategoryRange​(java.lang.Integer startRow,
                              java.lang.Integer endRow)
        Display only the categories & values between the specified rows (inclusive)
        Parameters:
        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)
      • setCategoryRangeStart

        void setCategoryRangeStart​(java.lang.Integer startRow)
        Display only the categories & values after the specified row (inclusive)
        Parameters:
        startRow - Index of first row to be displayed, or null to use the default starting row index (0)
      • setCategoryRangeEnd

        void setCategoryRangeEnd​(java.lang.Integer endRow)
        Display only the categories & values before the specified row (inclusive)
        Parameters:
        endRow - Index of last row to be displayed, or null to use the default ending row index (rowCount - 1)
      • getCategoryRangeStart

        java.lang.Integer getCategoryRangeStart()
        Get the Index of the first row to be displayed
        Returns:
        Index of the first row to be displayed
      • getCategoryRangeEnd

        java.lang.Integer getCategoryRangeEnd()
        Get the Index of the last row to be displayed
        Returns:
        Index of the last row to be displayed
      • getLineWidth

        float getLineWidth()
        Get the Width of lines in Line Chart
        Returns:
        Width of lines in Line Chart
      • setLineWidth

        void setLineWidth​(float lineWidth)
        Set the Width of lines in Line Chart
        Parameters:
        lineWidth - Width of lines in Line Chart
      • isView2D

        boolean isView2D()
        Return True if the chart is rendered in 2D, False if rendered in 3D
        Returns:
        True if the chart is rendered in 2D, False if rendered in 3D
      • setView2D

        void setView2D​(boolean view2D)
        Set to True if the chart is rendered in 2D, False if rendered in 3D
        Parameters:
        view2D - True if the chart is rendered in 2D, False if rendered in 3D
      • isFitChartToImage

        boolean isFitChartToImage()
        Return True if the chart should be rendered flush with the edges of the image area
        Returns:
        True if the chart should be rendered flush with the edges of the image area
      • setFitChartToImage

        void setFitChartToImage​(boolean fitChartToImage)
        Set to True if the chart should be rendered flush with the edges of the image area
        Parameters:
        fitChartToImage - True if the chart should be rendered flush with the edges of the image area
      • isShowLegend

        boolean isShowLegend()
        Return True if the legend is displayed
        Returns:
        True if the legend is displayed
      • setShowLegend

        void setShowLegend​(boolean showLegend)
        Set to True if the legend is displayed
        Parameters:
        showLegend - True if the legend is displayed
      • isShowLegendBorder

        boolean isShowLegendBorder()
        Return True if the legend border is displayed
        Returns:
        True if the legend border is displayed
      • setShowLegendBorder

        void setShowLegendBorder​(boolean showLegendBorder)
        Set to True if the legend border is displayed
        Parameters:
        showLegendBorder - True if the legend border is displayed
      • getLegendPosition

        java.lang.String getLegendPosition()
        Get the Legend position

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

        Returns:
        Legend position
      • setLegendPosition

        void setLegendPosition​(java.lang.String position)
        Set the Legend position

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

        Parameters:
        position - Legend position
      • setLegendPositionTopLeft

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

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

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

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

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

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

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

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

        java.lang.String getLegendWidthType()
        Get the Legend size type

        For example:
        "Stretch", "Fit", "Exact"

        Returns:
        Legend size type
      • setLegendWidthType

        void setLegendWidthType​(java.lang.String widthType)
        Set the Legend size type

        For example:
        "Stretch", "Fit", "Exact"

        Parameters:
        widthType - Legend size type
      • setLegendWidthTypeStretch

        void setLegendWidthTypeStretch()
        Stretch the Legend to span the width of the rendering area
      • setLegendWidthTypeFit

        void setLegendWidthTypeFit()
        Resize the Legend to fit its contents
      • setLegendWidthTypeExact

        void setLegendWidthTypeExact()
        Use the LegendWidth property to specify the exact width of the Legend
      • getLegendHeightType

        java.lang.String getLegendHeightType()
        Get the Legend size type

        For example:
        "Stretch", "Fit", "Exact"

        Returns:
        Legend size type
      • setLegendHeightType

        void setLegendHeightType​(java.lang.String heightType)
        Set the Legend size type

        For example:
        "Stretch", "Fit", "Exact"

        Parameters:
        heightType - Legend size type
      • setLegendHeightTypeStretch

        void setLegendHeightTypeStretch()
        Stretch the Legend to span the height of the rendering area
      • setLegendHeightTypeFit

        void setLegendHeightTypeFit()
        Resize the Legend to fit its contents
      • setLegendHeightTypeExact

        void setLegendHeightTypeExact()
        Use the LegendHeight property to specify the exact height of the Legend
      • getLegendWidth

        int getLegendWidth()
        Get the Exact legend width

        Used when LegendWidthType is "Exact"

        Returns:
        Exact legend width
      • setLegendWidth

        void setLegendWidth​(int legendHorizontalSize)
        Set the Exact legend width

        Used when LegendWidthType is "Exact"

        Parameters:
        legendHorizontalSize - Exact legend width
      • getLegendHeight

        int getLegendHeight()
        Get the Exact legend height

        Used when LegendHeightType is "Exact"

        Returns:
        Exact legend height
      • setLegendHeight

        void setLegendHeight​(int legendVerticalSize)
        Set the Explicit legend height

        Used when LegendHeightType is "Exact"

        Parameters:
        legendVerticalSize - Explicit legend height
      • getMergeSeriesMin

        java.lang.Double getMergeSeriesMin()
        Get the Minimum value on the merged value axis shared by all series (overrides minimum value found in data model)
        Returns:
        Minimum value on the merged value axis shared by all series (overrides minimum value found in data model)
      • setMergeSeriesMin

        void setMergeSeriesMin​(java.lang.Double mergeSeriesMin)
        Set the Minimum value on the merged value axis shared by all series (overrides minimum value found in data model)
        Parameters:
        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 value
      • getMergeSeriesMax

        java.lang.Double getMergeSeriesMax()
        Get the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model)
        Returns:
        Maximum value on the merged value axis shared by all series (overrides maximum value found in data model)
      • setMergeSeriesMax

        void setMergeSeriesMax​(java.lang.Double mergeSeriesMax)
        Set the Maximum value on the merged value axis shared by all series (overrides maximum value found in data model)
        Parameters:
        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 value
      • getTitle

        java.lang.String getTitle()
        Get the Chart title
        Returns:
        Chart title
      • setTitle

        void setTitle​(java.lang.String title)
        Set the Chart Title
        Parameters:
        title - Chart Title
      • getTitlePosition

        java.lang.String getTitlePosition()
        Get the Chart title position
        Returns:
        Chart title position
      • setTitlePosition

        void setTitlePosition​(java.lang.String titlePosition)
        Set the Title position

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

        Parameters:
        titlePosition - Title position
      • setTitlePositionTopLeft

        void setTitlePositionTopLeft()
        Set the Chart Title Position Top Left
      • setTitlePositionTopCenter

        void setTitlePositionTopCenter()
        Set the Chart Title Position Top Center
      • setTitlePositionTopRight

        void setTitlePositionTopRight()
        Set the Chart Title Position Top Right
      • setTitlePositionBottomLeft

        void setTitlePositionBottomLeft()
        Set the Chart Title Position Bottom Left
      • setTitlePositionBottomCenter

        void setTitlePositionBottomCenter()
        Set the Chart Title Position Bottom Center
      • setTitlePositionBottomRight

        void setTitlePositionBottomRight()
        Set the Chart Title Position Bottom Right
      • getTitleCategory

        java.lang.String getTitleCategory()
        Get the Category axis title
        Returns:
        Category axis title
      • setTitleCategory

        void setTitleCategory​(java.lang.String titleCategory)
        Set the Category axis title
        Parameters:
        titleCategory - Category axis title
      • getTitleValue

        java.lang.String getTitleValue()
        Get the Value axis title
        Returns:
        Value axis title
      • setTitleValue

        void setTitleValue​(java.lang.String titleValue)
        Set the Value axis title
        Parameters:
        titleValue - Value axis title
      • getLighting

        java.lang.String getLighting()
        Get the Lighting type

        For example:
        "Default", "Bright", "Dark", "Ambient"

        Returns:
        Lighting type
      • setLighting

        void setLighting​(java.lang.String lighting)
        Set the lighting type

        For example:
        "Default", "Bright", "Dark", "Ambient"

        Parameters:
        lighting - String representation of lighting type
      • setLightingDefault

        void setLightingDefault()
        Use default lighting when rendering the chart
      • setLightingBright

        void setLightingBright()
        Use bright lighting when rendering the chart
      • setLightingDark

        void setLightingDark()
        Use dark lighting when rendering the chart
      • setLightingAmbient

        void setLightingAmbient()
        Use ambient lighting when rendering the chart
      • getOpacity

        float getOpacity()
        Get the opacity used to render chart geometry
        Returns:
        Value from 0.0 to 1.0 specifying the transparency of chart geometry.
      • setOpacity

        void setOpacity​(float opacity)
        Set the opacity used to render chart geometry
        Parameters:
        opacity - Value from 0.0 to 1.0 specifying the transparency of chart geometry.
      • isPieShowLines

        boolean isPieShowLines()
        Return True if the Pie Chart displays lines connecting the labels and the pie slices
        Returns:
        True if the Pie Chart displays lines connecting the labels and the pie slices
      • setPieShowLines

        void setPieShowLines​(boolean pieShowLines)
        Set to True if the Pie Chart displays lines connecting the labels and the pie slices
        Parameters:
        pieShowLines - True if the Pie Chart displays lines connecting the labels and the pie slices
      • isPieShowValues

        boolean isPieShowValues()
        Return True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total)
        Returns:
        True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total)
      • setPieShowValues

        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)
        Parameters:
        pieShowValues - True if the Pie Chart displays the underlying values for each slice (in addition to the percent of total)
      • getPieExplode

        float getPieExplode()
        Get the Distance to which pie slices are exploded from the center of the Pie Chart
        Returns:
        Distance to which pie slices are exploded from the center of the Pie Chart
      • setPieExplode

        void setPieExplode​(float pieExplode)
        Set the Distance to which pie slices are exploded from the center of the Pie Chart
        Parameters:
        pieExplode - Distance to which pie slices are exploded from the center of the Pie Chart
      • setPieExplodeTopSlices

        void setPieExplodeTopSlices​(java.lang.Integer count)
        Set the number of slices to explode, starting with the largest slice and continuing in descending order
        Parameters:
        count - The number of top slices to explode
      • getPieExplodeTopSlices

        java.lang.Integer getPieExplodeTopSlices()
        Get the number of slices to explode, starting with the largest slice and continuing in descending order
        Returns:
        the number of slices to explode, starting with the largest slice and continuing in descending order
      • getPieLabelDistance

        float getPieLabelDistance()
        Get the Distance at which labels are placed from their corresponding pie slices
        Returns:
        Distance at which labels are placed from their corresponding pie slices
      • setPieLabelDistance

        void setPieLabelDistance​(float pieLabelDistance)
        Set the Distance at which labels are placed from their corresponding pie slices
        Parameters:
        pieLabelDistance - Distance at which labels are placed from their corresponding pie slices
      • isStackedPercent

        boolean isStackedPercent()
        Return True if stacked charts should render each series value as a percentage of the total value for all series
        Returns:
        True if stacked charts should render each series value as a percentage of the total value for all series
      • setStackedPercent

        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
        Parameters:
        stackedPercent - True if stacked charts should render each series value as a percentage of the total value for all series
      • isShowValueAxis

        boolean isShowValueAxis()
        Return True if the value axis labels are displayed
        Returns:
        True if the value axis labels are displayed
      • setShowValueAxis

        void setShowValueAxis​(boolean showValueAxis)
        Set to True if the value axis labels are displayed
        Parameters:
        showValueAxis - True if the value axis labels are displayed
      • isShowValueAxisTicks

        boolean isShowValueAxisTicks()
        Return True if the value axis tick marks are displayed
        Returns:
        True if the value axis tick marks are displayed
      • setShowValueAxisTicks

        void setShowValueAxisTicks​(boolean showValueAxisTicks)
        Set to True if the value axis tick marks are displayed
        Parameters:
        showValueAxisTicks - True if the value axis tick marks are displayed
      • isShowValueAxisLines

        boolean isShowValueAxisLines()
        Return True if the value axis lines are displayed
        Returns:
        True if the value axis lines are displayed
      • setShowValueAxisLines

        void setShowValueAxisLines​(boolean showValueAxisLines)
        Set to True if the value axis lines are displayed
        Parameters:
        showValueAxisLines - True if the value axis lines are displayed
      • isShowDataLabels

        boolean isShowDataLabels()
        Return True if labels should be displayed at each data point
        Returns:
        True if labels should be displayed at each data point
      • setShowDataLabels

        void setShowDataLabels​(boolean showDataLabels)
        Set to True if labels should be displayed at each data point
        Parameters:
        showDataLabels - True if labels should be displayed at each data point
      • isShowDataLabels

        boolean isShowDataLabels​(int seriesNumber)
        Return True if labels should be displayed at each data point
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        True if labels should be displayed at each data point
      • setShowDataLabels

        void setShowDataLabels​(int seriesNumber,
                               boolean showDataLabels)
        Set to True if labels should be displayed at each data point
        Parameters:
        seriesNumber - Zero-based index of series
        showDataLabels - True if labels should be displayed at each data point
      • isShowCategoryAxis

        boolean isShowCategoryAxis()
        Return True if the category axis labels are displayed
        Returns:
        True if the category axis labels are displayed
      • setShowCategoryAxis

        void setShowCategoryAxis​(boolean showCategoryAxis)
        Set to True if the category axis labels are displayed
        Parameters:
        showCategoryAxis - True if the category axis labels are displayed
      • isShowCategoryAxisTicks

        boolean isShowCategoryAxisTicks()
        Return True if the category axis tick marks are displayed
        Returns:
        True if the category axis tick marks are displayed
      • setShowCategoryAxisTicks

        void setShowCategoryAxisTicks​(boolean showCategoryAxisTicks)
        Set to True if the category axis tick marks are displayed
        Parameters:
        showCategoryAxisTicks - True if the category axis tick marks are displayed
      • isShowCategoryAxisLines

        boolean isShowCategoryAxisLines()
        Return True if the Category axis lines are displayed
        Returns:
        True if the Category axis lines are displayed
      • setShowCategoryAxisLines

        void setShowCategoryAxisLines​(boolean showCategoryAxisLines)
        Set to True if the Category axis lines are displayed
        Parameters:
        showCategoryAxisLines - True if the Category axis lines are displayed
      • isShowSeriesAxis

        boolean isShowSeriesAxis()
        Return True if the series axis labels are displayed
        Returns:
        True if the series axis labels are displayed
      • setShowSeriesAxis

        void setShowSeriesAxis​(boolean showSeriesAxis)
        Set to True if the series axis labels are displayed
        Parameters:
        showSeriesAxis - True if the series axis labels are displayed
      • isShowMarkers

        boolean isShowMarkers()
        Return True if markers are shown on Line Charts
        Returns:
        True if markers are shown on Line Charts
      • setShowMarkers

        void setShowMarkers​(boolean showMarkers)
        Set to True if markers are shown on Line Charts
        Parameters:
        showMarkers - True if markers are shown on Line Charts
      • isReverseValueAxis

        boolean isReverseValueAxis()
        Return True if the value axis should be reversed (with values increasing from top to bottom or right to left)
        Returns:
        True if the value axis should be reversed (with values increasing from top to bottom or right to left)
      • setReverseValueAxis

        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)
        Parameters:
        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)
      • getValueAxisNumberFormat

        java.lang.String getValueAxisNumberFormat()
        Get the String used to format numbers on the value axis

        For example:
        "#,##0.00"

        Returns:
        String used to format numbers on the value axis
      • setValueAxisNumberFormat

        void setValueAxisNumberFormat​(java.lang.String valueAxisNumberFormat)
        Set the String used to format numbers on the value axis

        For example:
        "#,##0.00"

        Parameters:
        valueAxisNumberFormat - String used to format numbers on the value axis
      • getCategoryAxisDateTimeFormat

        java.lang.String getCategoryAxisDateTimeFormat()
        Get the String used to format datetimes on the category axis

        For example:
        "MMMM dd, yyyy HH:mm:ss a"

        Returns:
        String used to format datetimes on the category axis
      • setCategoryAxisDateTimeFormat

        void setCategoryAxisDateTimeFormat​(java.lang.String categoryAxisDateTimeFormat)
        Set the String used to format datetimes on the category axis

        For example:
        "MMMM dd, yyyy HH:mm:ss a"

        Parameters:
        categoryAxisDateTimeFormat - String used to format datetimes on the category axis
      • getCategoryAxisTimeFormat

        java.lang.String getCategoryAxisTimeFormat()
        Get the String used to format times on the category axis

        For example:
        "HH:mm:ss a"

        Returns:
        String used to format times on the category axis
      • setCategoryAxisTimeFormat

        void setCategoryAxisTimeFormat​(java.lang.String categoryAxisTimeFormat)
        Set the String used to format times on the category axis

        For example:
        "HH:mm:ss a"

        Parameters:
        categoryAxisTimeFormat - String used to format times on the category axis
      • getCategoryAxisDateFormat

        java.lang.String getCategoryAxisDateFormat()
        Get the String used to format dates on the category axis

        For example:
        "MMMM dd, yyyy"

        Returns:
        String used to format dates on the category axis
      • setCategoryAxisDateFormat

        void setCategoryAxisDateFormat​(java.lang.String categoryAxisDateFormat)
        Set the String used to format dates on the category axis

        For example:
        "MMMM dd, yyyy"

        Parameters:
        categoryAxisDateFormat - String used to format dates on the category axis
      • getCategoryAxisNumberFormat

        java.lang.String getCategoryAxisNumberFormat()
        Get the String used to format numbers on the category axis

        For example:
        "#,##0.00"

        Returns:
        String used to format numbers on the category axis
      • setCategoryAxisNumberFormat

        void setCategoryAxisNumberFormat​(java.lang.String categoryAxisNumberFormat)
        Set the String used to format numbers on the category axis

        For example:
        "#,##0.00"

        Parameters:
        categoryAxisNumberFormat - String used to format numbers on the category axis
      • getSeriesAxisDateTimeFormat

        java.lang.String getSeriesAxisDateTimeFormat()
        Get the String used to format datetimes on the series axis

        For example:
        "MMMM dd, yyyy HH:mm:ss a"

        Returns:
        String used to format datetimes on the series axis
      • setSeriesAxisDateTimeFormat

        void setSeriesAxisDateTimeFormat​(java.lang.String seriesAxisDateTimeFormat)
        Set the String used to format datetimes on the series axis

        For example:
        "MMMM dd, yyyy HH:mm:ss a"

        Parameters:
        seriesAxisDateTimeFormat - String used to format datetimes on the series axis
      • getSeriesAxisTimeFormat

        java.lang.String getSeriesAxisTimeFormat()
        Get the String used to format times on the series axis

        For example:
        "HH:mm:ss a"

        Returns:
        String used to format times on the series axis
      • setSeriesAxisTimeFormat

        void setSeriesAxisTimeFormat​(java.lang.String seriesAxisTimeFormat)
        Set the String used to format times on the series axis

        For example:
        "HH:mm:ss a"

        Parameters:
        seriesAxisTimeFormat - String used to format times on the series axis
      • getSeriesAxisDateFormat

        java.lang.String getSeriesAxisDateFormat()
        Get the String used to format dates on the series axis

        For example:
        "MMMM dd, yyyy"

        Returns:
        String used to format dates on the series axis
      • setSeriesAxisDateFormat

        void setSeriesAxisDateFormat​(java.lang.String seriesAxisDateFormat)
        Set the String used to format dates on the series axis

        For example:
        "MMMM dd, yyyy"

        Parameters:
        seriesAxisDateFormat - String used to format dates on the series axis
      • getSeriesAxisNumberFormat

        java.lang.String getSeriesAxisNumberFormat()
        Get the String used to format numbers on the series axis

        For example:
        "#,##0.00"

        Returns:
        String used to format numbers on the series axis
      • setSeriesAxisNumberFormat

        void setSeriesAxisNumberFormat​(java.lang.String seriesAxisNumberFormat)
        Set the String used to format numbers on the series axis

        For example:
        "#,##0.00"

        Parameters:
        seriesAxisNumberFormat - String used to format numbers on the series axis
      • isNumericCategoryAxis

        boolean isNumericCategoryAxis()
        Return True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced)
        Returns:
        True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced)
      • setNumericCategoryAxis

        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)
        Parameters:
        numericCategoryAxis - True if values on the category axis are displayed on a numeric range (instead of displaying each category value evenly spaced)
      • isMapShowBackground

        boolean isMapShowBackground()
        Return True if the map background should be displayed
        Returns:
        True if the map background should be displayed
      • setMapShowBackground

        void setMapShowBackground​(boolean mapShowBackground)
        Set to True if the map background should be displayed
        Parameters:
        mapShowBackground - True if the map background should be displayed
      • isMapShowDetails

        boolean isMapShowDetails()
        Return True if country details should be displayed in the tooltip
        Returns:
        True if country details should be displayed in the tooltip
      • setMapShowDetails

        void setMapShowDetails​(boolean mapShowDetails)
        Set to True if country details should be displayed in the tooltip
        Parameters:
        mapShowDetails - True if country details should be displayed in the tooltip
      • getMapRange

        java.lang.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; ... ; 400 <= x <= 500

        Returns:
        String list of ranges for map highlighting
      • setMapRange

        void setMapRange​(java.lang.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; ... ; 400 <= x <= 500

        Parameters:
        mapRange - String list of ranges for map highlighting
      • getMapRangeColors

        java.lang.String getMapRangeColors()
        Get the String list of colors for map highlighting

        For example:
        "red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF"

        Returns:
        String list of colors for map highlighting
      • setMapRangeColors

        void setMapRangeColors​(java.lang.String mapRangeColors)
        Set the String list of colors for map highlighting

        For example:
        "red, green, blue, yellow, cyan" or "#FF0000, #00FF00, #0000FF, #FFFF00, #00FFFF"

        Parameters:
        mapRangeColors - String list of colors for map highlighting
      • getNameAlias

        java.lang.String getNameAlias​(int seriesNumber)
        Get the Alternate name for the specified series (default name is obtained from model)
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Alternate name for the specified series (default name is obtained from model)
      • setNameAlias

        void setNameAlias​(int seriesNumber,
                          java.lang.String nameAlias)
        Set the Alternate name for the specified series (default name is obtained from model)
        Parameters:
        seriesNumber - Zero-based index of series
        nameAlias - Alternate name for the specified series, or null to use the default name obtained from the model
      • getColor

        java.lang.String getColor​(int seriesNumber)
        Get the Color used to render series geometry
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Color used to render series geometry
      • setColor

        void setColor​(int seriesNumber,
                      java.lang.String color)
        Set the color used to render series geometry
        Parameters:
        seriesNumber - Zero-based index of series
        color - String name of color used to render series geometry, or null to use the default color scheme
      • getMin

        java.lang.Double getMin​(int seriesNumber)
        Get the Minimum value on this series' value axis (overrides minimum value found in data model)
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Minimum value on this series' value axis (overrides minimum value found in data model)
      • setMin

        void setMin​(int seriesNumber,
                    java.lang.Double min)
        Set the Minimum value on this series' value axis (overrides minimum value found in data model)
        Parameters:
        seriesNumber - Zero-based index of series
        min - Minimum value on this series' value axis (overrides minimum value found in data model), or null to use the model's calculated min value
      • getMax

        java.lang.Double getMax​(int seriesNumber)
        Get the Maximum value on this series' value axis (overrides maximum value found in data model)
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Maximum value on this series' value axis (overrides maximum value found in data model)
      • setMax

        void setMax​(int seriesNumber,
                    java.lang.Double max)
        Set the Maximum value on this series' value axis (overrides maximum value found in data model)
        Parameters:
        seriesNumber - Zero-based index of series
        max - Maximum value on this series' value axis (overrides maximum value found in data model), or null to use the model's calculated max value
      • getChartSubTypeString

        java.lang.String getChartSubTypeString​(int seriesNumber)
        Get the Subtype indicating how this series is used by a multi-series chart (e.g. bubble, candlestick, high-low-close)
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Subtype indicating how this series is used by a chart which requires multiple series to render (e.g. bubble, candlestick, high-low-close)
      • setChartSubType

        void setChartSubType​(int seriesNumber,
                             java.lang.String chartSubType)
        Set the subtype indicating how this series is used by a multi-series chart (e.g. bubble, candlestick, high-low-close)
        Parameters:
        seriesNumber - Zero-based index of series
        chartSubType - 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)
      • setChartSubTypeHigh

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • setChartSubTypeLow

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • setChartSubTypeClose

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • setChartSubTypeOpen

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • setChartSubTypePosition

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • setChartSubTypeSize

        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

        Parameters:
        seriesNumber - Zero-based index of series
      • getColumnTypeString

        java.lang.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

        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Type of geometry to use when rendering a column or bar chart
      • setColumnType

        void setColumnType​(int seriesNumber,
                           java.lang.String columnType)
        Set the type of geometry to use when rendering a column or bar chart

        For example:
        "cube", "cone", "cylinder", "pyramid"

        Parameters:
        seriesNumber - Zero-based index of series
        columnType - String name of type of geometry to use when rendering a column or bar chart
      • setColumnTypeCube

        void setColumnTypeCube​(int seriesNumber)
        Set the type of geometry (Cube) to use when rendering a column or bar chart
        Parameters:
        seriesNumber - Zero-based index of series
      • setColumnTypeCone

        void setColumnTypeCone​(int seriesNumber)
        Set the type of geometry (Cone) to use when rendering a column or bar chart
        Parameters:
        seriesNumber - Zero-based index of series
      • setColumnTypeCylinder

        void setColumnTypeCylinder​(int seriesNumber)
        Set the type of geometry (Cylinder) to use when rendering a column or bar chart
        Parameters:
        seriesNumber - Zero-based index of series
      • setColumnTypePyramid

        void setColumnTypePyramid​(int seriesNumber)
        Set the type of geometry (Pyramid) to use when rendering a column or bar chart
        Parameters:
        seriesNumber - Zero-based index of series
      • isFunctionSeries

        boolean isFunctionSeries​(int seriesNumber)
        Return True if this series is a function series (instead of data from the model)
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        True if this series is a function series (instead of data from the model)
      • getFunction

        AQSeriesFunction getFunction​(int seriesNumber)
        Get the Function used to generate this series
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Function used to generate this series
      • getFunctionName

        java.lang.String getFunctionName​(int seriesNumber)
        Get the Name of function used to generate this series
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        Name of function used to generate this series
      • getFunctionParametersString

        java.lang.String getFunctionParametersString​(int seriesNumber)
        Get the String containing function name and parameters
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        String containing function name and parameters
      • setFunction

        void setFunction​(int seriesNumber,
                         java.lang.String function)
        Set the Function used to generate this series
        Parameters:
        seriesNumber - Zero-based index of series
        function - Function used to generate this series
      • isShowFunctionMetaData

        boolean isShowFunctionMetaData​(int seriesNumber)
        Return True if function metadata is displayed
        Parameters:
        seriesNumber - Zero-based index of series
        Returns:
        True if function metadata is displayed
      • setShowFunctionMetaData

        void setShowFunctionMetaData​(int seriesNumber,
                                     boolean showFunctionMetaData)
        Set to True if function metadata is displayed
        Parameters:
        seriesNumber - Zero-based index of series
        showFunctionMetaData - True if function metadata is displayed
      • getTheme

        java.lang.String getTheme()
        Get the color theme Color themes control the background gradient colors, the per-series colors and the font colors
        Returns:
        The theme
      • setTheme

        void setTheme​(java.lang.String theme)
        Set the color theme Color themes control the background gradient colors, the per-series colors and the font colors
        Parameters:
        theme - the theme
      • setThemeDefault

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        java.lang.String getTitleColor()
        Get the String representation of the color used for the Chart Title text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Chart Title text
      • setTitleColor

        void setTitleColor​(java.lang.String color)
        Set the color used for the Chart Title text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Chart Title text
      • getDataLabelColor

        java.lang.String getDataLabelColor()
        Get the String representation of the color used for Data Labels

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for Data Labels
      • setDataLabelColor

        void setDataLabelColor​(java.lang.String color)
        Set the color used for Data Labels

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for Data Labels
      • getValueAxisLabelColor

        java.lang.String getValueAxisLabelColor()
        Get the String representation of the color used for the Value Axis Label text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Value Axis Label text
      • setValueAxisLabelColor

        void setValueAxisLabelColor​(java.lang.String color)
        Set the color used for the Value Axis Label text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Value Axis Label text
      • getCategoryAxisLabelColor

        java.lang.String getCategoryAxisLabelColor()
        Get the String representation of the color used for the Category Axis Label text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Category Axis Label text
      • setCategoryAxisLabelColor

        void setCategoryAxisLabelColor​(java.lang.String color)
        Set the color used for the Category Axis Label text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Category Axis Label text
      • getSeriesAxisLabelColor

        java.lang.String getSeriesAxisLabelColor()
        Get the String representation of the color used for the Category Axis Label text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Category Axis Label text
      • setSeriesAxisLabelColor

        void setSeriesAxisLabelColor​(java.lang.String color)
        Set the color used for the Category Axis Label text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Category Axis Label text
      • getValueAxisTitleColor

        java.lang.String getValueAxisTitleColor()
        Get the String representation of the color used for the Value Axis Title text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Value Axis Title text
      • setValueAxisTitleColor

        void setValueAxisTitleColor​(java.lang.String color)
        Set the color used for the Value Axis Title text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Value Axis Title text
      • getCategoryAxisTitleColor

        java.lang.String getCategoryAxisTitleColor()
        Get the String representation of the color used for the Category Axis Title text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Category Axis Title text
      • setCategoryAxisTitleColor

        void setCategoryAxisTitleColor​(java.lang.String color)
        Set the color used for the Category Axis Title text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Category Axis Title text
      • getSeriesAxisTitleColor

        java.lang.String getSeriesAxisTitleColor()
        Get the String representation of the color used for the Category Axis Title text

        For example:
        "#FFFFFF" = white

        Returns:
        String representation of the color used for the Category Axis Title text
      • setSeriesAxisTitleColor

        void setSeriesAxisTitleColor​(java.lang.String color)
        Set the color used for the Category Axis Title text

        For example:
        "#FFFFFF" = white

        Parameters:
        color - String representation of the color used for the Category Axis Title text