Class: colorLegendWidget

geo.gui. colorLegendWidget

new geo.gui.colorLegendWidget(arg){geo.gui.colorLegendWidget}

A UI widget that enables display discrete colors or two-color continuous transition legend.

Name Type Description
arg object optional

Widget options.

Name Type Default Description
position geo.gui.widget.position optional

Position setting relatively to the map container.

categories Array.<geo.gui.colorLegendWidget.category> optional

An array of category definitions for the initial color legends

width number 300 optional

The width of the widget in pixels.

ticks number 6 optional

The maximum number of ticks on the axis of a legend, default is 6.

Returns:
Type Description
geo.gui.colorLegendWidget

Extends

Type Definitions

geo.gui.colorLegendWidget.categoryobject

Properties:
Name Type Argument Description
name string

The text label of the legend.

type string

The type of the legend, either discrete or continuous.

scale string

The scale of the legend. For discrete type, linear, log, sqrt, pow, ordinal, and quantile is supported. For continuous type, linear, log, sqrt, and pow is supported.

domain Array.<number> | Array.<string>

Only for ordinal scale legend, string values are acceptable. For ordinal legend, the number in the domain array should be the same number of colors. For quantile scale legend, the domain should be an array of all values. For other scales, the domain needs to be an array of two number for marking the upper bound and lower bound. This domain property will be used with d3 scale object internally.

colors Array.<geo.geoColor>

The colors of the legend. All valid svg color can be used. For discrete type, multiple values are accepted. For continuous type, an array of two values is supported.

base number <optional>

The base of log when log scale is used. default to 10.

exponent number <optional>

The exponent of power when power scale is used. default to 1.

endAxisLabelOnly boolean <optional>

Only show left most and right most axis label default to null.

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).

Methods

addCategories(categories){this}

Add additional categories.

Name Type Description
categories Array.<geo.gui.colorLegendWidget.category>

Append additional legend categories to the end the of the current list of legends.

Returns:
Type Description
this The current class instance.

inherited addChild(child){this}

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}

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}

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.

Set or get categories.

Name Type Description
categories Array.<geo.gui.colorLegendWidget.category> optional

If undefined, return the current legend categories array. If an array is provided, remove current legends and recreate with the new categories.

Returns:
Type Description
Array.<geo.gui.colorLegendWidget.category> | this The current list of categories or the current class instance.

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}

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}

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}

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}

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 geoTrigger(event, args, childrenOnly){this}

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}

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.

Return the layer associated with this widget.

Returns:
Type Description
geo.layer

inherited modified(){this}

Update the timestamp to the next global timestamp value.

Returns:
Type Description
this

inherited onIdle(handler){this}

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

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}

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}

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.

removeCategories(categories){this}

Remove categories.

Name Type Description
categories Array.<geo.gui.colorLegendWidget.category>

If a category object exists in the current legend categories, that category will be removed.

Returns:
Type Description
this The current class instance.

inherited removeChild(child){this}

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 reposition(position){this}

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}

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}

Get time.

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