new geo.gui.svgWidget(arg){geo.gui.svgWidget}
Create a new instance of class geo.gui.svgWidget.
Due to the nature of d3 creating DOM elements as it inserts them, calls to appendChild don't appear in this widget.
The canvas of an svgWidget always refers to the actual svg element.
The parentCanvas can refer to another widget's svg element, dom element, or
the UI layer's dom element.
See geo.gui.widget#parentCanvas.
| Name | Type | Description |
|---|---|---|
arg |
geo.gui.widget.spec |
Options for the widget. |
Returns:
| Type | Description |
|---|---|
| geo.gui.svgWidget |
Extends
Members
-
inherited idle
-
Getter for the idle state. Read only.
Properties:
Name Type Description idleboolean trueif the object is idle (onIdlewould call a handler immediately).
Methods
-
inherited addChild(child){this}
-
Add a child (or an array of children) to the object.
Name Type Description childgeo.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 promisePromise A promise object.
Returns:
Type Description this -
inherited canvas(val){HTMLElement|this}
-
Get/Set the canvas for the widget.
Name Type Description valHTMLElement 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>}
-
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 argobject Options to pass to the child draw functions.
Returns:
Type Description this -
Report if an event handler is bound to this object.
Name Type Description eventstring | Array.<string> An event or list of events to check.
handlerfunction optional A function that might be bound. If
undefined, this will reporttrueif 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. -
Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.
Name Type Description eventstring | Array.<string> optional An event or a list of events from
geo.eventor defined by the user, orundefinedto remove all events (in which caseargis ignored).argfunction | 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 -
Bind an event handler to this object.
Name Type Description eventstring An event from
geo.eventor a user-defined value.handlerfunction A function that is called when
eventis triggered. The function is passed ageo.eventobject.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 eventstring The event to trigger.
argsobject Arbitrary argument to pass to the handler.
childrenOnlyboolean 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 -
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 handlerfunction A function taking no arguments.
Returns:
Type Description this -
inherited parent(arg){this|geo.sceneObject}
-
Get/set parent of the object.
Name Type Description arggeo.sceneObject optional The new parant or
undefinedto 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 posgeo.gui.widget.position optional If unspecified, return the current position. Otherwise, set the current position.
actualValueboolean 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 actualValueis falsy, positions that specify an explicitxandyparameter 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 childgeo.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 positiongeo.gui.widget.position optional The new position for the widget.
undefineduses 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.