dojox/dgauges/RectangularValueIndicator (version 1.10)

dojox/dgauges/ScaleIndicatorBase

Summary

The rectangular value indicator, typically used for creating markers or thumbs.

Usage

var foo = new RectangularValueIndicator();
dojox/dgauges/RectangularValueIndicator

See the dojox/dgauges/RectangularValueIndicator reference documentation for more information.

Property Summary

Method Summary

Event Summary

Properties

_animation
_attrPairNames
Defined by: dojo/Stateful

Used across all instances a hash to cache attribute names and their getter and setter names.

_cursorListeners
_downListeners
_indicatorShapeFuncFlag
_interactionAreaFlag
_moveAndUpListeners
_preventAnimation
_transitionValue
animationDuration

The duration of the value change animation in milliseconds. Default is 0. The animation occurs on both user interactions and programmatic value changes. Set this property to 0 to disable animation.

animationEaser

The easer function of the value change animation. Default is fx._defaultEasing.

interactionArea

How to interact with the indicator using mouse or touch interactions. Can be "indicator", "gauge", "area" or "none". The default value is "gauge". If set to "indicator", the indicator shape reacts to mouse and touch events. If set to "gauge", the whole gauge reacts to mouse and touch events. If set to "area", the whole bounding box of the widget reacts to mouse and touch events. If "none", interactions are disabled.

interactionMode

Deprecated. Can be "mouse" or "touch".

invalidatingProperties
invalidRendering
paddingBottom

The bottom padding.

paddingLeft

The left padding.

paddingRight

The right padding.

paddingTop

The top padding.

Methods

_changeAttrValue(name,value)
Defined by dojo/Stateful

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Parameter Type Description
name String

The property to set.

value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_connectCursorListeners(target)

Internal method.

Parameter Type Description
target undefined
_connectDownListeners()

Internal method.

Returns:boolean
_connectMoveAndUpListeners()

Internal method.

_disconnectCursorListeners()

Internal method.

_disconnectDownListeners()

Internal method.

_disconnectListeners()

Internal method.

_disconnectMoveAndUpListeners()

Internal method.

_endAnimation()

Internal method.

_endEditing()

Internal method.

_get(name,names)
Defined by dojo/Stateful

Private function that does a get based off a hash of names

Parameter Type Description
name undefined
names undefined

Hash of names of custom attributes

Returns:undefined
_getAttrNames(name)
Defined by dojo/Stateful

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
_startAnimation(prop,oldValue,newValue)

Internal method.

Parameter Type Description
prop undefined
oldValue undefined
newValue undefined
_startEditing()

Internal method.

_updateAnimation(v)

Internal method.

Parameter Type Description
v undefined
addInvalidatingProperties(properties)

Add properties to the watched properties to trigger invalidation. This method must be called in the constructor. It is typically used by subclasses of a _Invalidating class to add more properties to watch for.

Parameter Type Description
properties String[]

The list of properties to watch for.

get(name)
Defined by dojo/Stateful

Get a property on a Stateful instance.

Get a named property on a Stateful object. The property may potentially be retrieved via a getter method in subclasses. In the base class this just retrieves the object's property.

Parameter Type Description
name String

The property to get.

Returns:any | undefined

The property value on this Stateful instance.

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful({foo: 3});
    stateful.get("foo") // returns 3
    stateful.foo // returns 3
});
indicatorShapeFunc(group,indicator)

Draws the indicator.

Parameter Type Description
group dojox/gfx/Group

A GFX group for drawing. The indicator is always centered horizontally and is automatically rotated if the scale is vertical.

indicator dojox/dgauges/IndicatorBase

A reference to this indicator.

Returns:dojox/gfx/shape.Shape | undefined

A GFX shape retrievable using the getIndicatorRenderer method of the associated scale.

invalidateRendering()

Invalidating the rendering for the next executation frame.

postscript(mixin)
Parameter Type Description
mixin undefined
refreshRendering()
set(name,value)
Defined by dojo/Stateful

Set a property on a Stateful instance

Sets named properties on a stateful object and notifies any watchers of the property. A programmatic setter may be defined in subclasses.

Parameter Type Description
name String

The property to set.

value Object

The value to set in the property.

Returns:any | function

The function returns this dojo.Stateful instance.

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful();
    stateful.watch(function(name, oldValue, value){
        // this will be called on the set below
    }
    stateful.set(foo, 5);

set() may also be called with a hash of name/value pairs, ex:

stateful.set({
    foo: "Howdy",
    bar: 3
});
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

validateRendering()

Immediately validate the rendering if it has been invalidated. You generally do not call that method yourself.

valueChanged(indicator)

Invoked when the value of the indicator changes. User can connect an listener on this function:

theIndicator.on("valueChanged", lang.hitch(this, function(){
    //do something
}));
Parameter Type Description
indicator undefined
watch(name,callback)
Defined by dojo/Stateful

Watches a property for changes

Parameter Type Description
name String
Optional

Indicates the property to watch. This is optional (the callback may be the only parameter), and if omitted, all the properties will be watched

callback Function

The function to execute when the property changes. This will be called after the property has been changed. The callback will be called with the |this| set to the instance, the first argument as the name of the property, the second argument as the old value and the third argument as the new value.

Returns:any | object

An object handle for the watch. The unwatch method of this object can be used to discontinue watching this property:

var watchHandle = obj.watch("foo", callback);
watchHandle.unwatch(); // callback won't be called now

Events

_onMouseDown(event)

Internal method.

Parameter Type Description
event undefined

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful();
    stateful.watch(function(name, oldValue, value){
        // this will be called on the set below
    }
    stateful.set(foo, 5);

set() may also be called with a hash of name/value pairs, ex:

stateful.set({
    foo: "Howdy",
    bar: 3
});
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

_onMouseMove(event)

Internal method.

Parameter Type Description
event undefined

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful();
    stateful.watch(function(name, oldValue, value){
        // this will be called on the set below
    }
    stateful.set(foo, 5);

set() may also be called with a hash of name/value pairs, ex:

stateful.set({
    foo: "Howdy",
    bar: 3
});
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

_onMouseUp(event)

Internal method.

Parameter Type Description
event undefined

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful();
    stateful.watch(function(name, oldValue, value){
        // this will be called on the set below
    }
    stateful.set(foo, 5);

set() may also be called with a hash of name/value pairs, ex:

stateful.set({
    foo: "Howdy",
    bar: 3
});
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Error in the documentation? Can’t find what you are looking for? Let us know!