Class: legendWidget

geo.gui. legendWidget

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

Create a new instance of class geo.gui.legendWidget.

Name Type Description
arg geo.gui.widget.spec

Options for the widget.

Returns:
Type Description
geo.gui.legendWidget

Extends

Type Definitions

geo.gui.legendWidget.categorySpecobject

Properties:
Name Type Description
name string

The name of the category.

type string

The type of the category. point shows as a circle, line as a line segment, all others as a rounded rectangle.

style geo.gui.legendWidget.styleSpec

The style for the category.

geo.gui.legendWidget.styleSpecgeo.feature.styleSpec

Style specification for a legend category.

Properties:
Name Type Argument Default Description
stroke boolean | function <optional>
true

True to stroke legend.

strokeColor geo.geoColor | function <optional>

Color to stroke each legend.

strokeOpacity number | function <optional>
1

Opacity for each legend's stroke. Opacity is on a [0-1] scale.

strokeWidth number | function <optional>
1.5

The weight of the legend's stroke in pixels.

fill boolean | function <optional>
true

True to fill legend.

fillColor geo.geoColor | function <optional>

Color to fill each legend.

fillOpacity number | function <optional>
1

Opacity for each legend. Opacity is on a [0-1] scale.

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

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}

Override object.addPromise to 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.

Get or set the category array associated with the legend.

Name Type Description
arg Array.<geo.gui.legendWidget.categorySpec> optional

The categories to display.

Returns:
Type Description
Array.<geo.gui.legendWidget.categorySpec> | this The current categories or the widget instance.

Get an array of the child objects.

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

Redraw the legend.

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}

Override object.onIdle to propagate up the scene tree.

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.

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

Return the size of the widget.

Returns:
Type Description
geo.screenSize

inherited timestamp(){number}

Get time.

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