The rectangular scale. A scaler must be set to use this class.
See the dojox/dgauges/RectangularScale reference documentation for more information.
Used across all instances a hash to cache attribute names and their getter and setter names.
The font used for the ticks labels. This is null by default which means this scale use the font defined on the gauge.
The label gap between the ticks and their labels. Default value is 1.
See CircularScale and RectangularScale for valid values.
The scaler used for tick generation and data-transform operations. This property is mandatory for using the scale.
The GFX stroke used by the default tickShapeFunc implementation.
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.
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 |
Internal method.
An object specifying the default properties for a Font used in text operations.
Internal method.
| Parameter | Type | Description |
|---|---|---|
| name | undefined | |
| oldValue | undefined | |
| newValue | undefined |
Add an indicator to the scale. Before calling this function, ensure this scale has already been added to a gauge using the addElement method of the gauge.
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the indicator to be added. |
| indicator | dojox/dgauges/IndicatorBase | The indicator to add to this scale. |
| behindScale | Boolean | If true, this indicator is drawn behind the scale. Default value is false. |
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
});
Get an indicator instance.
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the indicator as defined using addIndicator. |
The indicator associated with the name parameter.
Gets the GFX shape of an indicator.
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the indicator as defined using addIndicator. |
The GFX shape of the indicator.
Invalidating the rendering for the next executation frame.
Transforms a value into a position using the associated scaler.
| Parameter | Type | Description |
|---|---|---|
| value | undefined | The value to transform. |
A position in pixels.
Removes an indicator.
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the indicator as defined using addIndicator. |
The removed indicator.
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)
Customize the text of ticks labels.
| Parameter | Type | Description |
|---|---|---|
| tickItem | Object | An object containing the tick informations. |
The text to be aligned with the tick. If null, the tick has no label.
Customize the shape of ticks.
| Parameter | Type | Description |
|---|---|---|
| group | dojox/gfx/Group | The GFX group used for drawing the tick. |
| scale | dojox/dgauges/ScaleBase | The scale being processed. |
| tickItem | Object | An object containing the tick informations. |
Immediately validate the rendering if it has been invalidated. You generally do not call that method yourself.
Transforms a position in pixels into a value using the associated scaler.
| Parameter | Type | Description |
|---|---|---|
| pos | undefined | The position to transform. |
The value represented by pos.
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