AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Plots Class

    Defined in: yui3/src/charts/js/Plots.js:11
    Module: series-plot-util
    Parent Module: charts

    Utility class used for drawing markers.

    Constructor

    Plots

    ()

    Defined in yui3/src/charts/js/Plots.js:11

    Methods

    _clearMarkerCache

    () private

    Defined in yui3/src/charts/js/Plots.js:373

    Removes unused markers from the marker cache

    _createGroupMarkers

    (
    • styles
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:293

    Draws a series of markers in a single shape instance.

    Parameters:

    • styles Object

      <p><p><p><p><p><p>Set of configuration properties used to create the markers.</p></p></p></p></p></p>

    _createMarker

    (
    • styles
    )
    private

    Defined in yui3/src/charts/js/Plots.js:250

    Creates a shape to be used as a marker.

    Parameters:

    • styles Object

      <p><p><p><p><p><p>Hash of style properties.</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>Shape</p></p></p></p></p></p>

    _createMarkerCache

    () private

    Defined in yui3/src/charts/js/Plots.js:269

    Creates a cache of markers for reuse.

    _getDefaultStyles

    () protected

    Defined in yui3/src/charts/js/Plots.js:530

    Returns:

    <p><p><p><p><p><p>Object</p></p></p></p></p></p>

    _getGroupShape

    (
    • shape
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:142

    Returns the correct group shape class.

    Parameters:

    • shape Shape | String

      <p><p><p><p><p><p>Indicates which shape class.</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>Function</p></p></p></p></p></p>

    _getItemColor

    (
    • val
    • i
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:424

    Parses a color from an array.

    Parameters:

    • val Array

      <p><p><p><p><p><p>collection of colors</p></p></p></p></p></p>

    • i Number

      <p><p><p><p><p><p>index of the item</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>String</p></p></p></p></p></p>

    _getPlotDefaults

    () protected

    Defined in yui3/src/charts/js/Plots.js:159

    Gets the default values for series that use the utility. This method is used by the class' styles attribute's getter to get build default values.

    Returns:

    <p><p><p><p><p><p>Object</p></p></p></p></p></p>

    _getState

    (
    • type
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:482

    Returns marker state based on event type

    Parameters:

    • type String

      <p><p><p><p><p><p>event type</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>String</p></p></p></p></p></p>

    _parseMarkerStyles

    (
    • Object
    )
    private

    Defined in yui3/src/charts/js/Plots.js:456

    Combines new styles with existing styles.

    Parameters:

    • Object Object

      <p><p><p><p><p><p>containing style properties for the marker.</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>Object</p></p></p></p></p></p>

    _setStyles

    (
    • newStyles
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:442

    Method used by styles setter. Overrides base implementation.

    Parameters:

    • newStyles Object

      <p><p><p><p><p><p>Hash of properties to update.</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>Object</p></p></p></p></p></p>

    _toggleVisible

    (
    • visible
    )
    private

    Defined in yui3/src/charts/js/Plots.js:346

    Toggles visibility

    Parameters:

    • visible Boolean

      <p><p><p><p><p><p>indicates visibilitye</p></p></p></p></p></p>

    drawPlots

    () protected

    Defined in yui3/src/charts/js/Plots.js:41

    Draws the markers

    drawSeries

    () protected

    Defined in yui3/src/charts/js/Plots.js:518

    getMarker

    (
    • styles
    • order
    • index
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:208

    Gets and styles a marker. If there is a marker in cache, it will use it. Otherwise it will create one.

    Parameters:

    • styles Object

      <p><p><p><p><p><p>Hash of style properties.</p></p></p></p></p></p>

    • order Number

      <p><p><p><p><p><p>Order of the series.</p></p></p></p></p></p>

    • index Number

      <p><p><p><p><p><p>Index within the series associated with the marker.</p></p></p></p></p></p>

    Returns:

    <p><p><p><p><p><p>Shape</p></p></p></p></p></p>

    updateMarkerState

    (
    • type
    • i
    )
    protected

    Defined in yui3/src/charts/js/Plots.js:392

    Resizes and positions markers based on a mouse interaction.

    Parameters:

    • type String

      <p><p><p><p><p><p>state of the marker</p></p></p></p></p></p>

    • i Number

      <p><p><p><p><p><p>index of the marker</p></p></p></p></p></p>

    Properties

    _groupShapes

    Unknown private

    Defined in yui3/src/charts/js/Plots.js:129

    Pre-defined group shapes.

    _markerCache

    Array private

    Defined in yui3/src/charts/js/Plots.js:199

    Collection of markers to be re-used on a series redraw.

    _markers

    Array private

    Defined in yui3/src/charts/js/Plots.js:190

    Collection of markers to be used in the series.

    _plotDefaults

    Object private

    Defined in yui3/src/charts/js/Plots.js:32

    Storage for default marker styles.

    _statSyles

    Object private

    Defined in yui3/src/charts/js/Plots.js:511