CategoryAxesSettings (CHARTS 7.2 API)

java.lang.Object
- com.haulmont.charts.gui.amcharts.model.AbstractChartObject
- - com.haulmont.charts.gui.amcharts.model.CategoryAxesSettings

All Implemented Interfaces:

java.io.Serializable
```
public class CategoryAxesSettings
extends AbstractChartObject
```
Defines set of properties for all CategoryAxes of StockPanel. If there is no default value specified, default value of CategoryAxis class will be used.
See documentation for properties of CategoryAxesSettings JS object.
http://docs.amcharts.com/3/javascriptstockchart/CategoryAxesSettings

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CategoryAxesSettings()

Constructors
Constructor and Description
`CategoryAxesSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CategoryAxesSettings`	`addDateFormats(DateFormat... dateFormats)` Adds date formats.
`CategoryAxesSettings`	`addGroupToPeriods(java.lang.String... groupToPeriods)` Adds groupToPeriods strings.
`java.lang.Boolean`	`getAlwaysGroup()`
`java.lang.Boolean`	`getAutoGridCount()`
`java.lang.Double`	`getAxisAlpha()`
`Color`	`getAxisColor()`
`java.lang.Integer`	`getAxisHeight()`
`java.lang.Integer`	`getAxisThickness()`
`java.lang.Boolean`	`getBoldLabels()`
`java.lang.Boolean`	`getBoldPeriodBeginning()`
`Color`	`getColor()`
`java.lang.Integer`	`getDashLength()`
`java.util.List<DateFormat>`	`getDateFormats()`
`java.lang.Boolean`	`getEqualSpacing()`
`java.lang.Double`	`getFillAlpha()`
`Color`	`getFillColor()`
`java.lang.Integer`	`getFontSize()`
`java.lang.Double`	`getGridAlpha()`
`Color`	`getGridColor()`
`java.lang.Integer`	`getGridCount()`
`java.lang.Integer`	`getGridThickness()`
`java.util.List<java.lang.String>`	`getGroupToPeriods()`
`java.lang.Boolean`	`getInside()`
`java.lang.Integer`	`getLabelOffset()`
`java.lang.Integer`	`getLabelRotation()`
`java.lang.Boolean`	`getLabelsEnabled()`
`java.lang.Boolean`	`getMarkPeriodChange()`
`java.lang.Integer`	`getMaxSeries()`
`java.lang.Integer`	`getMinHorizontalGap()`
`java.lang.Double`	`getMinorGridAlpha()`
`java.lang.Boolean`	`getMinorGridEnabled()`
`java.lang.String`	`getMinPeriod()`
`CategoryAxesPosition`	`getPosition()`
`java.lang.Boolean`	`getStartOnAxis()`
`java.lang.Integer`	`getTickLength()`
`java.lang.Boolean`	`getTwoLineMode()`
`CategoryAxesSettings`	`setAlwaysGroup(java.lang.Boolean alwaysGroup)` Set alwaysGroup to true and if groupToPeriods doesn't have minPeriod value included, chart will always group values to the first period available.
`CategoryAxesSettings`	`setAutoGridCount(java.lang.Boolean autoGridCount)` Set autoGridCount to false if you don't want the number of gridCount are specified automatically, according to the axis size.
`CategoryAxesSettings`	`setAxisAlpha(java.lang.Double axisAlpha)` Sets axis opacity.
`CategoryAxesSettings`	`setAxisColor(Color axisColor)` Sets axis color.
`CategoryAxesSettings`	`setAxisHeight(java.lang.Integer axisHeight)` Sets height of category axes.
`CategoryAxesSettings`	`setAxisThickness(java.lang.Integer axisThickness)` Sets thickness of the axis.
`CategoryAxesSettings`	`setBoldLabels(java.lang.Boolean boldLabels)` Set to true if axis labels should be bold.
`CategoryAxesSettings`	`setBoldPeriodBeginning(java.lang.Boolean boldPeriodBeginning)` Set boldPeriodBeginning to false if you want chart will not try to highlight the beginning of the periods, like month, in bold.
`CategoryAxesSettings`	`setColor(Color color)` Sets text color.
`CategoryAxesSettings`	`setDashLength(java.lang.Integer dashLength)` Sets length of a dash.
`CategoryAxesSettings`	`setDateFormats(java.util.List<DateFormat> dateFormats)` Sets list of date formats of different periods.
`CategoryAxesSettings`	`setEqualSpacing(java.lang.Boolean equalSpacing)` Set equalSpacing to true if you want data points to be placed at equal intervals (omitting dates with no data).
`CategoryAxesSettings`	`setFillAlpha(java.lang.Double fillAlpha)` Sets fill opacity.
`CategoryAxesSettings`	`setFillColor(Color fillColor)` Sets fill color.
`CategoryAxesSettings`	`setFontSize(java.lang.Integer fontSize)` Sets text size.
`CategoryAxesSettings`	`setGridAlpha(java.lang.Double gridAlpha)` Sets opacity of grid lines.
`CategoryAxesSettings`	`setGridColor(Color gridColor)` Sets color of grid lines.
`CategoryAxesSettings`	`setGridCount(java.lang.Integer gridCount)` Sets number of grid lines.
`CategoryAxesSettings`	`setGridThickness(java.lang.Integer gridThickness)` Sets thickness of grid lines.
`CategoryAxesSettings`	`setGroupToPeriods(java.util.List<java.lang.String> groupToPeriods)` Sets list of groupToPeriods strings.
`CategoryAxesSettings`	`setInside(java.lang.Boolean inside)` Set inside to true if values should be placed inside of plot area.
`CategoryAxesSettings`	`setLabelOffset(java.lang.Integer labelOffset)` Sets offset of axis labels.
`CategoryAxesSettings`	`setLabelRotation(java.lang.Integer labelRotation)` Sets rotation angle of a label.
`CategoryAxesSettings`	`setLabelsEnabled(java.lang.Boolean labelsEnabled)` Set labelsEnabled to false if you don't wont to display category axis labels and value axis values.
`CategoryAxesSettings`	`setMarkPeriodChange(java.lang.Boolean markPeriodChange)` Set markPeriodChange to false if period shouldn't be marked by a different date format.
`CategoryAxesSettings`	`setMaxSeries(java.lang.Integer maxSeries)` Sets maximum series shown at a time.
`CategoryAxesSettings`	`setMinHorizontalGap(java.lang.Integer minHorizontalGap)` Sets minimum cell width required for one span between grid lines.
`CategoryAxesSettings`	`setMinorGridAlpha(java.lang.Double minorGridAlpha)` Sets opacity of minor grid.
`CategoryAxesSettings`	`setMinorGridEnabled(java.lang.Boolean minorGridEnabled)` Set to true if minor grid should be displayed.
`CategoryAxesSettings`	`setMinPeriod(java.lang.String minPeriod)` Sets the shortest period of your data.
`CategoryAxesSettings`	`setPosition(CategoryAxesPosition position)` Sets position of category axes.
`CategoryAxesSettings`	`setStartOnAxis(java.lang.Boolean startOnAxis)` Set startOnAxis to false if the graph should start on axis.
`CategoryAxesSettings`	`setTickLength(java.lang.Integer tickLength)` Sets tick length.
`CategoryAxesSettings`	`setTwoLineMode(java.lang.Boolean twoLineMode)` Set twoLineMode to true, category axis will display date strings of bot small and big period, in two rows, at the position where bigger period changes.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CategoryAxesSettings
```
public CategoryAxesSettings()
```
- Method Detail
  - getAlwaysGroup
```
public java.lang.Boolean getAlwaysGroup()
```
    Returns:
    
    true if chart always group values to the first period available
  - setAlwaysGroup
```
public CategoryAxesSettings setAlwaysGroup(java.lang.Boolean alwaysGroup)
```
    Set alwaysGroup to true and if groupToPeriods doesn't have minPeriod value included, chart will always group values to the first period available. If not set the default value is false.
    
    Parameters:
    
    alwaysGroup - alwaysGroup option
  - getAutoGridCount
```
public java.lang.Boolean getAutoGridCount()
```
    Returns:
    
    true if the number of gridCount is specified automatically, according to the axis size.
  - setAutoGridCount
```
public CategoryAxesSettings setAutoGridCount(java.lang.Boolean autoGridCount)
```
    Set autoGridCount to false if you don't want the number of gridCount are specified automatically, according to the axis size. If not set the default value is true.
    
    Parameters:
    
    autoGridCount - autoGridCount option
  - getAxisAlpha
```
public java.lang.Double getAxisAlpha()
```
    Returns:
    
    axis opacity
  - setAxisAlpha
```
public CategoryAxesSettings setAxisAlpha(java.lang.Double axisAlpha)
```
    Sets axis opacity. If not set the default value is 0.
    
    Parameters:
    
    axisAlpha - axis opacity
  - getAxisColor
```
public Color getAxisColor()
```
    Returns:
    
    axis color
  - setAxisColor
```
public CategoryAxesSettings setAxisColor(Color axisColor)
```
    Sets axis color.
    
    Parameters:
    
    axisColor - axis color
  - getAxisHeight
```
public java.lang.Integer getAxisHeight()
```
    Returns:
    
    height of category axes
  - setAxisHeight
```
public CategoryAxesSettings setAxisHeight(java.lang.Integer axisHeight)
```
    Sets height of category axes. Set it to 0 if you set inside property to true. If not set the default value is 28.
    
    Parameters:
    
    axisHeight - height of category axes
  - getAxisThickness
```
public java.lang.Integer getAxisThickness()
```
    Returns:
    
    thickness of the axis
  - setAxisThickness
```
public CategoryAxesSettings setAxisThickness(java.lang.Integer axisThickness)
```
    Sets thickness of the axis.
    
    Parameters:
    
    axisThickness - thickness of the axis
  - getBoldPeriodBeginning
```
public java.lang.Boolean getBoldPeriodBeginning()
```
    Returns:
    
    true if chart highlights the beginning of the periods in bold
  - setBoldPeriodBeginning
```
public CategoryAxesSettings setBoldPeriodBeginning(java.lang.Boolean boldPeriodBeginning)
```
    Set boldPeriodBeginning to false if you want chart will not try to highlight the beginning of the periods, like month, in bold. Works when parse dates are on for the category axis. If not set the default value is true.
    
    Parameters:
    
    boldPeriodBeginning - bold period beginning option
  - getColor
```
public Color getColor()
```
    Returns:
    
    text color
  - setColor
```
public CategoryAxesSettings setColor(Color color)
```
    Sets text color.
    
    Parameters:
    
    color - text color
  - getDashLength
```
public java.lang.Integer getDashLength()
```
    Returns:
    
    length of a dash
  - setDashLength
```
public CategoryAxesSettings setDashLength(java.lang.Integer dashLength)
```
    Sets length of a dash.
    
    Parameters:
    
    dashLength - length of a dash
  - getDateFormats
```
public java.util.List<DateFormat> getDateFormats()
```
    Returns:
    
    list of date formats of different periods
  - setDateFormats
```
public CategoryAxesSettings setDateFormats(java.util.List<DateFormat> dateFormats)
```
    Sets list of date formats of different periods. Possible period values: fff - milliseconds, ss - seconds, mm - minutes, hh - hours, DD - days, MM - months, WW - weeks, YYYY - years.
    
    Parameters:
    
    dateFormats - list of date formats
  - addDateFormats
```
public CategoryAxesSettings addDateFormats(DateFormat... dateFormats)
```
    Adds date formats.
    
    Parameters:
    
    dateFormats - date formats
  - getEqualSpacing
```
public java.lang.Boolean getEqualSpacing()
```
    Returns:
    
    true if data points is placed at equal intervals (omitting dates with no data)
  - setEqualSpacing
```
public CategoryAxesSettings setEqualSpacing(java.lang.Boolean equalSpacing)
```
    Set equalSpacing to true if you want data points to be placed at equal intervals (omitting dates with no data). If not set the default value is false.
    
    Parameters:
    
    equalSpacing - equalSpacing option
  - getFillAlpha
```
public java.lang.Double getFillAlpha()
```
    Returns:
    
    fill opacity
  - setFillAlpha
```
public CategoryAxesSettings setFillAlpha(java.lang.Double fillAlpha)
```
    Sets fill opacity. Every second space between grid lines can be filled with fillColor.
    
    Parameters:
    
    fillAlpha - fill opacity
  - getFillColor
```
public Color getFillColor()
```
    Returns:
    
    fill color
  - setFillColor
```
public CategoryAxesSettings setFillColor(Color fillColor)
```
    Sets fill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.
    
    Parameters:
    
    fillColor - fill color
  - getFontSize
```
public java.lang.Integer getFontSize()
```
    Returns:
    
    font size
  - setFontSize
```
public CategoryAxesSettings setFontSize(java.lang.Integer fontSize)
```
    Sets text size.
    
    Parameters:
    
    fontSize - text size
  - getGridAlpha
```
public java.lang.Double getGridAlpha()
```
    Returns:
    
    opacity of grid lines
  - setGridAlpha
```
public CategoryAxesSettings setGridAlpha(java.lang.Double gridAlpha)
```
    Sets opacity of grid lines.
    
    Parameters:
    
    gridAlpha - opacity of grid lines
  - getGridColor
```
public Color getGridColor()
```
    Returns:
    
    color of grid lines
  - setGridColor
```
public CategoryAxesSettings setGridColor(Color gridColor)
```
    Sets color of grid lines.
    
    Parameters:
    
    gridColor - color of grid lines
  - getGridCount
```
public java.lang.Integer getGridCount()
```
    Returns:
    
    number of grid lines
  - setGridCount
```
public CategoryAxesSettings setGridCount(java.lang.Integer gridCount)
```
    Sets number of grid lines. You should set autoGridCount to false in order this property not to be ignored. If not set the default value is 10.
    
    Parameters:
    
    gridCount - number of grid lines
  - getGridThickness
```
public java.lang.Integer getGridThickness()
```
    Returns:
    
    thickness of grid lines
  - setGridThickness
```
public CategoryAxesSettings setGridThickness(java.lang.Integer gridThickness)
```
    Sets thickness of grid lines.
    
    Parameters:
    
    gridThickness - grid thickness
  - getGroupToPeriods
```
public java.util.List<java.lang.String> getGroupToPeriods()
```
    Returns:
    
    list of groupToPeriods strings
  - setGroupToPeriods
```
public CategoryAxesSettings setGroupToPeriods(java.util.List<java.lang.String> groupToPeriods)
```
    Sets list of groupToPeriods strings. Periods to which data will be grouped in case there are more data items in the selected period than specified in maxSeries property. Possible values: "ss", "10ss", "mm", "DD", "WW","MM", "YYYY". If not set the default value is
```
 ["ss", "10ss", "30ss",
  "mm", "10mm", "30mm",
  "hh", "DD",   "WW",
  "MM", "YYYY"]
 
```
    Parameters:
    
    groupToPeriods - list of groupToPeriods strings
  - addGroupToPeriods
```
public CategoryAxesSettings addGroupToPeriods(java.lang.String... groupToPeriods)
```
    Adds groupToPeriods strings.
    
    Parameters:
    
    groupToPeriods - groupToPeriods
  - getInside
```
public java.lang.Boolean getInside()
```
    Returns:
    
    true if values placed inside of plot area
  - setInside
```
public CategoryAxesSettings setInside(java.lang.Boolean inside)
```
    Set inside to true if values should be placed inside of plot area. If not set the default value is false.
    
    Parameters:
    
    inside - inside option
  - getLabelOffset
```
public java.lang.Integer getLabelOffset()
```
    Returns:
    
    offset of axis labels
  - setLabelOffset
```
public CategoryAxesSettings setLabelOffset(java.lang.Integer labelOffset)
```
    Sets offset of axis labels. If not set the default value is 0.
    
    Parameters:
    
    labelOffset - offset of axis labels
  - getLabelRotation
```
public java.lang.Integer getLabelRotation()
```
    Returns:
    
    rotation angle of a label
  - setLabelRotation
```
public CategoryAxesSettings setLabelRotation(java.lang.Integer labelRotation)
```
    Sets rotation angle of a label.
    
    Parameters:
    
    labelRotation - rotation angle of a label
  - getLabelsEnabled
```
public java.lang.Boolean getLabelsEnabled()
```
    Returns:
    
    true if axis displays category axis labels and value axis values.
  - setLabelsEnabled
```
public CategoryAxesSettings setLabelsEnabled(java.lang.Boolean labelsEnabled)
```
    Set labelsEnabled to false if you don't wont to display category axis labels and value axis values. If not set the default value is true.
    
    Parameters:
    
    labelsEnabled - labelsEnabled option
  - getMarkPeriodChange
```
public java.lang.Boolean getMarkPeriodChange()
```
    Returns:
    
    true if period should be marked by a different date format
  - setMarkPeriodChange
```
public CategoryAxesSettings setMarkPeriodChange(java.lang.Boolean markPeriodChange)
```
    Set markPeriodChange to false if period shouldn't be marked by a different date format. If not set the default value is true.
    
    Parameters:
    
    markPeriodChange - markPeriodChange option
  - getMaxSeries
```
public java.lang.Integer getMaxSeries()
```
    Returns:
    
    maximum series shown at a time
  - setMaxSeries
```
public CategoryAxesSettings setMaxSeries(java.lang.Integer maxSeries)
```
    Sets maximum series shown at a time. In case there are more data points in the selection than maxSeries, the chart will group data to longer periods, for example - you have 250 days in the selection, and maxSeries is 150 - the chart will group data to weeks. If not set the default value is 150.
    
    Parameters:
    
    maxSeries - maximum series shown at a time
  - getMinHorizontalGap
```
public java.lang.Integer getMinHorizontalGap()
```
    Returns:
    
    minimum cell width required for one span between grid lines
  - setMinHorizontalGap
```
public CategoryAxesSettings setMinHorizontalGap(java.lang.Integer minHorizontalGap)
```
    Sets minimum cell width required for one span between grid lines. minHorizontalGap is used when calculating grid count. If not set the default value is 75.
    
    Parameters:
    
    minHorizontalGap - minimum cell width
  - getMinPeriod
```
public java.lang.String getMinPeriod()
```
    Returns:
    
    the shortest period of your data
  - setMinPeriod
```
public CategoryAxesSettings setMinPeriod(java.lang.String minPeriod)
```
    Sets the shortest period of your data. "fff" - millisecond, "ss" - second, "mm" - minute, "hh" - hour, "DD" - day, "MM" - month, 'YYYY' - year. It's also possible to supply a number for increments, i.e. "15mm" which will instruct the chart that your data is supplied in 15 minute increments. If not set the default value is "DD".
    
    Parameters:
    
    minPeriod - the shortest period
  - getPosition
```
public CategoryAxesPosition getPosition()
```
    Returns:
    
    position of category axes
  - setPosition
```
public CategoryAxesSettings setPosition(CategoryAxesPosition position)
```
    Sets position of category axes.
    
    Parameters:
    
    position - position of category axes
  - getStartOnAxis
```
public java.lang.Boolean getStartOnAxis()
```
    Returns:
    
    true if the graph shouldn't start on axis
  - setStartOnAxis
```
public CategoryAxesSettings setStartOnAxis(java.lang.Boolean startOnAxis)
```
    Set startOnAxis to false if the graph should start on axis. In case you display columns, it is recommended to set this to false. startOnAxis can be set to true only if equalSpacing is set to true. If not set the default value is false.
    
    Parameters:
    
    startOnAxis - startOnAxis option
  - getTickLength
```
public java.lang.Integer getTickLength()
```
    Returns:
    
    tick length
  - setTickLength
```
public CategoryAxesSettings setTickLength(java.lang.Integer tickLength)
```
    Sets tick length. If not set the default value is 0.
    
    Parameters:
    
    tickLength - tick length
  - getTwoLineMode
```
public java.lang.Boolean getTwoLineMode()
```
    Returns:
    
    true category axis displays date strings of bot small and big period, in two rows
  - setTwoLineMode
```
public CategoryAxesSettings setTwoLineMode(java.lang.Boolean twoLineMode)
```
    Set twoLineMode to true, category axis will display date strings of bot small and big period, in two rows, at the position where bigger period changes. Works only when parseDates is set to true and equalSpacing is false. If not set the default value is false.
    
    Parameters:
    
    twoLineMode - twoLineMode option
  - getBoldLabels
```
public java.lang.Boolean getBoldLabels()
```
    Returns:
    
    true if axis labels are bold
  - setBoldLabels
```
public CategoryAxesSettings setBoldLabels(java.lang.Boolean boldLabels)
```
    Set to true if axis labels should be bold.
    
    Parameters:
    
    boldLabels - boldLabels option
  - getMinorGridAlpha
```
public java.lang.Double getMinorGridAlpha()
```
    Returns:
    
    opacity of minor grid
  - setMinorGridAlpha
```
public CategoryAxesSettings setMinorGridAlpha(java.lang.Double minorGridAlpha)
```
    Sets opacity of minor grid. In order minor to be visible, you should set minorGridEnabled to true.
    
    Parameters:
    
    minorGridAlpha - opacity of minor grid
  - getMinorGridEnabled
```
public java.lang.Boolean getMinorGridEnabled()
```
    Returns:
    
    true if minor grid is displayed
  - setMinorGridEnabled
```
public CategoryAxesSettings setMinorGridEnabled(java.lang.Boolean minorGridEnabled)
```
    Set to true if minor grid should be displayed. Note, if equalSpacing is set to true, this setting will be ignored.
    
    Parameters:
    
    minorGridEnabled - minorGridEnabled option

Class CategoryAxesSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CategoryAxesSettings

Method Detail

getAlwaysGroup

setAlwaysGroup

getAutoGridCount

setAutoGridCount

getAxisAlpha

setAxisAlpha

getAxisColor

setAxisColor

getAxisHeight

setAxisHeight

getAxisThickness

setAxisThickness

getBoldPeriodBeginning

setBoldPeriodBeginning

getColor

setColor

getDashLength

setDashLength

getDateFormats

setDateFormats

addDateFormats

getEqualSpacing

setEqualSpacing

getFillAlpha

setFillAlpha

getFillColor

setFillColor

getFontSize

setFontSize

getGridAlpha

setGridAlpha

getGridColor

setGridColor

getGridCount

setGridCount

getGridThickness

setGridThickness

getGroupToPeriods

setGroupToPeriods

addGroupToPeriods

getInside

setInside

getLabelOffset

setLabelOffset

getLabelRotation

setLabelRotation

getLabelsEnabled

setLabelsEnabled

getMarkPeriodChange

setMarkPeriodChange

getMaxSeries

setMaxSeries

getMinHorizontalGap

setMinHorizontalGap

getMinPeriod

setMinPeriod

getPosition

setPosition

getStartOnAxis

setStartOnAxis

getTickLength

setTickLength

getTwoLineMode

setTwoLineMode

getBoldLabels

setBoldLabels

getMinorGridAlpha

setMinorGridAlpha

getMinorGridEnabled

setMinorGridEnabled