wijlineargauge jQuery Widget

Display data in a horizontal or vertical gauge with customizable tick marks, ranges, face, and pointer.

Syntax

Javascript (Usage)
Javascript (Specification)

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

function wijlineargauge() : any;

Options

	Name	Description
	animation	Type: wijmo.gauge.gauge_animation Defines the animation effect, controlling aspects such as duration and easing.
	autoResize	Default value: true A value that indicates whether to redraw the gauge automatically when resizing the gauge element.
	face	Type: wijmo.gauge.gauge_face Sets or draws the image or shape to use for the face of the gauge and the background area.
	height	Default value: 'auto' Sets the height of the gauge area in pixels.
	isInverted	Default value: false Determines whether to render the gauge in reverse order, with the numbering going from highest to lowest.
	islogarithmic	Default value: false The islogarithmic option, inherited from the jquery.wijmo.wijgauge.js base class, indicates whether to use logarithmic scaling for gauge label numeric values.
	labels	Type: wijmo.gauge.gauge_label Sets all of the appearance options of the numeric labels that appear around the edge of the gauge.
	logarithmicBase	Default value: 10 The logarithmicBase option, inherited from the jquery.wijmo.wijgauge.js base class, indicates the logarithmic base to use if the islogarithmic option is set to true. The logarithmic base is the number to raise to produce the exponent.
	marginBottom	Default value: 5 It is a value in pixels that indicates where to render the bottom edge of the gauge face.
	marginLeft	Default value: 5 It is a value in pixels that indicates where to render the left edge of the gauge markers, it may help to also change the width option.
	marginRight	Default value: 5 It is a value in pixels that indicates where to render the right edge of the gauge face.
	marginTop	Default value: 5 It is a value in pixels that indicates where to render the top edge of the gauge face.
	max	Default value: 100 Sets the maximum value of the gauge.
	min	Default value: 0 Sets the minimum value of the gauge.
	orientation	Default value: 'horizontal' Sets the orientation of the gauge, with a setting of horizontal showing values across the gauge from left to right, and a setting of vertical showing values along the gauge from top to bottom.
	pointer	Type: wijmo.gauge.gauge_pointer Creates an object that includes all settings of the gauge pointer.
	ranges	Default value: [] Allows you to create an array of ranges to highlight where values fall within the gauge.
	tickMajor	Type: wijmo.gauge.gauge_tick Sets appearance options for the major tick marks that appear next to the numeric labels around the face of the gauge.
	tickMinor	Type: wijmo.gauge.gauge_tick A value that provides information for the minor tick.
	value	Default value: 0 Sets the value of the gauge, indicated by the pointer.
	width	Default value: 'auto' Sets the width of the gauge area in pixels.
	xAxisLength	Default value: 0.8 Sets the length of the X axis as a percentage of the width of the gauge.
	xAxisLocation	Default value: 0.1 Sets the starting location of the X axis as a percentage of the width of the gauge.
	yAxisLocation	Default value: 0.5 Sets the base vertical location of the pointer, tick marks and labels on the X axis as a percentage of the height of the gauge.

Top

Methods

	Name	Description
	destroy	Remove the functionality completely. This will return the element back to its pre-init state.
	getCanvas	Returns a reference to the Raphael canvas object.
	redraw	Redraw the gauge.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	beforeValueChanged	Fires before the value changes, this event can be called.
	painted	Fires before the canvas is painted. This event can be cancelled. "return false;" to cancel the event.
	valueChanged	Fires before the value changes, this event can be called.

Top

Widgets

LinearGauge

Reference

wijlineargauge jQuery Widget