Wijmo UI for the Web
wijcandlestickchart jQuery Widget
A candlestick chart displays stock information using High, Low, Open and Close values. The end points of the wick line (or placement of the horizontal lines in OHLC) are determined by the High and Low values, while the end points of the bar are determined by the Open and Close values.
Syntax
$(function () {
    var options; // Type:  wijmo.chart.wijcandlestickchart.options
     
    $(".selector").wijcandlestickchart(options);
});
function wijcandlestickchart() : any;
Options
 NameDescription
public Option

Type: wijmo.chart.chart_animation

The animation option defines the animation effect and controls other aspects of the widget's animation, such as duration and easing.

 
public Option

Default value: []

Creates an array of AnnotationBase objects that contain the settings of the annotations to display in the chart.

 
public Option

Default value: true

A value that indicates whether to redraw the chart automatically when resizing the chart element.

 
public Option

Type: wijmo.chart.chart_axes

A value that contains all of the information to create the X and Y axes of the chart

 
public Option

Default value: null

A callback to format the candlestick element.

 
public Option

Default value: null

A value that indicates a function which is used to obtain the content part of the chart label for each chart element.

 
public Option

Default value: ""

A value that indicator the culture to format the chart text.

 
public Option

Default value: ""

Assigns the string value of the culture calendar that appears on the calendar. This option must work with culture option.

 
public Option

Default value: null

Bind a field to each series's data x array

 
public Option

Default value: null

Sets the array to use as a source for data that you can bind to the axes in your seriesList.

 
public Option

Gets or sets whether control is disabled.

 
public Option

Default value: false

Sets a value indicating whether you can set the font-family of the text using a class instead of options.

 
public Option

Type: wijmo.chart.chart_title

Sets up the object to use as the footer of the barchart.

 
public Option

Type: wijmo.chart.chart_title

Sets up the object to use as the header of the barchart.

 
public Option

Default value: null

Sets the height of the barchart in pixels.

 
public Option

Creates an object to use as the tooltip, or hint, when the mouse is over a chart element.

 
public Option

Gets or sets whether series are displayed horizontally.

 
public Option

Type: wijmo.chart.chart_indicator

Sets up an object that can display an indicator line running horizontally/vertically through the center of each chart element in the chart when the user clicks the chart element.

 
public Option

Gets or sets whether each value contributes to the total with the relative size of each series representing its contribution to the total.

 
public Option

Type: wijmo.chart.chart_legend

Creates a legend object to display with the chart.

 
public Option

Default value: 25

Sets the amount of space in pixels between the chart area and the bottom edge of the <div> that defines the widget.

 
public Option

Default value: 25

Sets the amount of space in pixels between the chart area and the left edge of the <div> that defines the widget

 
public Option

Default value: 25

Sets the amount of space in pixels between the chart area and the right edge of the <div> that defines the widget

 
public Option

Default value: 25

Sets the amount of space in pixels between the chart area and the top edge of the <div> that defines the widget

 
public Option

Default value: []

Sets an array of styles to use in rendering bars in the chart when you hover over them.

 
public Option

Default value: []

Creates an array of series objects that contain data values and labels to display in the chart.

 
public Option

Default value: []

Sets an array of style objects to use in rendering the bars for each series in the chart.

 
public Option

Type: wijmo.chart.chart_animation

Creates the animation object to use when the seriesList data changes.

 
public Option

Default value: true

A value that indicates whether to show a shadow around the edge of the chart.

 
public Option

Gets or sets whether series objects are stacked.

 
public Option

Creates an object to use for the fallback style of any chart text that does not have other style options set.

 
public Option

A value that indicates how to draw the candlestick element. Possible value is ohlc, hl, candlestick

 
public Option

Default value: null

Sets the width of the chart in pixels.

 
Top
Methods
 NameDescription
public MethodAdd series point to the series list.  
public MethodSuspend automatic updates to the chart while reseting the options.  
public MethodRemove the functionality completely. This will return the element back to its pre-init state.  
public MethodRestore automatic updates to the chart after the options has been reset.  
public MethodExports the chart in a graphic format. The export method only works when wijmo.exporter.chartExport's reference is on the page.  
public MethodThis method returns the candlestick elements, which has a set of Raphaël objects that represent candlestick elements for the series data, from the specified index.  
public MethodReturns a reference to the Raphael canvas object.  
public MethodThis method redraws the chart.  
public MethodReturns a jQuery object containing the original element or other relevant generated element.  
Top
Events
 NameDescription
public EventThis event fires before the canvas is painted. This event can be cancelled. "return false;" to cancel the event.  
public EventThis event fires before the series changes. This event can be cancelled. "return false;" to cancel the event.  
public EventFires when the user clicks the chart element.  
public EventThis event fires when the user clicks a mouse button.  
public EventFires when the user moves the mouse pointer while it is over a chart element.  
public EventFires when the user moves the pointer off of the chart element.  
public EventFires when the user first places the pointer over the chart element.  
public EventFires when the user releases a mouse button while the pointer is over the chart element.  
public EventThis event fires after the canvas is painted.  
public EventThis event fires when the series changes.  
Top
See Also

Widgets

CandlestickChart User Guide
CandlestickChart Quick Start

Reference

wijcandlestickchart jQuery Widget