dundas.controls.Gauge Class

Displays a single value with related values as additional pointers or ranges along a scale.
 

Inheritance Hierarchy

 
Class
   dundas.controls.DataControl
      dundas.controls.Gauge
         dundas.controls.LinearGauge
         dundas.controls.RadialGauge
 

Properties

 
  Name Description
background Gets or sets the brush used to fill the background of the control. Inherited from dundas.controls.DataControl.
borderBrush Gets or sets the brush used to fill the border around the control. Inherited from dundas.controls.DataControl.
borderRadius Gets or sets the radius in pixels for rounding the corners of the border. Inherited from dundas.controls.DataControl.
borderStyle Gets or sets the style of the border around the control. Inherited from dundas.controls.DataControl.
borderWidth Gets or sets the width of the border around the control. Inherited from dundas.controls.DataControl.
canvasService Gets the canvas service associated with this control. Inherited from dundas.controls.DataControl.
container Gets the DOM element this control will render to. Inherited from dundas.controls.DataControl.
height Gets the current rendered height of the control. Inherited from dundas.controls.DataControl.
hoverFill Gets or sets the fill of a pointer when the mouse hovers over it.
hoverStroke Gets or sets the stroke of a pointer when the mouse hovers over it.
id Gets a value uniquely identifying this gauge. Inherited from dundas.controls.DataControl.
innerPadding Gets the total padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
isAligning Gets or sets a value indicating whether the control is currently being aligned. Inherited from dundas.controls.DataControl.
isClickSelectionEnabled Gets or sets whether or click selection on gauges is enabled.
isDrawPending Gets a value indicating whether the control is about to re-draw. Inherited from dundas.controls.DataControl.
isEmptyDataHidden Gets or sets whether the gauge is rendered when no data is supplied to the control.
legend Gets or sets the legend used by this control. Inherited from dundas.controls.DataControl.
legendCategory Gets or sets the legend category of the gauge.
padding Gets or sets the padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
ranges Gets or sets the collection of ranges displayed along the gauge scale.
selectedFill Gets or sets the fill of a pointer when it is selected.
selectedStroke Gets or sets the stroke of a pointer when it is selected.
tooltipMouseDelay Gets or sets the tooltip mouse delay.
width Gets the current rendered width of the control. Inherited from dundas.controls.DataControl.
 
 

Methods

 
  Name Description
alignHorizontallyWith Aligns the content of this control horizontally with the specified control. Inherited from dundas.controls.DataControl.
alignVerticallyWith Aligns the content of this control vertically with the specified control. Inherited from dundas.controls.DataControl.
clearHorizontallyAligned Removes all controls from horizontal alignment with this instance. Inherited from dundas.controls.DataControl.
clearVerticallyAligned Removes all controls from vertical alignment with this instance. Inherited from dundas.controls.DataControl.
draw Re-draws the data control immediately if invalidated. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getDisplayedText Gets the text as it will be displayed. The text can include placeholder keywords.
getHorizontallyAligned Gets an array of controls set to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
getVerticallyAligned Gets an array of controls set to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
hitTest Determines what data control element is represented at the specified position. Inherited from dundas.controls.DataControl.
invalidate Ensures the data control is re-drawn using the current data and settings at the next best time made available by the browser. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
invalidateSize Notifies the control that its container element size may have changed. Inherited from dundas.controls.DataControl.
isAlignedHorizontallyWith Gets a value indicating whether the specified control has been aligned horizontally with this instance. Inherited from dundas.controls.DataControl.
isAlignedVerticallyWith Gets a value indicating whether the specified control has been aligned vertically with this instance. Inherited from dundas.controls.DataControl.
onDOMDetach Called when the DOM element this control will render to is temporarily detached. Inherited from dundas.controls.DataControl.
onDOMReattach Called when the DOM element this control will render to is re-attached. Inherited from dundas.controls.DataControl.
removeHorizontallyAligned Removes the specified control from the list to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
removeVerticallyAligned Removes the specified control from the list to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
updateLegend Responsible for updating a legend control, if it exists, with information from this control. The parent method in the Gauge class clears all existing legend items belonging to this control. This method should call super then add items to the legend.