Skip to content

Options🔗

Definition🔗

class Options implements \JsonSerializable
{
    /**
     * Sets which dimensions are used for the visualization
     */
    public \Grafana\Foundation\Candlestick\VizDisplayMode $mode;

    /**
     * Sets the style of the candlesticks
     */
    public \Grafana\Foundation\Candlestick\CandleStyle $candleStyle;

    /**
     * Sets the color strategy for the candlesticks
     */
    public \Grafana\Foundation\Candlestick\ColorStrategy $colorStrategy;

    /**
     * Map fields to appropriate dimension
     */
    public \Grafana\Foundation\Candlestick\CandlestickFieldMap $fields;

    /**
     * Set which colors are used when the price movement is up or down
     */
    public \Grafana\Foundation\Candlestick\CandlestickColors $colors;

    public \Grafana\Foundation\Common\VizLegendOptions $legend;

    public \Grafana\Foundation\Common\VizTooltipOptions $tooltip;

    /**
     * When enabled, all fields will be sent to the graph
     */
    public ?bool $includeAllFields;

}

Methods🔗

fromArray🔗

Builds this object from an array.

This function is meant to be used with the return value of json_decode($json, true).

static fromArray(array $inputData)

jsonSerialize🔗

Returns the data representing this object, preparing it for JSON serialization with json_encode().

jsonSerialize()