A segmented-style range indicator for rectangular gauges. This class will be replaced by a cleaner implementation in a future version.
Creates a segmented range indicator.
>Creates a segmented range indicator. >See the dojox/dgauges/RectangularSegmentedRangeIndicator reference documentation for more information.
Used across all instances a hash to cache attribute names and their getter and setter names.
An array containing objects to define color ranges. Example [{color:"#FF0000", size:20}, {color:"#FF8800", size:50}].
Indicates if the extremity segments are rounded. Default is true.
The number of segments making the indicator. By default it is 10.
The blank space between two segments. The default value is 2
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. |
Internal helper for directly changing an attribute value.
Internal method.
| Parameter | Type | Description |
|---|---|---|
| indicator | undefined | |
| group | undefined | |
| scale | undefined | |
| startX | number | |
| startY | undefined | |
| endPosition | undefined | |
| startThickness | undefined | |
| endThickness | undefined | |
| fill | undefined | |
| stroke | undefined |
Internal method.
| Parameter | Type | Description |
|---|---|---|
| indicator | undefined | |
| group | undefined | |
| scale | undefined | |
| startX | undefined | |
| startY | number | |
| endPosition | undefined | |
| startThickness | undefined | |
| endThickness | undefined | |
| fill | undefined | |
| stroke | undefined |
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 |
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 |
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 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. |
The property value on this Stateful instance.
require(["dojo/Stateful", function(Stateful) {
var stateful = new Stateful({foo: 3});
stateful.get("foo") // returns 3
stateful.foo // returns 3
});
Internal method.
| Parameter | Type | Description |
|---|---|---|
| group | undefined | |
| indicator | undefined | |
| startX | undefined | |
| startY | undefined | |
| endPosition | undefined | |
| startThickness | undefined | |
| endThickness | undefined | |
| fill | undefined | |
| stroke | undefined |
Invalidating the rendering for the next executation frame.
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. |
The function returns this dojo.Stateful instance.
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)
Immediately validate the rendering if it has been invalidated. You generally do not call that method yourself.
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. |
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