Chart
=====



A charting service powered by gnuplot.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: Chart.defaultOptions()

    Get the default options for the :func:`Chart.draw` RPC.

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - the default draw options


.. function:: Chart.draw(lines: List, options: Object?)

    Create charts and histograms from data.

    **Arguments:**

    - ``lines: List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - a single line or list of lines. Each line should be ``[[x1,y1], [x2,y2], ...]``.
    - ``options: Object?`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - Configuration for graph title, axes, and more

        - ``title: String?`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - title to show on the graph
        - ``width: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - width of the returned image
        - ``height: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - height of the returned image
        - ``labels: List<String>?`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - labels for each line
        - ``types: List<LineType>?`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `LineType </docs/fundamentals/rpc-arg-types.html#LineType>`__) - types for each line
        - ``xRange: List<Number>?`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - range of X values to graph
        - ``yRange: List<Number>?`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - range of Y values to graph
        - ``xLabel: String?`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - label on the X axis
        - ``yLabel: String?`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - label on the Y axis
        - ``xTicks: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - tick interval for the X axis
        - ``isCategorical: Boolean?`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - true to enable categorical mode
        - ``smooth: Boolean?`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - true to enable smoothing
        - ``grid: Enum<line, dot>?`` (`Enum </docs/fundamentals/rpc-arg-types.html#Enum>`__) - grid type to use
        - ``isTimeSeries: Boolean?`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - true to enable time series mode
        - ``timeInputFormat: TimeFormat?`` (`TimeFormat </docs/fundamentals/rpc-arg-types.html#TimeFormat>`__) - input time format for time series data
        - ``timeDisplayFormat: TimeFormat?`` (`TimeFormat </docs/fundamentals/rpc-arg-types.html#TimeFormat>`__) - output time format for time series data
        - ``logscale: List?`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - logscale settings to use
        - ``fontSize: BoundedInteger<1, 256>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - font size to use for the title and axis labels (default 10).
        - ``legendLocation: LegendLocation?`` (`LegendLocation </docs/fundamentals/rpc-arg-types.html#LegendLocation>`__) - the location of the legend
        - ``lineWidth: BoundedInteger<1, 32>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - the width of the lines to draw


    **Returns:** ``Image`` (`Image </docs/fundamentals/rpc-arg-types.html#Image>`__) - the generated chart