Class: scaleWidget

Extends

• geo.gui.svgWidget

Type Definitions

geo.gui.scaleWidget.specobject

Scale widget specification.

Properties:

Name	Type	Argument	Default	Description
scale	number	<optional>	1	A scale applied to the map gcs units to convert to the scale units.
maxWidth	number	<optional>	200	The maximum width of the scale in pixels. For horizontal scales (orientation is top or bottom) this is the maximum length of the scale bar. For vertical scales, this is the width available for the scale text.
maxHeight	number	<optional>		The maximum height of the scale in pixels. For vertical scales (orientation is left or right) this is the maximum length of the scale bar. For horizontal scales, this is the height available for the scale text. Default is 200 for vertical scales, 20 for horizontal scales.
orientation	string	<optional>	'bottom'	One of left, right, top, or bottom. The scale text is placed in that location relative to the scale bar.
strokeWidth	number	<optional>	2	The width of the ticks and scale bar in pixels.
tickLength	number	<optional>	10	The length of the end ticks in pixels.
units	string | Array.<geo.gui.scaleWidget.unit>	<optional>	'si'	One of either 'si' or 'miles' or an array of units in ascending order. See the UnitsTable for examples.
distance	function	<optional>		The function used to compute the length of the scale bar. This defaults to transform.sphericalDistance for all maps except those with a gcs of '+proj=longlat +axis=enu', where math.sqrt(util.distance2dSquared(pt1, pt2)) is used instead.

geo.gui.scaleWidget.unitobject

Scale widget unit specification.

Properties:

Name	Type	Argument	Default	Description
unit	string			Display name for the unit.
scale	number			Scale for 1 unit in the current system.
minimum	number	<optional>	1	Minimum value where this applies after scaling. This can be used to handle singular and plural words (e.g., [{units: 'meter', scale: 1}, {units: 'meters', scale: 1, minimum: 1.5}])
basis	number	<optional>	10	The basis for the multiples value.
multiples	Array.<object>	<optional>		A list of objects in ascending value order that determine what round values are displayed. Properties Name Type Description multiple number The value that is selected for display. digit number The number of significant digits in mutliple.

geo.gui.scaleWidget.unitTableRecordobject

For a unit table, the records are ordered smallest scale to largest scale. The smallest unit can be repeated to have different rounding behavior for values less than 1 and values greater than or equal to 1.

Properties:

Name	Type	Argument	Default	Description
unit	string			The display name of the unit.
scale	number			The size of the unit in base unit.
basis	number	<optional>	10	The number of units in the next greater unit if not a power of 10.
multiples	Array.<object>	<optional>		A list of multiplier values to round to when rounding is used. The list should probably include a multiple of 1. Default is 1, 1.5, 2, 3, 5, 8. Properties Name Type Description multiple number A factor to round to. digit number The number of digits to preserve when rounding.

Static Members

staticgeo.gui.scaleWidget.areaUnitsTable

The areaUnitsTable has predefined unit sets for a base unit of one square meter. Each entry is an array that must be in ascending order. This table can be passed to formatUnit.

Properties:

Name	Type	Description
areaUnitsTable	object	The key names are the names of unit systems, such as si. Properties Name Type Description unit Array.<geo.gui.scaleWidget.unitTableRecord> A list of units within the unit system from smallest to largest.

staticgeo.gui.scaleWidget.unitsTable

The unitsTable has predefined unit sets for a base unit of one meter. Each entry is an array that must be in ascending order. Use unicode in strings, not html entities. It makes it more reusable.

Properties:

Name	Type	Description
unitsTable	object	The key names are the names of unit systems, such as si. Properties Name Type Description unit Array.<geo.gui.scaleWidget.unitTableRecord> A list of units within the unit system from smallest to largest.

Members

inherited idle

Getter for the idle state. Read only.

Properties:

Name	Type	Description
idle	boolean	true if the object is idle (onIdle would call a handler immediately).

Static Methods

staticgeo.gui.scaleWidget.formatUnit(val, unit, table, digits){string}

ui/scaleWidget.js, line 434

Format a unit with a specified number of significant figures. Given a value in base units, such as meters, this will return a string with appropriate units. For instance, formatUnit(0.345) will return 345 mm.

Name	Type	Default	Description
val	number		The value. A length or area in base units. With the default unit table, this is in meters. With the areaUnitsTable, this is square meters.
unit	string | Array.<object>	'si'	optional The name of the unit system or a unit table.
table	object	unitTable	optional The table of the unit system. Ignored if unit is a unit table.
digits	number	3	optional The minimum number of significant figures.

Returns:

Type	Description
string	A formatted string or undefined.

Methods

inherited addChild(child){this}

sceneObject.js, line 79

Add a child (or an array of children) to the object.

Name	Type	Description
child	geo.object | Array.<geo.object>	A child object or array of child objects.

Returns:

Type	Description
this

inherited addPromise(promise){this}

sceneObject.js, line 35

Add the promise here and also propagate up the scene tree.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

inherited canvas(val){HTMLElement|this}

ui/widget.js, line 112

Get/Set the canvas for the widget.

Name	Type	Description
val	HTMLElement	optional If specified, set the canvas, otherwise get the canvas.

Returns:

Type	Description
HTMLElement | this	If getting the canvas, return the current value; otherwise, return this widget.

inherited children(){Array.<geo.object>}

sceneObject.js, line 110

Get an array of the child objects.

Returns:

Type	Description
Array.<geo.object>	A copy of the array of child objects.

inherited draw(arg){this}

sceneObject.js, line 121

Force redraw of a scene object, to be implemented by subclasses. Base class just calls draw of child objects.

Name	Type	Description
arg	object	Options to pass to the child draw functions.

Returns:

Type	Description
this

inherited geoIsOn(event, handler){boolean}

object.js, line 187

Report if an event handler is bound to this object.

Name	Type	Description
event	string | Array.<string>	An event or list of events to check.
handler	function	optional A function that might be bound. If undefined, this will report true if there is any handler for the specified event.

Returns:

Type	Description
boolean	true if any of the specified events are bound to the specified handler.

inherited geoOff(event, arg){this}

object.js, line 246

Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.

Name	Type	Description
event	string | Array.<string>	optional An event or a list of events from geo.event or defined by the user, or undefined to remove all events (in which case arg is ignored).
arg	function | Array.<function()>	optional nullable A function or array of functions to remove from the events or a falsy value to remove all handlers from the events.

Returns:

Type	Description
this

inherited geoOn(event, handler){this}

object.js, line 139

Bind an event handler to this object.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
this

inherited geoOnce(event, handler){function}

object.js, line 168

Bind an event handler to this object that will fire once and then deregister itself.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
function	The actual bound handler. This is a wrapper around the handler that was passed to the function.

inherited geoTrigger(event, args, childrenOnly){this}

sceneObject.js, line 136

Trigger an event (or events) on this object and call all handlers.

Name	Type	Description
event	string	The event to trigger.
args	object	Arbitrary argument to pass to the handler.
childrenOnly	boolean	optional If truthy, only propagate down the tree.

Returns:

Type	Description
this

inherited isInViewport(){boolean}

ui/widget.js, line 232

Report if the top left of widget (or its current x, y position) is within the viewport.

Returns:

Type	Description
boolean	True if the widget is within the viewport.

inherited layer(){geo.layer}

ui/widget.js, line 93

Return the layer associated with this widget.

Returns:

Type	Description
geo.layer

inherited modified(){this}

timestamp.js, line 25

Update the timestamp to the next global timestamp value.

Returns:

Type	Description
this

inherited onIdle(handler){this}

object.js, line 36

Bind a handler that will be called one time when all internal promises are resolved. If there are no outstanding promises, this is invoked synchronously.

Name	Type	Description
handler	function	A function taking no arguments.

Returns:

Type	Description
this

options(arg1, arg2){object|this}

ui/scaleWidget.js, line 311

Get or set options.

Name	Type	Description
arg1	string | object	optional If undefined, return the options object. If a string, either set or return the option of that name. If an object, update the options with the object's values.
arg2	object	optional If arg1 is a string and this is defined, set the option to this value.

Returns:

Type	Description
object | this	If options are set, return the annotation, otherwise return the requested option or the set of options.

inherited parent(arg){this|geo.sceneObject}

sceneObject.js, line 64

Get/set parent of the object.

Name	Type	Description
arg	geo.sceneObject	optional The new parant or undefined to get the current parent.

Returns:

Type	Description
this | geo.sceneObject

inherited parentCanvas(){HTMLElement}

ui/widget.js, line 135

Get the parent canvas (top level widgets define their layer as their parent canvas).

Returns:

Type	Description
HTMLElement	The canvas of the widget's parent.

inherited position(pos, actualValue){geo.gui.widget.position|this}

ui/widget.js, line 154

Get or set the CSS positioning that a widget should be placed at.

Name	Type	Description
pos	geo.gui.widget.position	optional If unspecified, return the current position. Otherwise, set the current position.
actualValue	boolean	optional If getting the position, if this is truthy, always return the stored value, not a value adjusted for display.

Returns:

Type	Description
geo.gui.widget.position | this	Either the position or the widget instance. If this is the position and actualValue is falsy, positions that specify an explicit x and y parameter will be converted to a value that can be used by the display css.

inherited removeChild(child){this}

sceneObject.js, line 96

Remove a child (or array of children) from the object.

Name	Type	Description
child	geo.object | Array.<geo.object>	A child object or array of child objects.

Returns:

Type	Description
this

inherited removePromise(promise){this}

sceneObject.js, line 49

Remove the promise here and also propagate up the scene tree.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

inherited reposition(position){this}

ui/widget.js, line 191

Repositions a widget.

Name	Type	Description
position	geo.gui.widget.position	optional The new position for the widget. undefined uses the stored position value.

Returns:

Type	Description
this

inherited repositionEvent(){this}

ui/widget.js, line 222

If the position is based on map coordinates, this gets called when the map is panned to resposition the widget.

Returns:

Type	Description
this

inherited timestamp(){number}

timestamp.js, line 37

Get time.

Returns:

Type	Description
number	The timestamp. This is 0 if the timestamp has never been modified.