new OHLC(config)
Creates an OHLC renderer.
Note: By default, the renderer displays bars as underlays. As such, they will appear below any other studies or drawings.
The OHLC renderer is a base class for creating the following chart types:
- CIQ.Renderer.HLC
- CIQ.Renderer.Bars
- CIQ.Renderer.Candles
- CIQ.Renderer.SimpleHistogram
and is normally not directly accessed.
See CIQ.Renderer#construct for parameters required by all renderers
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
object | Config for renderer Properties
|
- Since:
-
5.1.0
Example
// Colored hlc chart
var renderer=stxx.setSeriesRenderer(new CIQ.Renderer.OHLC({params:{name:"bars", type:"bar", hlc:true, colored:true}}));
Methods
-
requestNew(featureList [, params])
-
Returns a new OHLC renderer if the featureList calls for it FeatureList should contain whatever features requested; valid features: bar, hlc, candle, colored, histogram, hollow, volume Anything else is an invalid feature and will cause function to return null
Note: If you are using the base package then the only valid features are: candle and histogram.
Called by CIQ.Renderer.produce to create a renderer for the main series
Parameters:
Name Type Argument Description featureList
array List of rendering terms requested by the user, parsed from the chartType
params
object <optional>
Parameters used for the series to be created, used to create the renderer
- Since:
-
5.1.0
Returns:
A new instance of the OHLC renderer, if the featureList matches
- Type
- CIQ.Renderer.OHLC