API Reference

Class: Candles

CIQ.Renderer. Candles

new Candles(config)

Creates a Candles renderer, a derivation of the OHLC renderer.

Note: by default the renderer will display candles as underlays. As such, they will appear below any other studies or drawings.

The Candles renderer is used to create the following drawing types: candle, hollow candle, volume candle

See CIQ.Renderer#construct for parameters required by all renderers

Name Type Description
config object

Config for renderer

Name Type Argument Description
params object <optional>

Parameters to control the renderer itself

Name Type Argument Default Description
useChartLegend boolean <optional>

Set to true to use the built in canvas legend renderer. See CIQ.ChartEngine.Chart#legendRenderer;

style string <optional>

Style name to use in lieu of defaults for the type

hollow boolean <optional>

Specifies candles should be hollow candles

volume boolean <optional>

Specifies candles should be volume candles

colorFunction function <optional>

Override function (or string) used to determine color of candle. May be an actual function or a string name of the registered function (see CIQ.Renderer.registerColorFunction)

Common valid parameters for use by attachSeries.:
fill_color_up - Color to use for up candles.
fill_color_down - Color to use for down candles.
fill_color_even - Color to use for even candles.
border_color_up - Color to use for the border of up candles.
border_color_down - Color to use for the order of down candles.
border_color_even - Color to use for the order of even candles.

  • 5.1.1

// Hollow candle chart
var renderer = stxx.setSeriesRenderer(
	new CIQ.Renderer.Candles({ params: { name: "candles", hollow: true } })