Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Class aperture.chart.ChartLayer

The underlying base layer for charts. Type-specific charts are created by adding child layers (e.g. LineSeriesLayer, BarSeriesLayer) to this layer. Axes and "rules" / grid lines can be constructed and configured using the xAxis, yAxis and ruleLayer methods.

Mappings

Method Summary

Method Detail

  • {aperture.chart.RuleLayer|Array} ruleLayer(index)
    This method retrieves the aperture.chart.RuleLayer with the given index.
    Parameters:
    {Number} index
    the index of the RuleLayer to retrieve. If no index is provided, a list of all RuleLayers is returned.
    Returns:
    {aperture.chart.RuleLayer|Array} the RuleLayer for the given index. If no order is specified, a list of all RuleLayer is returned.
  • {aperture.chart.AxisLayer|Array} xAxis(order)
    This method retrieves the aperture.chart.AxisLayer of the given order for the X axis.
    Parameters:
    {Number} order Optional
    the order of the axis to be retrieved (e.g. the primary axis would be order=0), or -1 to retrieve an array of all axes. If no order is provided, the primary axis is returned.
    Returns:
    {aperture.chart.AxisLayer|Array} the AxisLayer for the given order, or a list of all X AxisLayers.
  • {aperture.chart.AxisLayer|Array} yAxis(order)
    This method retrieves the aperture.chart.AxisLayer of the given order for the Y axis.
    Parameters:
    {Number} order Optional
    the order of the axis to be retrieved (e.g. the primary axis would be order=0), or -1 to retrieve an array of all axes. If no order is provided, the primary axis is returned.
    Returns:
    {aperture.chart.AxisLayer|Array} the AxisLayer for the given order, or a list of all Y axis AxisLayers.