AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    StackingUtil Class

    Defined in: yui3/src/charts/js/StackingUtil.js:9
    Module: series-stacked
    Parent Module: charts

    Utility class used for creating stacked series.

    Constructor

    StackingUtil

    ()

    Defined in yui3/src/charts/js/StackingUtil.js:9

    Methods

    _cleanXNaN

    (
    • xcoords
    • ycoords
    )
    private

    Defined in yui3/src/charts/js/StackingUtil.js:207

    Cleans invalid x-coordinates by calculating their value based on the corresponding y-coordinate, the previous valid x-coordinate with its corresponding y-coordinate and the next valid x-coordinate with its corresponding y-coordinate. If there is no previous or next valid x-coordinate, the value will not be altered.

    Parameters:

    • xcoords Array

      <p><p><p><p><p><p><p><p><p>An array of x-coordinate values</p></p></p></p></p></p></p></p></p>

    • ycoords Array

      <p><p><p><p><p><p><p><p><p>An arry of y-coordinate values</p></p></p></p></p></p></p></p></p>

    _cleanYNaN

    (
    • xcoords
    • ycoords
    )
    private

    Defined in yui3/src/charts/js/StackingUtil.js:301

    Cleans invalid y-coordinates by calculating their value based on the corresponding x-coordinate, the previous valid y-coordinate with its corresponding x-coordinate and the next valid y-coordinate with its corresponding x-coordinate. If there is no previous or next valid y-coordinate, the value will not be altered.

    Parameters:

    • xcoords Array

      <p><p><p><p><p><p><p><p><p>An array of x-coordinate values</p></p></p></p></p></p></p></p></p>

    • ycoords Array

      <p><p><p><p><p><p><p><p><p>An arry of y-coordinate values</p></p></p></p></p></p></p></p></p>

    _getNextValidCoordValue

    (
    • coords
    • index
    )
    private

    Defined in yui3/src/charts/js/StackingUtil.js:279

    Returns the next valid (numeric) value in an array if available.

    Parameters:

    • coords Array

      <p><p><p><p><p><p><p><p><p>Array of values</p></p></p></p></p></p></p></p></p>

    • index Number

      <p><p><p><p><p><p><p><p><p>The index in the array in which to begin searching.</p></p></p></p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p><p><p><p>Number</p></p></p></p></p></p></p></p></p>

    _getPreviousValidCoordValue

    (
    • coords
    • index
    )
    private

    Defined in yui3/src/charts/js/StackingUtil.js:257

    Returns the previous valid (numeric) value in an array if available.

    Parameters:

    • coords Array

      <p><p><p><p><p><p><p><p><p>Array of values</p></p></p></p></p></p></p></p></p>

    • index Number

      <p><p><p><p><p><p><p><p><p>The index in the array in which to begin searching.</p></p></p></p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p><p><p><p>Number</p></p></p></p></p></p></p></p></p>

    _stackCoordinates

    () protected

    Defined in yui3/src/charts/js/StackingUtil.js:28

    _stackXCoords

    () protected

    Defined in yui3/src/charts/js/StackingUtil.js:47

    Stacks coordinates for a stacked vertical series.

    _stackYCoords

    () protected

    Defined in yui3/src/charts/js/StackingUtil.js:126

    Stacks coordinates for a stacked horizontal series.

    Properties

    _stacked

    Unknown private

    Defined in yui3/src/charts/js/StackingUtil.js:20

    Indicates whether the series is stacked.