Wijmo UI for the Web
wijgauge jQuery Widget
Contains the core functions shared by the two gauge widgets.
Syntax
Javascript (Usage) 
$(function () {
    var options; // Type:  wijmo.gauge.wijgauge.options
     
    $(".selector").wijgauge(options);
});
Javascript (Specification) 
function wijgauge() : any;
Browser Compatibility
7
5
5
Options
 NameDescription
public Optionanimation

Type: wijmo.gauge.gauge_animation

Defines the animation effect, controlling aspects such as duration and easing.

 
public Optionface

Type: wijmo.gauge.gauge_face

Sets or draws the image or shape to use for the face of the gauge and the background area.

 
public Optionheight

Default value: 400

Sets the height of the gauge area in pixels.

 
public OptionisInverted

Default value: false

Determines whether to render the gauge in reverse order, with the numbering going from highest to lowest.

 
public Optionislogarithmic

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.

 
public Optionlabels

Type: wijmo.gauge.gauge_label

Sets all of the appearance options of the numeric labels that appear around the edge of the gauge.

 
public OptionlogarithmicBase

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.

 
public OptionmarginBottom

Default value: 0

Sets a value in pixels that indicates where to render the bottom edge of the gauge face.

 
public OptionmarginLeft

Default value: 0

Sets a value in pixels that indicates where to render the left edge of the gauge face.

 
public OptionmarginRight

Default value: 0

Sets a value in pixels that indicates where to render the right edge of the gauge face.

 
public OptionmarginTop

Default value: 0

Sets a value in pixels that indicates where to render the top edge of the gauge face.

 
public Optionmax

Default value: 100

Sets the maximum value of the gauge.

 
public Optionmin

Default value: 0

Sets the minimum value of the gauge.

 
public Optionpointer

Type: wijmo.gauge.gauge_pointer

A value that includes all settings of the gauge pointer.

 
public Optionranges

Default value: []

Allows you to create an array of ranges to highlight where values fall within the gauge.

 
public OptiontickMajor

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.

 
public OptiontickMinor

Type: wijmo.gauge.gauge_tick

A value that provides information for the minor tick.

 
public Optionvalue

Default value: 0

Sets the value of the gauge, indicated by the pointer.

 
public Optionwidth

Default value: 600

Sets the width of the gauge area in pixels.

 
Top
Methods
 NameDescription
public MethoddestroyRemove the functionality completely. This will return the element back to its pre-init state.  
public MethodgetCanvasReturns a reference to the Raphael canvas object.  
public MethodredrawRedraw the gauge.  
public MethodwidgetReturns a jQuery object containing the original element or other relevant generated element.  
Top
Events
 NameDescription
public EventbeforeValueChangedFires before the value changes, this event can be called.  
public EventpaintedFires before the canvas is painted. This event can be cancelled. "return false;" to cancel the event.  
public EventvalueChangedFires before the value changes, this event can be called.  
Top

See Also

Reference

wijgauge jQuery Widget

 

 


© 2013 All Rights Reserved.

Send comments on this topic.