com.smartgwt.client.widgets.drawing

## Class Gauge

- java.lang.Object
- - com.google.gwt.user.client.ui.UIObject
  - - com.google.gwt.user.client.ui.Widget
    - - com.smartgwt.client.widgets.BaseWidget
      - - com.smartgwt.client.widgets.Canvas
        - - com.smartgwt.client.widgets.drawing.DrawPane
          - - com.smartgwt.client.widgets.drawing.Gauge

- All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasDrawEndHandlers, HasDrawStartHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

      public class Gauge
      extends DrawPane

  The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle on a dial. The dial is divided into sectors, each having its own color and value.

  NOTE: you must load the Drawing `Optional Module` before you can use Gauge.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

      `com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled`

  - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.widgets.BaseWidget

      `config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName`

    - ### Fields inherited from class com.google.gwt.user.client.ui.UIObject

      `DEBUG_ID_PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Gauge()`
    `Gauge(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `addSector(double newSector)` Adds a new sector.
    `int` | `addSector(GaugeSector newSector)` Adds a new sector.
    `static void` | `changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
    `static void` | `changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
    `protected com.google.gwt.core.client.JavaScriptObject` | `create()`
    `protected java.lang.String` | `formatLabelContents(float value)` Formats a value as a string to be used as the contents of a `DrawLabel`.
    `java.lang.String` | `getBorderColor()` Color for gauge sector borders.
    `int` | `getBorderWidth()` Pixel width for gauge sector borders.
    `protected java.lang.String` | `getDefaultFillColor(int sectorIndex)` Gets the default fill color for the sector at index `sectorIndex`.
    `float` | `getDialRadius()` Deprecated. `GwtFloatVsDouble`
    `double` | `getDialRadiusAsDouble()` Radius in pixels of the dial.
    `boolean` | `getDrawnClockwise()` Whether the sectors are drawn clockwise, and increasing the value causes the needle to move clockwise.
    `int` | `getFontSize()` Font size of sector labels.
    `java.lang.String` | `getLabelPrefix()` The label prefix.
    `java.lang.String` | `getLabelSuffix()` The label suffix.
    `com.smartgwt.logicalstructure.core.LogicalStructureObject` | `getLogicalStructure()` Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
    `float` | `getMaxValue()` Deprecated. `GwtFloatVsDouble`
    `double` | `getMaxValueAsDouble()` The maximum dial value.
    `float` | `getMinValue()` Deprecated. `GwtFloatVsDouble`
    `double` | `getMinValueAsDouble()` The minimum dial value.
    `DrawItem` | `getNeedle()` AutoChild representing the needle shape that points to the gauge's current value.
    `int` | `getNumMajorTicks()` The number of major tick lines.
    `int` | `getNumMinorTicks()` The number of minor tick lines.
    `int` | `getNumSectors()` Gets the number of sectors.
    `static Gauge` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `Point` | `getPivotPoint()` The pivot point of the needle.
    `int` | `getPivotPointHeight()` Default height of the `pivotPoint` if no specific pivotPoint is specified.
    `java.lang.String` | `getPivotPointHeightAsString()` Default height of the `pivotPoint` if no specific pivotPoint is specified.
    `DrawItem` | `getPivotShape()` AutoChild representing the shape drawn at the `pivotPoint` (where all sectors of the gauge meet).
    `java.lang.String[]` | `getSectorColors()` Array of preset fill colors used by the default implementation of `getDefaultFillColor()` to initialize the fill color of new sectors.
    `java.lang.String` | `getSectorFillColor(int sectorIndex)` Gets the fill color of the sector at index `sectorIndex`.
    `java.lang.String` | `getSectorLabelContents(int sectorIndex)` Gets the label contents of the label for the sector at sectorIndex.
    `GaugeSector[]` | `getSectors()` The GaugeSectors contained in this Gauge.
    `DrawSector` | `getSectorShape()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
    `float` | `getSectorValue(int sectorIndex)` Deprecated. `GwtFloatVsDouble`
    `double` | `getSectorValueAsDouble(int sectorIndex)` Gets the value of the sector at `sectorIndex`.
    `DrawItem` | `getTickLine()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
    `float` | `getValue()` Deprecated. `GwtFloatVsDouble`
    `double` | `getValueAsDouble()` The current value on the dial.
    `DrawLabel` | `getValueLabel()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
    `protected void` | `onInit()`
    `void` | `reformatLabelContents()` Resets the contents of all labels.
    `void` | `removeSector(int sectorIndex)` Removes the sector at sectorIndex.
    `void` | `setBorderColor(java.lang.String borderColor)` Color for gauge sector borders.
    `void` | `setBorderWidth(int borderWidth)` Pixel width for gauge sector borders.
    `static void` | `setDefaultProperties(Gauge gaugeProperties)` Class level method to set the default properties of this class.
    `void` | `setDialRadius(double dialRadius)` Radius in pixels of the dial.
    `void` | `setDialRadius(float dialRadius)` Deprecated. `GwtFloatVsDouble`
    `void` | `setDrawnClockwise(boolean drawnClockwise)` Whether the sectors are drawn clockwise, and increasing the value causes the needle to move clockwise.
    `void` | `setFontSize(int fontSize)` Font size of sector labels.
    `void` | `setLabelPrefix(java.lang.String labelPrefix)` The label prefix.
    `void` | `setLabelSuffix(java.lang.String labelSuffix)` The label suffix.
    `com.smartgwt.logicalstructure.core.LogicalStructureObject` | `setLogicalStructure(com.smartgwt.logicalstructure.widgets.drawing.GaugeLogicalStructure s)` Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
    `void` | `setMaxValue(double maxValue)` The maximum dial value.
    `void` | `setMaxValue(float maxValue)` Deprecated. `GwtFloatVsDouble`
    `void` | `setMinValue(double minValue)` The minimum dial value.
    `void` | `setMinValue(float minValue)` Deprecated. `GwtFloatVsDouble`
    `void` | `setNumMajorTicks(int numMajorTicks)` The number of major tick lines.
    `void` | `setNumMinorTicks(int numMinorTicks)` The number of minor tick lines.
    `void` | `setPivotPoint(Point pivotPoint)` The pivot point of the needle.
    `void` | `setPivotPointHeight(int pivotPointHeight)` Default height of the `pivotPoint` if no specific pivotPoint is specified.
    `void` | `setPivotPointHeight(java.lang.String pivotPointHeight)` Default height of the `pivotPoint` if no specific pivotPoint is specified.
    `void` | `setSectorColors(java.lang.String... sectorColors)` Array of preset fill colors used by the default implementation of `getDefaultFillColor()` to initialize the fill color of new sectors.
    `void` | `setSectorFillColor(int sectorIndex, java.lang.String fillColor)` Sets the fill color of the sector at `sectorIndex`.
    `void` | `setSectors(GaugeSector... sectors)` The GaugeSectors contained in this Gauge.
    `void` | `setValue(double value)` The current value on the dial.
    `void` | `setValue(float value)` Deprecated. `GwtFloatVsDouble`

    - ### Methods inherited from class com.smartgwt.client.widgets.drawing.DrawPane

      `addDrawEndHandler, addDrawItem, addDrawStartHandler, addGradient, bezier, bezierExtrema, createLinearGradient, createRadialGradient, createSimpleGradient, destroyItems, erase, getBezierBoundingBox, getCanDragScroll, getDataURL, getDataURL, getDrawingHeight, getDrawingPoint, getDrawingWidth, getDrawingX, getDrawingY, getDrawItems, getEditProxyConstructor, getGradient, getGradients, getPolygonPoints, getPrintHTML, getRegularPolygonPoints, getRotation, getRotationAsDouble, getSvgString, getTranslate, getZoomLevel, getZoomLevelAsDouble, refreshNow, removeGradient, rotate, scaleAndCenter, scaleAndCenterBezier, setCanDragScroll, setDefaultProperties, setDrawingHeight, setDrawingWidth, setDrawItems, setEditProxyConstructor, setGradients, setLogicalStructure, setRotation, setRotation, setTranslate, setZoomLevel, setZoomLevel, zoom, zoom`

    - ### Methods inherited from class com.smartgwt.client.widgets.Canvas

      `addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop`

    - ### Methods inherited from class com.smartgwt.client.widgets.BaseWidget

      `addDrawHandler, applyFactoryProperties, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString`

    - ### Methods inherited from class com.google.gwt.user.client.ui.Widget

      `addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents`

    - ### Methods inherited from class com.google.gwt.user.client.ui.UIObject

      `addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface com.google.gwt.event.shared.HasHandlers

      `fireEvent`

- - ### Constructor Detail

    - #### Gauge

          public Gauge()

    - #### Gauge

          public Gauge(com.google.gwt.core.client.JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static Gauge getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### changeAutoChildDefaults

          public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                                     Canvas defaults)

      Changes the defaults for Canvas AutoChildren named `autoChildName`.
      Parameters:
        `autoChildName` - name of an AutoChild to customize the defaults for.
        `defaults` - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see `SGWTProperties`.
      See Also:
        `AutoChildUsage`

    - #### changeAutoChildDefaults

          public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                                     FormItem defaults)

      Changes the defaults for FormItem AutoChildren named `autoChildName`.
      Parameters:
        `autoChildName` - name of an AutoChild to customize the defaults for.
        `defaults` - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see `SGWTProperties`.
      See Also:
        `AutoChildUsage`

    - #### create

          protected com.google.gwt.core.client.JavaScriptObject create()

      Overrides:
        `create` in class `DrawPane`

    - #### setBorderColor

          public void setBorderColor(java.lang.String borderColor)
                              throws java.lang.IllegalStateException

      Color for gauge sector borders.
      Parameters:
        `borderColor` - See `CSSColor` . Default value is "#333333"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created
      See Also:
        `DrawItem.setLineColor(java.lang.String)`

    - #### getBorderColor

          public java.lang.String getBorderColor()

      Color for gauge sector borders.
      Returns:
        See `CSSColor`
      See Also:
        `DrawItem.getLineColor()`

    - #### setBorderWidth

          public void setBorderWidth(int borderWidth)
                              throws java.lang.IllegalStateException

      Pixel width for gauge sector borders.
      Parameters:
        `borderWidth` - Default value is 1
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created
      See Also:
        `DrawItem.setLineWidth(int)`

    - #### getBorderWidth

          public int getBorderWidth()

      Pixel width for gauge sector borders.
      Returns:
        int
      See Also:
        `DrawItem.getLineWidth()`

    - #### setDialRadius

          public void setDialRadius(float dialRadius)

      Deprecated. `GwtFloatVsDouble`
      Radius in pixels of the dial.
      If this method is called after the component has been drawn/initialized: All DrawItems currently associated with this Gauge are destroyed and new DrawItems are created instead.
      Parameters:
        `dialRadius` - Radius in pixels of the dial. Default value is 150

    - #### getDialRadius

          public float getDialRadius()

      Deprecated. `GwtFloatVsDouble`
      Radius in pixels of the dial.
      Returns:
        float

    - #### setDialRadius

          public void setDialRadius(double dialRadius)

      Radius in pixels of the dial.
      If this method is called after the component has been drawn/initialized: All DrawItems currently associated with this Gauge are destroyed and new DrawItems are created instead.
      Parameters:
        `dialRadius` - Radius in pixels of the dial. Default value is 150

    - #### getDialRadiusAsDouble

          public double getDialRadiusAsDouble()

      Radius in pixels of the dial.
      Returns:
        double

    - #### setDrawnClockwise

          public void setDrawnClockwise(boolean drawnClockwise)

      Whether the sectors are drawn clockwise, and increasing the value causes the needle to move clockwise.
      If this method is called after the component has been drawn/initialized: Sets the `drawnClockwise` property and redraws the gauge.
      Parameters:
        `drawnClockwise` - whether the sectors are drawn clockwise.. Default value is true

    - #### getDrawnClockwise

          public boolean getDrawnClockwise()

      Whether the sectors are drawn clockwise, and increasing the value causes the needle to move clockwise.
      Returns:
        boolean

    - #### setFontSize

          public void setFontSize(int fontSize)
                           throws java.lang.IllegalStateException

      Font size of sector labels. Must be at least 3.
      Parameters:
        `fontSize` - Default value is 11
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created
      See Also:
        `DrawLabel.setFontSize(int)`

    - #### getFontSize

          public int getFontSize()

      Font size of sector labels. Must be at least 3.
      Returns:
        int
      See Also:
        `DrawLabel.getFontSize()`

    - #### setLabelPrefix

          public void setLabelPrefix(java.lang.String labelPrefix)

      The label prefix.
      If this method is called after the component has been drawn/initialized: Sets the `labelPrefix` property and re-creates all sector labels.
      Parameters:
        `labelPrefix` - the new label prefix.. Default value is ""
      See Also:
        `formatLabelContents(float)`

    - #### getLabelPrefix

          public java.lang.String getLabelPrefix()

      The label prefix.
      Returns:
        String
      See Also:
        `formatLabelContents(float)`

    - #### setLabelSuffix

          public void setLabelSuffix(java.lang.String labelSuffix)

      The label suffix.
      If this method is called after the component has been drawn/initialized: Sets the `labelSuffix` property and re-creates all sector labels.
      Parameters:
        `labelSuffix` - the new label suffix.. Default value is "%"
      See Also:
        `formatLabelContents(float)`

    - #### getLabelSuffix

          public java.lang.String getLabelSuffix()

      The label suffix.
      Returns:
        String
      See Also:
        `formatLabelContents(float)`

    - #### setMaxValue

          public void setMaxValue(float maxValue)

      Deprecated. `GwtFloatVsDouble`
      The maximum dial value.
      If this method is called after the component has been drawn/initialized: Sets the maximum dial value, rescaling all sectors and the dial value.
      Parameters:
        `maxValue` - the new maximum dial value. Must be at least 1 greater than the minimum dial value. If `maxValue` is not at least 1 greater than the minimum value, then it is set to `1 + minValue`.. Default value is 100

    - #### getMaxValue

          public float getMaxValue()

      Deprecated. `GwtFloatVsDouble`
      The maximum dial value.
      Returns:
        float

    - #### setMaxValue

          public void setMaxValue(double maxValue)

      The maximum dial value.
      If this method is called after the component has been drawn/initialized: Sets the maximum dial value, rescaling all sectors and the dial value.
      Parameters:
        `maxValue` - the new maximum dial value. Must be at least 1 greater than the minimum dial value. If `maxValue` is not at least 1 greater than the minimum value, then it is set to `1 + minValue`.. Default value is 100

    - #### getMaxValueAsDouble

          public double getMaxValueAsDouble()

      The maximum dial value.
      Returns:
        double

    - #### setMinValue

          public void setMinValue(float minValue)

      Deprecated. `GwtFloatVsDouble`
      The minimum dial value.
      If this method is called after the component has been drawn/initialized: Sets the minimum dial value, rescaling all sectors and the dial value.
      Parameters:
        `minValue` - the new minimum dial value. Must be at least 1 less than the maximum dial value. If `minValue` is not at least 1 less than the maximum value, then it is set to `maxValue - 1`.. Default value is 0

    - #### getMinValue

          public float getMinValue()

      Deprecated. `GwtFloatVsDouble`
      The minimum dial value.
      Returns:
        float

    - #### setMinValue

          public void setMinValue(double minValue)

      The minimum dial value.
      If this method is called after the component has been drawn/initialized: Sets the minimum dial value, rescaling all sectors and the dial value.
      Parameters:
        `minValue` - the new minimum dial value. Must be at least 1 less than the maximum dial value. If `minValue` is not at least 1 less than the maximum value, then it is set to `maxValue - 1`.. Default value is 0

    - #### getMinValueAsDouble

          public double getMinValueAsDouble()

      The minimum dial value.
      Returns:
        double

    - #### getNeedle

          public DrawItem getNeedle()
                             throws java.lang.IllegalStateException

      AutoChild representing the needle shape that points to the gauge's current value. Default is to use a DrawTriangle.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        DrawItem
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setNumMajorTicks

          public void setNumMajorTicks(int numMajorTicks)

      The number of major tick lines.
      If this method is called after the component has been drawn/initialized: Sets the number of major tick lines.

      NOTE: To divide the dial into n regions, you will need n + 1 ticks. For example, if the minimum value is 0 and the maximum value is 100, then to place major tick lines at 0, 10, 20, 30, ..., 90, 100, you need 11 (10 + 1) major ticks.

      Parameters:
        `numMajorTicks` - the number of major tick lines to draw. Must be either 0 or an integer greater than or equal to 2.. Default value is 0

    - #### getNumMajorTicks

          public int getNumMajorTicks()

      The number of major tick lines.
      Returns:
        int

    - #### setNumMinorTicks

          public void setNumMinorTicks(int numMinorTicks)

      The number of minor tick lines.
      If this method is called after the component has been drawn/initialized: Sets the number of minor tick lines.

      NOTE: To divide the dial into n regions, you will need n + 1 ticks. For example, if the minimum value is 0 and the maximum value is 100, then to place minor tick lines at 0, 1, 2, 3, 4, 5, ..., 99, 100, you need 101 (100 + 1) minor ticks.

      Parameters:
        `numMinorTicks` - the number of minor tick lines to draw. Must be either 0 or an integer greater than or equal to 2.. Default value is 0

    - #### getNumMinorTicks

          public int getNumMinorTicks()

      The number of minor tick lines.
      Returns:
        int

    - #### setPivotPoint

          public void setPivotPoint(Point pivotPoint)

      The pivot point of the needle.
      If this method is called after the component has been drawn/initialized: All DrawItems currently associated with this Gauge are destroyed and new DrawItems are created instead.

      The pivot point is set by default by choosing 1/2 of width and 70% of height of the Gauge. See `pivotPointHeight`

      Parameters:
        `pivotPoint` - The pivot point of the needle. Default value is null

    - #### getPivotPoint

          public Point getPivotPoint()

      The pivot point of the needle.
      Returns:
        Point

    - #### setPivotPointHeight

          public void setPivotPointHeight(int pivotPointHeight)
                                   throws java.lang.IllegalStateException

      Default height of the `pivotPoint` if no specific pivotPoint is specified.

      Can be specified as a numeric pixel value, or a String percentage value.

      Parameters:
        `pivotPointHeight` - Default value is "70%"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getPivotPointHeight

          public int getPivotPointHeight()

      Default height of the `pivotPoint` if no specific pivotPoint is specified.

      Can be specified as a numeric pixel value, or a String percentage value.

      Returns:
        int

    - #### setPivotPointHeight

          public void setPivotPointHeight(java.lang.String pivotPointHeight)
                                   throws java.lang.IllegalStateException

      Default height of the `pivotPoint` if no specific pivotPoint is specified.

      Can be specified as a numeric pixel value, or a String percentage value.

      Parameters:
        `pivotPointHeight` - Default value is "70%"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getPivotPointHeightAsString

          public java.lang.String getPivotPointHeightAsString()

      Default height of the `pivotPoint` if no specific pivotPoint is specified.

      Can be specified as a numeric pixel value, or a String percentage value.

      Returns:
        String

    - #### getPivotShape

          public DrawItem getPivotShape()
                                 throws java.lang.IllegalStateException

      AutoChild representing the shape drawn at the `pivotPoint` (where all sectors of the gauge meet).

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        DrawItem
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setSectorColors

          public void setSectorColors(java.lang.String... sectorColors)
                               throws java.lang.IllegalStateException

      Array of preset fill colors used by the default implementation of `getDefaultFillColor()` to initialize the fill color of new sectors.

      The default array of colors is:

      #AFFFFF | #008080 | #AAAFFF | #FF0000 | #FFCC99 | #800080

      Parameters:
        `sectorColors` - See `CSSColor` . Default value is [ "#AFFFFF", "#008080", "#AAAFFF", "#FF0000", "#FFCC99", "#800080" ]
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created
      See Also:
        `DrawItem.setFillColor(java.lang.String)`

    - #### getSectorColors

          public java.lang.String[] getSectorColors()

      Array of preset fill colors used by the default implementation of `getDefaultFillColor()` to initialize the fill color of new sectors.

      The default array of colors is:

      #AFFFFF | #008080 | #AAAFFF | #FF0000 | #FFCC99 | #800080

      Returns:
        See `CSSColor`
      See Also:
        `DrawItem.getFillColor()`

    - #### setSectors

          public void setSectors(GaugeSector... sectors)

      The GaugeSectors contained in this Gauge. If this this property is not specified, the gauge will be created with a default sector filling the gauge.
      If this method is called after the component has been drawn/initialized: Sets the sectors for this gauge.
      Parameters:
        `sectors` - the sectors to show on the gauge.. Default value is null

    - #### getSectors

          public GaugeSector[] getSectors()

      The GaugeSectors contained in this Gauge. If this this property is not specified, the gauge will be created with a default sector filling the gauge.
      Returns:
        GaugeSector...

    - #### getSectorShape

          public DrawSector getSectorShape()

      Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See `Using AutoChildren` for details.

      MultiAutoChild representing the sectors drawn to show different segments of the gauge.

      Returns:
        null

    - #### getTickLine

          public DrawItem getTickLine()

      Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See `Using AutoChildren` for details.

      MultiAutoChild representing the tick marks drawn along the circumference of the gauge. Default is to use DrawLine.

      Returns:
        null

    - #### setValue

          public void setValue(float value)

      Deprecated. `GwtFloatVsDouble`
      The current value on the dial.
      If this method is called after the component has been drawn/initialized: Sets the value on the dial that the needle is displaying.
      Parameters:
        `value` - the new dial value. Must be between `minValue` and `maxValue`.. Default value is 0

    - #### getValue

          public float getValue()

      Deprecated. `GwtFloatVsDouble`
      The current value on the dial.
      Returns:
        float

    - #### setValue

          public void setValue(double value)

      The current value on the dial.
      If this method is called after the component has been drawn/initialized: Sets the value on the dial that the needle is displaying.
      Parameters:
        `value` - the new dial value. Must be between `minValue` and `maxValue`.. Default value is 0

    - #### getValueAsDouble

          public double getValueAsDouble()

      The current value on the dial.
      Returns:
        double

    - #### getValueLabel

          public DrawLabel getValueLabel()

      Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See `Using AutoChildren` for details.

      MultiAutoChild representing the labels used to different data points on the gauge.

      Returns:
        null

    - #### addSector

          public int addSector(GaugeSector newSector)

      Adds a new sector.
      Parameters:
        `newSector` - the new GaugeSector or the new sector's value. This is formatted with `formatLabelContents()` to get its label.
      Returns:
        the index of the newly-added sector.

    - #### addSector

          public int addSector(double newSector)

      Adds a new sector.
      Parameters:
        `newSector` - the new GaugeSector or the new sector's value. This is formatted with `formatLabelContents()` to get its label.
      Returns:
        the index of the newly-added sector.

    - #### getNumSectors

          public int getNumSectors()

      Gets the number of sectors.
      Returns:
        the number of sectors on this gauge.

    - #### getSectorFillColor

          public java.lang.String getSectorFillColor(int sectorIndex)

      Gets the fill color of the sector at index `sectorIndex`.
      Parameters:
        `sectorIndex` - index of the target sector.
      Returns:
        the fill color of the sector at `sectorIndex`.
      See Also:
        `DrawItem.getFillColor()`

    - #### getSectorLabelContents

          public java.lang.String getSectorLabelContents(int sectorIndex)

      Gets the label contents of the label for the sector at sectorIndex.
      Parameters:
        `sectorIndex` - index of the target sector.
      Returns:
        the label contents of the sector's label.

    - #### getSectorValue

          public float getSectorValue(int sectorIndex)

      Deprecated. `GwtFloatVsDouble`
      Gets the value of the sector at `sectorIndex`.
      Parameters:
        `sectorIndex` - index of the target sector.
      Returns:
        the value of the sector at `sectorIndex`.

    - #### getSectorValueAsDouble

          public double getSectorValueAsDouble(int sectorIndex)

      Gets the value of the sector at `sectorIndex`.
      Parameters:
        `sectorIndex` - index of the target sector.
      Returns:
        the value of the sector at `sectorIndex`.

    - #### reformatLabelContents

          public void reformatLabelContents()

      Resets the contents of all labels. This involves calling `formatLabelContents()` to get the label contents for each corresponding value and repositioning the label.

    - #### removeSector

          public void removeSector(int sectorIndex)

      Removes the sector at sectorIndex.

      NOTE: There must always be one sector and it is not possible to remove the sole remaining sector. Calling this method to attempt to remove the sole remaining sector is a no-op.

      Parameters:
        `sectorIndex` - the index of the sector to remove.

    - #### setSectorFillColor

          public void setSectorFillColor(int sectorIndex,
                                         java.lang.String fillColor)

      Sets the fill color of the sector at `sectorIndex`.
      Parameters:
        `sectorIndex` - index of the target sector.
        `fillColor` - the new fill color.. See `CSSColor`
      See Also:
        `DrawItem.setFillColor(java.lang.String)`

    - #### setDefaultProperties

          public static void setDefaultProperties(Gauge gaugeProperties)

      Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

      Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

      Parameters:
        `gaugeProperties` - properties that should be used as new defaults when instances of this class are created
      See Also:
        `SGWTProperties`

    - #### onInit

          protected void onInit()

      Overrides:
        `onInit` in class `Canvas`

    - #### formatLabelContents

          protected java.lang.String formatLabelContents(float value)

      Formats a value as a string to be used as the contents of a `DrawLabel`. The default implementation prepends `labelPrefix` and appends `labelSuffix` to `value`.

      NOTE: This is an override point. If a subclass overrides this, then whenever it changes the way that values are formatted, it should call `Gauge.reformatLabelContents`.

      Parameters:
        `value` - the value to format.
      Returns:
        label contents.

    - #### getDefaultFillColor

          protected java.lang.String getDefaultFillColor(int sectorIndex)

      Gets the default fill color for the sector at index `sectorIndex`. The default implementation cycles through `sectorColors` using modular arithmetic.

      Note: This is an override point.

      Parameters:
        `sectorIndex` - index of the target sector.
      Returns:
        a fill color.

    - #### setLogicalStructure

          public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.drawing.GaugeLogicalStructure s)

      Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.

    - #### getLogicalStructure

          public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

      Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
      Specified by:
        `getLogicalStructure` in interface `LogicalStructure`
      Overrides:
        `getLogicalStructure` in class `DrawPane`