wijbarchart jQuery Widget

Create a customized bar chart to compare the values of items across categories.

Syntax

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

Javascript (Usage)

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

Javascript (Specification)
function wijbarchart() : any;

Browser Compatibility

Options

	Name	Description
	animation	Type: wijmo.chart.chart_animation The animation option determines whether and how the animation is shown.
	axis	Type: wijmo.chart.chart_axes A value that contains all of the information to create the X and Y axes of the chart
	chartLabelFormatString	Default value: "" Sets the numeric format of the chart labels that show the value of each chart element. You can use Standard Numeric Format Strings.
	chartLabelStyle	Sets all of the style options of the chart labels that show the value of each chart element.
	clusterOverlap	Default value: 0 Sets the amount of each bar to render over the edge of the next bar in the same cluster,as a percentage of the bar width.
	clusterRadius	Default value: 0 Sets the number of pixels by which to round the corner-radius for the bars in the chart.
	clusterSpacing	Default value: 0 Sets the amount of space in pixels between the bars in each cluster.
	clusterWidth	Default value: 85 Sets the percentage of each cluster's allocated plot area that the bars in each cluster occupy.
	culture	Default value: "" A value that indicator the culture to format the chart text.
	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.
	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	Type: wijmo.chart.chart_hint Creates an object to use as the tooltip, or hint, when the mouse is over a chart element.
	horizontal	Default value: true A value that determines whether the bar chart renders horizontally or vertically.
	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	Default value: false Sets a value that determines whether to present stacked bars as a total value of 100 percent, illustrating how each value contributes 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.
	showChartLabels	Default value: true A value that indicates whether to show default chart labels.
	stacked	Default value: false Sets a value that determines whether to stack bars in the chart to show how each value in a series contributes to the total.
	textStyle	Creates an object to use for the fallback style of any chart text that does not have other style options set.
	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.
	getBar	This method returns the bar, which has a set of Raphaël objects (rects) that represent bars 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

See Also

Widgets

Reference