Skip to content

Options🔗

Definition🔗

type Options struct {
    // Sets which dimensions are used for the visualization
    Mode candlestick.VizDisplayMode `json:"mode"`
    // Sets the style of the candlesticks
    CandleStyle candlestick.CandleStyle `json:"candleStyle"`
    // Sets the color strategy for the candlesticks
    ColorStrategy candlestick.ColorStrategy `json:"colorStrategy"`
    // Map fields to appropriate dimension
    Fields candlestick.CandlestickFieldMap `json:"fields"`
    // Set which colors are used when the price movement is up or down
    Colors candlestick.CandlestickColors `json:"colors"`
    Legend common.VizLegendOptions `json:"legend"`
    Tooltip common.VizTooltipOptions `json:"tooltip"`
    // When enabled, all fields will be sent to the graph
    IncludeAllFields *bool `json:"includeAllFields,omitempty"`
}

Methods🔗

UnmarshalJSONStrict🔗

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode Options from JSON.

Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (options *Options) UnmarshalJSONStrict(raw []byte) error

Equals🔗

Equals tests the equality of two Options objects.

func (options *Options) Equals(other Options) bool

Validate🔗

Validate checks all the validation constraints that may be defined on Options fields for violations and returns them.

func (options *Options) Validate() error