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

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.chart.wijcandlestickchart.options
     
    $(".selector").wijcandlestickchart(options);
});

function wijcandlestickchart() : any;

Options

	Name	Description
	animation	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.
	annotations	Default value: [] Creates an array of AnnotationBase objects that contain the settings of the annotations to display in the chart.
	autoResize	Default value: true A value that indicates whether to redraw the chart automatically when resizing the chart element.
	axis	Type: wijmo.chart.chart_axes A value that contains all of the information to create the X and Y axes of the chart
	candlestickFormatter	Default value: null A callback to format the candlestick element.
	chartLabelFormatter	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.
	culture	Default value: "" A value that indicator the culture to format the chart text.
	cultureCalendar	Default value: "" Assigns the string value of the culture calendar that appears on the calendar. This option must work with culture option.
	data	Default value: null Bind a field to each series's data x array
	dataSource	Default value: null Sets the array to use as a source for data that you can bind to the axes in your seriesList.
	disabled	Gets or sets whether control is disabled.
	disableDefaultTextStyle	Default value: false Sets a value indicating whether you can set the font-family of the text using a class instead of options.
	footer	Type: wijmo.chart.chart_title Sets up the object to use as the footer of the barchart.
	header	Type: wijmo.chart.chart_title Sets up the object to use as the header of the barchart.
	height	Default value: null Sets the height of the barchart in pixels.
	hint	Creates an object to use as the tooltip, or hint, when the mouse is over a chart element.
	horizontal	Gets or sets whether series are displayed horizontally.
	indicator	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.
	is100Percent	Gets or sets whether each value contributes to the total with the relative size of each series representing its contribution to the total.
	legend	Type: wijmo.chart.chart_legend Creates a legend object to display with the chart.
	marginBottom	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.
	marginLeft	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
	marginRight	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
	marginTop	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
	seriesHoverStyles	Default value: [] Sets an array of styles to use in rendering bars in the chart when you hover over them.
	seriesList	Default value: [] Creates an array of series objects that contain data values and labels to display in the chart.
	seriesStyles	Default value: [] Sets an array of style objects to use in rendering the bars for each series in the chart.
	seriesTransition	Type: wijmo.chart.chart_animation Creates the animation object to use when the seriesList data changes.
	shadow	Default value: true A value that indicates whether to show a shadow around the edge of the chart.
	stacked	Gets or sets whether series objects are stacked.
	textStyle	Creates an object to use for the fallback style of any chart text that does not have other style options set.
	type	A value that indicates how to draw the candlestick element. Possible value is ohlc, hl, candlestick
	width	Default value: null Sets the width of the chart in pixels.

Top

Methods

	Name	Description
	addSeriesPoint	Add series point to the series list.
	beginUpdate	Suspend automatic updates to the chart while reseting the options.
	destroy	Remove the functionality completely. This will return the element back to its pre-init state.
	endUpdate	Restore automatic updates to the chart after the options has been reset.
	exportChart	Exports the chart in a graphic format. The export method only works when wijmo.exporter.chartExport's reference is on the page.
	getCandlestick	This 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.
	getCanvas	Returns a reference to the Raphael canvas object.
	redraw	This method redraws the chart.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	beforePaint	This event fires before the canvas is painted. This event can be cancelled. "return false;" to cancel the event.
	beforeSeriesChange	This event fires before the series changes. This event can be cancelled. "return false;" to cancel the event.
	click	Fires when the user clicks the chart element.
	mouseDown	This event fires when the user clicks a mouse button.
	mouseMove	Fires when the user moves the mouse pointer while it is over a chart element.
	mouseOut	Fires when the user moves the pointer off of the chart element.
	mouseOver	Fires when the user first places the pointer over the chart element.
	mouseUp	Fires when the user releases a mouse button while the pointer is over the chart element.
	painted	This event fires after the canvas is painted.
	seriesChanged	This event fires when the series changes.

Top

Widgets

CandlestickChart User Guide
CandlestickChart Quick Start

Reference

wijcandlestickchart jQuery Widget