[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map) / [Map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map) / Map # Class: Map [map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map).[Map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map).Map Map Widget defines a single map which is a collection of the different map layers ( WFS, WMTS, Shape, GeoJson layer..) Its supports different map providers that are tile and feature based.
addLayer(), insertLayer() and removeLayer() functions are used to add or remove MapJS layers ( [AbstractLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) ).
Widget supports changing the Z-order of layers as shown in Advanced Map Tutorial.
getModelLimits/setModelLimits handle the bounds for the layer and other properties can be set using setOptions().
Some navigation/utility functions like PanTo allows moving view position of the map to the specified map coordinate or focuses the map on a point.
In version 2.6 map has no API for dynamic rotation.
Widget includes some default tools like:

Pan Tool
Zoom
RubberBand Tool
Selection
Pinch Zoom
Zoom with Scroll Wheel

**`Example`** ```ts // 1). Initialize Maps. As with other widgets, you need to add map to a canvas and attach the tools. import {Map} from '@int/geotoolkit/map/Map'; import {Tile} from '@int/geotoolkit/map/layers/Tile'; const map = new Map(); const wmts = new Tile({..}); map.addLayer(wmts); ``` **`Example`** ```ts // 2). This example shows how to change the Spatial Reference for the map while using the @int/geotoolkit/map/Map with @int/geotoolkit/map/layers/Tile. // Only lat/lon, wgs84 and UTM coordinate systems are available, so map data must be transformed to one of them. import {LatLon} from '@int/geotoolkit/map/coordinatesystems/LatLon'; const map = new Map({ ... 'system': new LatLon() // lat/long coordinate system }); ``` ## Hierarchy - [`AnnotatedWidget`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget) ↳ **`Map`** ## Table of contents Constructors - [new Map(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.map.map.md#new map(options)) Methods | [addAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addaxis) | [addBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addbaselayer) | [addChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addchild) | | --- | --- | --- | | [addCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addcssclass) | [addInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addinvalidatehandler) | [addLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addlayer) | | [addLegend](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addlegend) | [addLegendInternal](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addlegendinternal) | [addOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addoverlay) | | [addTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#addtitle) | [adjustPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#adjustposition) | [applyOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#applyopacity) | | [applyResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#applyresponsivestyle) | [beginExport](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#beginexport) | [changeBaseLayerOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#changebaselayerorder) | | [changeChildOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#changechildorder) | [changeOverlayOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#changeoverlayorder) | [checkCollision](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#checkcollision) | | [clearBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#clearbaselayers) | [clearCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#clearcache) | [clearChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#clearchildren) | | [clearOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#clearoverlays) | [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#clone) | [connect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#connect) | | [connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#connectstyle) | [connectTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#connecttool) | [copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#copyconstructor) | | [disconnect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#disconnect) | [disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#disconnectstyle) | [disconnectTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#disconnecttool) | | [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#dispose) | [drawBorder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#drawborder) | [enableClipping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#enableclipping) | | [enableEventPropagation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#enableeventpropagation) | [enablePickingChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#enablepickingchildren) | [endExport](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#endexport) | | [enumerateNodes](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#enumeratenodes) | [execute](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#execute) | [exportToPdf](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#exporttopdf) | | [filter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#filter) | [fitToBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#fittobounds) | [flyTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#flyto) | | [getAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getanimationstyle) | [getAnnotation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getannotation) | [getAnnotationSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getannotationsize) | | [getAutoModelLimitsMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getautomodellimitsmode) | [getAutoModelLimitsStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getautomodellimitsstrategy) | [getBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getbaselayer) | | [getBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getbaselayers) | [getBaseLayersCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getbaselayerscount) | [getBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getbounds) | | [getCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcache) | [getCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcentermodellimits) | [getChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getchild) | | [getChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getchildren) | [getChildrenCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getchildrencount) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getclassname) | | [getClipStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getclipstyle) | [getContentOrientation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcontentorientation) | [getContentsArea](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcontentsarea) | | [getContentsTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcontentstransform) | [getCoordinateSystem](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcoordinatesystem) | [getCss](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcss) | | [getCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcssclass) | [getCssClasses](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcssclasses) | [getCssTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getcsstransform) | | [getData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getdata) | [getDesiredHeight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getdesiredheight) | [getDesiredWidth](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getdesiredwidth) | | [getDeviceLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getdevicelimits) | [getExportElement](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getexportelement) | [getExportLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getexportlimits) | | [getExportScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getexportscale) | [getExportState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getexportstate) | [getFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getfillstyle) | | [getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getid) | [getInfiniteMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getinfinitemode) | [getInvalidateMethod](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getinvalidatemethod) | | [getLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlayer) | [getLayerCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlayercount) | [getLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlayout) | | [getLayoutStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlayoutstyle) | [getLegendLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlegendlayer) | [getLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlinestyle) | | [getLocalTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getlocaltransform) | [getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmanipulatorlayer) | [getMapCenter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmapcenter) | | [getMapImage](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmapimage) | [getMapScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmapscale) | [getMapScaleObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmapscaleobject) | | [getMarginsStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmarginsstyle) | [getModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmodel) | [getModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getmodellimits) | | [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getname) | [getOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getopacity) | [getOpacityBlendMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getopacityblendmode) | | [getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoptions) | [getOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoverlay) | [getOverlayAt](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoverlayat) | | [getOverlayLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoverlaylayer) | [getOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoverlays) | [getOverlaysCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getoverlayscount) | | [getPaddingStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getpaddingstyle) | [getParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getparent) | [getPreferredSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getpreferredsize) | | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getproperties) | [getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getproperty) | [getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getpropertykeys) | | [getRenderingFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getrenderingfilter) | [getResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getresponsivestyle) | [getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getroot) | | [getScaleScrollStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getscalescrollstrategy) | [getScaleUnit](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getscaleunit) | [getSceneTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getscenetransform) | | [getTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#gettag) | [getTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#gettool) | [getToolByName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#gettoolbyname) | | [getToolByType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#gettoolbytype) | [getToolsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#gettoolsoptions) | [getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getvisible) | | [getVisibleCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getvisiblecentermodellimits) | [getVisibleDeviceLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getvisibledevicelimits) | [getVisibleModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getvisiblemodellimits) | | [getWorldTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getworldtransform) | [getZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getzindex) | [getZoomLevel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getzoomlevel) | | [hasCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#hascssclass) | [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#haseventlistener) | [indexOfBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#indexofbaselayer) | | [indexOfChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#indexofchild) | [indexOfOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#indexofoverlay) | [initializeFloatingAnnotationTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#initializefloatingannotationtool) | | [initializeLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#initializelayout) | [initializeTools](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#initializetools) | [insertAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#insertaxis) | | [insertBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#insertbaselayer) | [insertChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#insertchild) | [insertLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#insertlayer) | | [insertOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#insertoverlay) | [invalidate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#invalidate) | [invalidateLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#invalidatelayout) | | [invalidateParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#invalidateparent) | [isClippingEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isclippingenabled) | [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isdisposed) | | [isEventPropagationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#iseventpropagationenabled) | [isHorizontalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#ishorizontalflip) | [isLayoutInvalidated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#islayoutinvalidated) | | [isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isnotificationenabled) | [isPickingChildrenEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#ispickingchildrenenabled) | [isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isselectable) | | [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#issilent) | [isVerticalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isverticalflip) | [listToolsNames](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#listtoolsnames) | | [load](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#load) | [loadTemplate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#loadtemplate) | [moveTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#moveto) | | [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#notify) | [notifyRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#notifyroot) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#off) | | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#on) | [onBoundsChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#onboundschanged) | [onChildAdded](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#onchildadded) | | [onChildRemoved](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#onchildremoved) | [onParentChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#onparentchanged) | [onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#onvisibilitychanged) | | [pan](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#pan) | [panModelTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#panmodelto) | [panTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#panto) | | [panningHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#panninghandle) | [postRendering](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#postrendering) | [preRendering](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#prerendering) | | [rebuild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#rebuild) | [refreshLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#refreshlayout) | [registerAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#registeranimationstyle) | | [removeAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removeaxis) | [removeBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removebaselayer) | [removeChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removechild) | | [removeCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removecssclass) | [removeInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removeinvalidatehandler) | [removeLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removelayer) | | [removeLegend](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removelegend) | [removeOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removeoverlay) | [removeTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#removetitle) | | [render](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#render) | [renderAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderasync) | [renderBackground](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderbackground) | | [renderBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderbaselayers) | [renderBaseLayersAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderbaselayersasync) | [renderChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderchildren) | | [renderChildrenAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderchildrenasync) | [renderContent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#rendercontent) | [renderContentAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#rendercontentasync) | | [renderOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderoverlays) | [renderOverlaysAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#renderoverlaysasync) | [restoreToolState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#restoretoolstate) | | [resumeUpdate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#resumeupdate) | [rotate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#rotate) | [saveTemplate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#savetemplate) | | [saveToolsState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#savetoolsstate) | [scale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#scale) | [scaleModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#scalemodel) | | [setAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setanimationstyle) | [setAnnotationSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setannotationsize) | [setAnnotationsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setannotationsoptions) | | [setAutoModelLimitsMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setautomodellimitsmode) | [setAutoModelLimitsStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setautomodellimitsstrategy) | [setBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setbounds) | | [setCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcache) | [setCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcentermodellimits) | [setChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setchild) | | [setClipStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setclipstyle) | [setContentOrientation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcontentorientation) | [setCss](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcss) | | [setCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcssclass) | [setCssTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setcsstransform) | [setDesiredHeight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setdesiredheight) | | [setDesiredWidth](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setdesiredwidth) | [setExportLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setexportlimits) | [setExportScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setexportscale) | | [setFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setfillstyle) | [setHorizontalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#sethorizontalflip) | [setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setid) | | [setInfiniteMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setinfinitemode) | [setLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setlayout) | [setLayoutInvalidated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setlayoutinvalidated) | | [setLayoutStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setlayoutstyle) | [setLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setlinestyle) | [setLocalTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setlocaltransform) | | [setMapScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setmapscale) | [setMapScaleObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setmapscaleobject) | [setMarginsStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setmarginsstyle) | | [setModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setmodellimits) | [setModelTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setmodeltransformation) | [setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setname) | | [setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setnotification) | [setOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setopacity) | [setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setoptions) | | [setPaddingStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setpaddingstyle) | [setParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setparent) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setproperties) | | [setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setproperty) | [setRenderingFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setrenderingfilter) | [setResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setresponsivestyle) | | [setScaleScrollStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setscalescrollstrategy) | [setScaleUnit](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setscaleunit) | [setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setselectable) | | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setsilent) | [setTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#settag) | [setTitleOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#settitleoptions) | | [setTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#settool) | [setToolsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#settoolsoptions) | [setVerticalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setverticalflip) | | [setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setvisible) | [setVisibleCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setvisiblecentermodellimits) | [setVisibleModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setvisiblemodellimits) | | [setZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setzindex) | [setZoomLevel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#setzoomlevel) | [shear](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#shear) | | [suspendUpdate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#suspendupdate) | [synchronizeViewLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#synchronizeviewlimits) | [toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#tostring) | | [transformFromMap](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#transformfrommap) | [transformPoint](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#transformpoint) | [transformToMap](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#transformtomap) | | [translate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#translate) | [translateModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#translatemodel) | [unregisterAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#unregisteranimationstyle) | | [updateLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#updatelayout) | [updateSceneTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#updatescenetransformation) | [updateState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#updatestate) | | [updateSuspended](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#updatesuspended) | [updateTimeStamp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#updatetimestamp) | [zoom](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#zoom) | | [zoomHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#zoomhandle) | [zoomIn](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#zoomin) | [zoomOut](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#zoomout) | | [zoomToRect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#zoomtorect) | [enableSceneGraphNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#enablescenegraphnotification) | [findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#findparent) | | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#getclassname-1) | [isSceneGraphNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map#isscenegraphnotificationenabled) | ## Contents Constructors #### new Map(options) • **new Map**(`options?`) Creates map widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#options) | Data passed in | #### Overrides AnnotatedWidget.constructor Methods #### addAxis ▸ **addAxis**(`axis`, `location`, `connectedObject?`): `Object` add new axis and connect with object #### Parameters | Name | Type | Description | | --- | --- | --- | | `axis` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | [`AxisOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#annotatednode#axisoptions) | new axis instance or options | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | location of annotation for adding new axis | | `Optional` `connectedObject` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | connected object of axis | #### Returns `Object` | Name | Type | | --- | --- | | `axis` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | | `group` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addaxis) #### addBaseLayer ▸ **addBaseLayer**(`baseLayer`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Add baseLayer to container #### Parameters | Name | Type | Description | | --- | --- | --- | | `baseLayer` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | baseLayer to be added | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addbaselayer) #### addChild ▸ **addChild**(`node`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Add a child node #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | the child node to be added | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addchild) #### addCssClass ▸ **addCssClass**(`cssclass`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Adds new css class to node #### Parameters | Name | Type | Description | | --- | --- | --- | | `cssclass` | `string` | `string`[] | css class name('s) | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addcssclass) #### addInvalidateHandler ▸ **addInvalidateHandler**(`handler`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Add invalidate handler **`Deprecated`** since 4.0, use Node.on instead #### Parameters | Name | Type | Description | | --- | --- | --- | | `handler` | `Function` | handler to be notified about invalidation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addinvalidatehandler) #### addLayer ▸ **addLayer**(`layer`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Method to add a map layer. Layers can be added on top of existing layers. **`Fires`** [Events.onLayerAdded](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#events#onlayeradded) #### Parameters | Name | Type | Description | | --- | --- | --- | | `layer` | [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) | [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer)[] | layer to add | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### addLegend ▸ **addLegend**(`options`): [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) Creates legend, scrollable panel and interactive tools for the options provided. If legend already exists, does nothing. **`Example`** ```ts widget.addLegend({ // use known types to create legend items automatically (from charts) // use custom string item for user setup 'alignment': AnchorType.LeftTop, 'offset': new Point(60, 40) }); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `options` | [`LegendOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1.legends.legendoptions#legendoptions) | [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) | legend options | #### Returns [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addLegend](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addlegend) #### addLegendInternal ▸ `Protected` **addLegendInternal**(`options`): [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) #### Parameters | Name | Type | | --- | --- | | `options` | [`LegendOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1.legends.legendoptions#legendoptions) | [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) | #### Returns [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addLegendInternal](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addlegendinternal) #### addOverlay ▸ **addOverlay**(`overlay`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Add overlay to container #### Parameters | Name | Type | Description | | --- | --- | --- | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | overlay to be added | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addoverlay) #### addTitle ▸ **addTitle**(`location`, `options`): `void` Add title to annotation #### Parameters | Name | Type | Description | | --- | --- | --- | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | of the title | | `options` | [`TitleOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#titleoptions) | title options | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[addTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#addtitle) #### adjustPosition ▸ **adjustPosition**(`area?`, `vAlign?`, `hAlign?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Adjust position of node to specified area #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `area` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | specified area. Default to Parent Model Limits | | `Optional` `vAlign` | `string` | vertical alignment. It can be "top", "bottom", "center". Defaults to "top". | | `Optional` `hAlign` | `string` | horizontal alignment It can be "left", "right", "center". Defaults to "left". | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[adjustPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#adjustposition) #### applyOpacity ▸ `Protected` **applyOpacity**(`context`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[applyOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#applyopacity) #### applyResponsiveStyle ▸ `Protected` **applyResponsiveStyle**(): `void` Apply a responsive style rules it is exists #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[applyResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#applyresponsivestyle) #### beginExport ▸ **beginExport**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Prepares object before exporting and saving state #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[beginExport](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#beginexport) #### changeBaseLayerOrder ▸ **changeBaseLayerOrder**(`overlay`, `order`, `anchor?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Changes the z-order of the baseLayer. #### Parameters | Name | Type | Description | | --- | --- | --- | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | - | | `order` | [`NodeOrder`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#nodeorder) | position to be added | | `Optional` `anchor` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | anchor node to specify changeOrder with respect to this node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[changeBaseLayerOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#changebaselayerorder) #### changeChildOrder ▸ **changeChildOrder**(`node`, `order`, `anchor?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) changes the z-order of the nodes being rendered. #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | any child added in the Composite node | | `order` | [`NodeOrder`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#nodeorder) | position to be added | | `Optional` `anchor` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | anchor node to specify changeOrder with respect to this node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[changeChildOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#changechildorder) #### changeOverlayOrder ▸ **changeOverlayOrder**(`overlay`, `order`, `anchor?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Changes the z-order of the overlay. #### Parameters | Name | Type | Description | | --- | --- | --- | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | child overlay | | `order` | [`NodeOrder`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#nodeorder) | position to be added | | `Optional` `anchor` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | anchor node to specify changeOrder with respect to this node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[changeOverlayOrder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#changeoverlayorder) #### checkCollision ▸ **checkCollision**(`context`): `boolean` Check culling Returns true if object is inside of renderable area #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | #### Returns `boolean` true if node is collided #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[checkCollision](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#checkcollision) #### clearBaseLayers ▸ **clearBaseLayers**(`disposeBaseLayers?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove all child baseLayers from group #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `disposeBaseLayers` | `boolean` | automatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[clearBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#clearbaselayers) #### clearCache ▸ **clearCache**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Clear cache #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[clearCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#clearcache) #### clearChildren ▸ **clearChildren**(`disposeChildren?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove all child nodes from this composite group #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `disposeChildren` | `boolean` | automatically dispose children. If it is true then method dispose is called for each child. | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[clearChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#clearchildren) #### clearOverlays ▸ **clearOverlays**(`disposeOverlays?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove all child overlays from group #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `disposeOverlays` | `boolean` | automatically dispose overlays. If it is true then method dispose is called for each overlay, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[clearOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#clearoverlays) #### clone ▸ **clone**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> All subclasses should override copyConstructor or provide custom implementation for this method #### Returns [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> clone #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#clone) #### connect ▸ **connect**(`object`, `model`, `orientation?`, `autoSize?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Synchronizes object with a model #### Parameters | Name | Type | Description | | --- | --- | --- | | `object` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | object to be synchronized | | `model` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | source model | | `Optional` `orientation` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | horizontal or vertical | | `Optional` `autoSize` | `boolean` | true if object and model share the same device size in the orientation, true by default if not specified | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[connect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#connect) #### connectStyle ▸ **connectStyle**(`style`, `type`, `callback`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Connects style.

This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks #### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style | | `type` | `string` | type of event or property | | `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)> | function to be called | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#connectstyle) #### connectTool ▸ **connectTool**(`tool`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Connect a new tool with a toolname to the widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `tool` | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool)[] | tool associated with the widget | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[connectTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#connecttool) #### copyConstructor ▸ `Protected` **copyConstructor**(`src`, `deepCopy?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
#### Parameters | Name | Type | Description | | --- | --- | --- | | `src` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | Source to copy from | | `Optional` `deepCopy` | `boolean` | deep copy | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#copyconstructor) #### disconnect ▸ **disconnect**(`object`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Disconnect an object from its source model #### Parameters | Name | Type | Description | | --- | --- | --- | | `object` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | object to disconnect | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[disconnect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#disconnect) #### disconnectStyle ▸ **disconnectStyle**(`style`, `type`, `callback`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
#### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style | | `type` | `string` | type of event or property | | `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)> | function to be called | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#disconnectstyle) #### disconnectTool ▸ **disconnectTool**(`tool`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Disconnect the tool from the widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `tool` | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool)[] | tool to disconnect | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[disconnectTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#disconnecttool) #### dispose ▸ **dispose**(): `void` Dispose node. Clear all listeners and disconnect style to avoid memory leaks #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#dispose) #### drawBorder ▸ `Protected` **drawBorder**(`localContext`, `bounds?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Draws a rectangle at the bounding box (in parent coordinates) #### Parameters | Name | Type | Description | | --- | --- | --- | | `localContext` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | The local rendering context | | `Optional` `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | group bounds | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[drawBorder](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#drawborder) #### enableClipping ▸ **enableClipping**(`doClip`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds. #### Parameters | Name | Type | Description | | --- | --- | --- | | `doClip` | `boolean` | enable clipping on this node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[enableClipping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#enableclipping) #### enableEventPropagation ▸ **enableEventPropagation**(`enable`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Enable event propagation from the node hierarchy from bottom to top

This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance.

**`Example`** ```ts import {Group} from '@int/geotoolkit/scene/Group'; import {Events as SceneEvents} from '@int/geotoolkit/scene/Node'; const parentGroup = new Group() .setName('ParentGroup') .enableEventPropagation(true); const childGroup = new Group() .setName('ChildGroup'); parentGroup.addChild(childGroup); parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => { // Got notifications from all children of parent group }); childGroup.invalidate(); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `enable` | `boolean` | enable | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[enableEventPropagation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#enableeventpropagation) #### enablePickingChildren ▸ **enablePickingChildren**(`enable`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Enables or disables picking children #### Parameters | Name | Type | Description | | --- | --- | --- | | `enable` | `boolean` | enable picking children | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[enablePickingChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#enablepickingchildren) #### endExport ▸ **endExport**(): `void` Restores object's state after exporting #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[endExport](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#endexport) #### enumerateNodes ▸ **enumerateNodes**(`callback`, `target?`): `void` Executes a provided function once for each child node #### Parameters | Name | Type | Description | | --- | --- | --- | | `callback` | [`Callback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#inodeenumerable#callback)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | provided function | | `Optional` `target` | [`QueryBuilder`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.selection.querybuilder.querybuilder)<`any`> | target to pass to callback as a second parameter | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[enumerateNodes](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#enumeratenodes) #### execute ▸ **execute**(`delegate`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Executes delegate and return the result. It allows us to keep all initialization calls in one place,
and we do not need to scroll up or down in IDE to find how and where it was initialized. **`Example`** ```ts // All setters (.setName() for example) returns reference to the this. // In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference. // Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2. import {Group} from '@int/geotoolkit/scene/Group'; import {Rect} from '@int/geotoolkit/util/Rect'; // Option 1 const group = new Group() .setName('MyGroup') .setBounds(new Rect(0, 0, 42, 16)) .enableClipping(true) .setTag({'type': 'sometype'}); group.getLineStyle().setPattern('pattern'); return group; // Options 2 ( using execute method ) return group .execute(function () { this.getLineStyle() .setPattern("pattern"); }); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `delegate` | (`this`: [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map)) => `void` | Function to execute | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) The result if any or this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[execute](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#execute) ▸ **execute**<`T`>(`delegate`): `T` #### Type parameters | Name | | --- | | `T` | #### Parameters | Name | Type | | --- | --- | | `delegate` | (`this`: [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map)) => `T` | #### Returns `T` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[execute](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#execute) #### exportToPdf ▸ **exportToPdf**(`options?`): `Promise`<[`IWritable`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.stream.iwritable.iwritable)> Export a part of the container to PDF

This method sets automatically export scale and limits based on input parameters and current model scale and limits

#### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`ExportToPdfOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#exporttopdfoptions) | option to specify paper parameters and header and footer | #### Returns `Promise`<[`IWritable`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.stream.iwritable.iwritable)> promise with output stream #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[exportToPdf](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#exporttopdf) #### filter ▸ `Protected` **filter**(`context`): `boolean` Filter node #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | #### Returns `boolean` flag filter flag ("true" to render node; "false" otherwise) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[filter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#filter) #### fitToBounds ▸ **fitToBounds**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) fit bounds to model limits **`Fires`** [Events.ModelVisibleLimitsChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#events#modelvisiblelimitschanged) #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[fitToBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#fittobounds) #### flyTo ▸ **flyTo**(`options`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Animates map viewport to a given point on the map, simulating the effect of flight. For this, animation effects with attributeName(s) 'scale' and 'location' are used. Set your own effects to customize the animation. #### Parameters | Name | Type | Description | | --- | --- | --- | | `options` | [`FlyToOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#flytooptions) | animation fly options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### getAnimationStyle ▸ **getAnimationStyle**(): [`AnimationStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.animationstyle.animationstyle) Return animation style #### Returns [`AnimationStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.animationstyle.animationstyle) animationStyle current animation style #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getanimationstyle) #### getAnnotation ▸ **getAnnotation**(`location`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> return the node at the specific annotation #### Parameters | Name | Type | Description | | --- | --- | --- | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | position to return the node for | #### Returns [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAnnotation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getannotation) #### getAnnotationSize ▸ **getAnnotationSize**(): `Required`<[`AnnotationSize`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#annotationsize)> Return sizes of all annotations or the exact one #### Returns `Required`<[`AnnotationSize`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#annotationsize)> contains size of all annotations #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAnnotationSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getannotationsize) ▸ **getAnnotationSize**(`loc`): `string` | `number` #### Parameters | Name | Type | | --- | --- | | `loc` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | #### Returns `string` | `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAnnotationSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getannotationsize) #### getAutoModelLimitsMode ▸ **getAutoModelLimitsMode**(): `boolean` Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds #### Returns `boolean` mode #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAutoModelLimitsMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getautomodellimitsmode) #### getAutoModelLimitsStrategy ▸ **getAutoModelLimitsStrategy**(): [`ModelLimitsStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.modellimitsstrategy.modellimitsstrategy) Get Model Limits Logics Strategy #### Returns [`ModelLimitsStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.modellimitsstrategy.modellimitsstrategy) strategy #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getAutoModelLimitsStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getautomodellimitsstrategy) #### getBaseLayer ▸ **getBaseLayer**(`index`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Return baseLayer at specified index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | index at which to get the baseLayer for | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) track #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getbaselayer) #### getBaseLayers ▸ **getBaseLayers**<`S`>(`predicate`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Return iterator by baseLayers nodes #### Type parameters | Name | Type | | --- | --- | | `S` | extends [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)<`S`> | #### Parameters | Name | Type | Description | | --- | --- | --- | | `predicate` | (`value`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => value is S | a filter function | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getbaselayers) ▸ **getBaseLayers**(`filter?`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass `true` as the last parameter. **`Example`** ```ts // Gets a writable iterator const it = node.getOverlays(null, true); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | A filter function. Returns all overlays if `null`. | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> An iterator for child overlays. #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getbaselayers) #### getBaseLayersCount ▸ **getBaseLayersCount**(): `number` Returns amount of baseLayers #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getBaseLayersCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getbaselayerscount) #### getBounds ▸ **getBounds**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Get the bounds in the parents model space. If bounds are not set, then parent model limits are used. #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) current bounds #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getbounds) #### getCache ▸ **getCache**(): [`Cache`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.cache.cache) Return cache strategy to be used to cache children nodes #### Returns [`Cache`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.cache.cache) cache #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcache) #### getCenterModelLimits ▸ **getCenterModelLimits**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Gets model limits, the limits of this groups inside space #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) the current model limits #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcentermodellimits) #### getChild ▸ **getChild**(`i`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Return node by index #### Parameters | Name | Type | Description | | --- | --- | --- | | `i` | `number` | index of the node | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getchild) #### getChildren ▸ **getChildren**<`S`>(`predicate`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<`S`> Return iterator by child nodes #### Type parameters | Name | Type | | --- | --- | | `S` | extends [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)<`S`> | #### Parameters | Name | Type | Description | | --- | --- | --- | | `predicate` | (`value`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => value is S | a filter function | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<`S`> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getchildren) ▸ **getChildren**(`filter?`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass `true` as the last parameter. **`Example`** ```ts // Gets a writable iterator const it = node.getChildren(null, true); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | A filter function. Returns all nodes if `null`. | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> An iterator for child nodes. #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getchildren) #### getChildrenCount ▸ **getChildrenCount**(): `number` Return number of child nodes #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getChildrenCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getchildrencount) #### getClassName ▸ **getClassName**(): `string` #### Returns `string` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getclassname) #### getClipStyle ▸ **getClipStyle**(): [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle) Gets the current clipping style #### Returns [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle) clipping style #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getClipStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getclipstyle) #### getContentOrientation ▸ **getContentOrientation**(): [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) Return content orientation #### Returns [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) content orientation #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getContentOrientation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcontentorientation) #### getContentsArea ▸ **getContentsArea**(`transformation?`): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return area without paddings. Model limits are mapped to content area, where children are layout. #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `transformation` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) | scene transformation | #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getContentsArea](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcontentsarea) #### getContentsTransform ▸ **getContentsTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) getContentsTransform() retrieves the world transformation of the node. #### Returns [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) transformation from model coordinates to bounds of the group #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getContentsTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcontentstransform) #### getCoordinateSystem ▸ **getCoordinateSystem**(): [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) Gets the working system of the map #### Returns [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) #### getCss ▸ **getCss**(): [`CssStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.css-1.cssstyle.cssstyle) Return CSS style #### Returns [`CssStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.css-1.cssstyle.cssstyle) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCss](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcss) #### getCssClass ▸ **getCssClass**(): `string` Returns css class name to be used to apply CSS style #### Returns `string` the css class name #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcssclass) #### getCssClasses ▸ **getCssClasses**(): `string`[] Gets list of css class names which applied to this node #### Returns `string`[] #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCssClasses](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcssclasses) #### getCssTransform ▸ **getCssTransform**(): `string` Returns CSS transformation #### Returns `string` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getCssTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getcsstransform) #### getData ▸ **getData**(`data?`): `object` get options #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `data` | `unknown` | how to extract data, null by default | #### Returns `object` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getData](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getdata) #### getDesiredHeight ▸ **getDesiredHeight**(): `string` | `number` Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle() #### Returns `string` | `number` desired height ("undefined" by default) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getDesiredHeight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getdesiredheight) #### getDesiredWidth ▸ **getDesiredWidth**(): `string` | `number` Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle() #### Returns `string` | `number` desired width ("undefined" by default) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getDesiredWidth](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getdesiredwidth) #### getDeviceLimits ▸ **getDeviceLimits**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return device limits #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getDeviceLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getdevicelimits) #### getExportElement ▸ **getExportElement**(`options?`): [`CompositeDocumentElement`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.exports.compositedocumentelement.compositedocumentelement) Returns exportable element #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`ExportElementOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#exportelementoptions) | options | #### Returns [`CompositeDocumentElement`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.exports.compositedocumentelement.compositedocumentelement) return exportable element #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getExportElement](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getexportelement) #### getExportLimits ▸ **getExportLimits**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return export limits #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getExportLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getexportlimits) #### getExportScale ▸ **getExportScale**(): `Object` Gets export scale. By default scale is not set and equal to screen scale #### Returns `Object` scale | Name | Type | Description | | --- | --- | --- | | `x` | `number` | scale by x form model to device | | `y` | `number` | scale by y form model to device | #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getExportScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getexportscale) #### getExportState ▸ `Protected` **getExportState**(): `Record`<`string`, `any`> Returns export state #### Returns `Record`<`string`, `any`> export state #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getExportState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getexportstate) #### getFillStyle ▸ **getFillStyle**(): [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle) Return fill style #### Returns [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle) fillStyle current fill style #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getfillstyle) #### getId ▸ **getId**(): `string` | `number` Returns the associated identifier of the node #### Returns `string` | `number` The node's id #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getid) #### getInfiniteMode ▸ **getInfiniteMode**(): `boolean` Return infinity mode flag #### Returns `boolean` flag #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getInfiniteMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getinfinitemode) #### getInvalidateMethod ▸ `Protected` **getInvalidateMethod**(): [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)> Gets invalidate method #### Returns [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)> method to invalidate this object #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getInvalidateMethod](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getinvalidatemethod) #### getLayer ▸ **getLayer**(`i`): [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) Return layer by index #### Parameters | Name | Type | Description | | --- | --- | --- | | `i` | `number` | index of the node | #### Returns [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) #### getLayerCount ▸ **getLayerCount**(): `number` Return layer count #### Returns `number` #### getLayout ▸ **getLayout**(): [`Layout`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layout.layout) Returns layout associated with the group #### Returns [`Layout`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layout.layout) layout #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getlayout) #### getLayoutStyle ▸ **getLayoutStyle**(): [`LayoutStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layoutstyle.layoutstyle)<`string` | `number`> return desired layout style #### Returns [`LayoutStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layoutstyle.layoutstyle)<`string` | `number`> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getLayoutStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getlayoutstyle) #### getLegendLayer ▸ **getLegendLayer**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Returns layer to keep legend on top of widget #### Returns [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getLegendLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getlegendlayer) #### getLineStyle ▸ **getLineStyle**(): [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle) Return border style #### Returns [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getlinestyle) #### getLocalTransform ▸ **getLocalTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) Retrieves the transformation of bounds to parent #### Returns [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) transform the local transform. #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getLocalTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getlocaltransform) #### getManipulatorLayer ▸ **getManipulatorLayer**(): [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> return manipulator layer #### Returns [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getmanipulatorlayer) #### getMapCenter ▸ **getMapCenter**(): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) gets the center point on the map. #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### getMapImage ▸ **getMapImage**(): [`Image`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.shapes.image.image) Returns the map logo (if exists) #### Returns [`Image`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.shapes.image.image) #### getMapScale ▸ **getMapScale**(`onCurrentParallel?`): `number` gets the current map scale #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `onCurrentParallel` | `boolean` | true, if you need to use factor, else false | #### Returns `number` current map scale #### getMapScaleObject ▸ **getMapScaleObject**(): [`MapScale`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.util-3.mapscale.mapscale) Returns current map scale object (if exists) #### Returns [`MapScale`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.util-3.mapscale.mapscale) #### getMarginsStyle ▸ **getMarginsStyle**(): [`SpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.spacestyle.spacestyle)<`string` | `number`> Return margins style #### Returns [`SpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.spacestyle.spacestyle)<`string` | `number`> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getMarginsStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getmarginsstyle) #### getModel ▸ **getModel**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> get model node #### Returns [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getmodel) #### getModelLimits ▸ **getModelLimits**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Gets model limits, the limits of this groups inside space #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) the current model limits #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getmodellimits) #### getName ▸ **getName**(): `string` Returns the node name #### Returns `string` The node name #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getname) #### getOpacity ▸ **getOpacity**(): `number` Returns current node opacity #### Returns `number` opacity #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getopacity) #### getOpacityBlendMode ▸ **getOpacityBlendMode**(): [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode) Returns current node opacity #### Returns [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode) opacity blend mode #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOpacityBlendMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getopacityblendmode) #### getOptions ▸ **getOptions**(): `Object` Returns map options #### Returns `Object` | Name | Type | | --- | --- | | `mapimage` | [`Image`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.shapes.image.image) | | `maplimits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | | `mapscale` | `number` | | `mapscaleobject` | [`MapScale`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.util-3.mapscale.mapscale) | | `scaleunit` | [`AbstractUnit`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.abstractunit.abstractunit) | | `system` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | | `webmap` | `string` | [`ObjectType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map.util-3.webmap#webmap#objecttype) | #### getOverlay ▸ **getOverlay**(`index`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Return overlay at specified index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | index at which to get the overlay for | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) track #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlay) #### getOverlayAt ▸ **getOverlayAt**(`index`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Return overlay at specified index **`Deprecated`** since 4.2 use getOverlay instead #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | index at which to get the overlay for | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) track #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlayAt](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlayat) #### getOverlayLayer ▸ **getOverlayLayer**(): [`Layer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.layer.layer)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Returns manipulator overlay to draw shapes that should move with the model #### Returns [`Layer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.layer.layer)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlayLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlaylayer) #### getOverlays ▸ **getOverlays**<`S`>(`predicate`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Return iterator by overlays nodes #### Type parameters | Name | Type | | --- | --- | | `S` | extends [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)<`S`> | #### Parameters | Name | Type | Description | | --- | --- | --- | | `predicate` | (`value`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => value is S | a filter function | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlays) ▸ **getOverlays**(`filter?`, `modify?`): [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass `true` as the last parameter. **`Example`** ```ts // Gets a writable iterator const it = node.getOverlays(null, true); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | A filter function. Returns all overlays if `null`. | | `Optional` `modify` | `boolean` | An option to specify if the iterator supports adding/removing items from the collection. `false` by default. | #### Returns [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> An iterator for child overlays. #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlays) #### getOverlaysCount ▸ **getOverlaysCount**(): `number` Returns amount of overlays #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getOverlaysCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getoverlayscount) #### getPaddingStyle ▸ **getPaddingStyle**(): [`SpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.spacestyle.spacestyle)<`string` | `number`> Return padding style #### Returns [`SpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.spacestyle.spacestyle)<`string` | `number`> padding #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getPaddingStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getpaddingstyle) #### getParent ▸ **getParent**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Return parent node #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) parent node #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getparent) #### getPreferredSize ▸ **getPreferredSize**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return preferred size to layout children #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getPreferredSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getpreferredsize) #### getProperties ▸ **getProperties**(`context?`): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#optionsout) Gets all the properties pertaining to this object #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `context` | [`ISerializationContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.iserializationcontext.iserializationcontext) | serialization context | #### Returns [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#optionsout) properties object #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getproperties) #### getProperty ▸ **getProperty**(`name`): `any` Gets dynamic property by name. These properties can be used as a property bags #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | property name | #### Returns `any` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getproperty) #### getPropertyKeys ▸ **getPropertyKeys**(): `string`[] Returns known properties keys #### Returns `string`[] #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getpropertykeys) #### getRenderingFilter ▸ **getRenderingFilter**(): [`IFilter`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.ifilter.ifilter) Return filter to be used for rendering and picking #### Returns [`IFilter`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.ifilter.ifilter) current filter #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getRenderingFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getrenderingfilter) #### getResponsiveStyle ▸ **getResponsiveStyle**(): [`ResponsiveStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.responsive.responsivestyle.responsivestyle) Return responsive style #### Returns [`ResponsiveStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.responsive.responsivestyle.responsivestyle) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getresponsivestyle) #### getRoot ▸ **getRoot**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Returns root node.
If node doesn't have parent then it returns itself. #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) the root node #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getroot) #### getScaleScrollStrategy ▸ **getScaleScrollStrategy**(): [`Delegate`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#scalescrollstrategy#delegate) Gets ScaleScrollStrategy ("undefined" by default) #### Returns [`Delegate`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#scalescrollstrategy#delegate) ScaleScrollStrategy (see "setScaleScrollStrategy" description for more info) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getScaleScrollStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getscalescrollstrategy) #### getScaleUnit ▸ **getScaleUnit**(): [`AbstractUnit`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.abstractunit.abstractunit) Gets scale unit #### Returns [`AbstractUnit`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.abstractunit.abstractunit) unit of this map #### getSceneTransform ▸ **getSceneTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) Returns transformation from node to root scene #### Returns [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) a transformation from node to root scene #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getSceneTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getscenetransform) #### getTag ▸ **getTag**(): `any` Returns the object associated with the node by user. #### Returns `any` The node's user-object #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#gettag) #### getTool ▸ **getTool**(): [`CompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.compositetool.compositetool) Returns root tool associated to this widget #### Returns [`CompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.compositetool.compositetool) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#gettool) #### getToolByName ▸ **getToolByName**<`T`>(`toolName`): [`Tools`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#tools)[`T`] Returns the tool matching the given name.
This function also accepts tool 'path' instead of absolute name.
For example:
getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")
Would return the same tool as
getToolByName("TrackPanning")
As long as there is only one tool named "TrackPanning" in this composite
See listToolsNames()
#### Type parameters | Name | Type | | --- | --- | | `T` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `toolName` | `T` | The tool name or path | #### Returns [`Tools`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#tools)[`T`] #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getToolByName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#gettoolbyname) #### getToolByType ▸ **getToolByType**(`toolType`): [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) Returns the tool matching the given type. or null if nothing is matching the tool type
For example:
getToolByType(geotoolkit.controls.tools.Selection)
Would return the same tool as
getToolByName("pick")
#### Parameters | Name | Type | Description | | --- | --- | --- | | `toolType` | [`ClassType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.base#classtype)<`any`> | toolType of the tool | #### Returns [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getToolByType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#gettoolbytype) #### getToolsOptions ▸ **getToolsOptions**(): [`ToolsOptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#toolsoptionsout) Gets Tools Options #### Returns [`ToolsOptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#toolsoptionsout) JSON which defines tools options #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getToolsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#gettoolsoptions) #### getVisible ▸ **getVisible**(): `boolean` Return visibility of the node #### Returns `boolean` true if node is visible #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getvisible) #### getVisibleCenterModelLimits ▸ **getVisibleCenterModelLimits**(`ignoreModelLimits?`): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Returns visible model limits of the center model #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `ignoreModelLimits` | `boolean` | flag defines whether to ignore model limits or not. By default this option is false and visible limits will be intersected with center model limits | #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getVisibleCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getvisiblecentermodellimits) #### getVisibleDeviceLimits ▸ **getVisibleDeviceLimits**(`ignoreModelLimits?`): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return visible device limits #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `ignoreModelLimits` | `boolean` | flag defines whether to ignore ModelLimits or not | #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getVisibleDeviceLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getvisibledevicelimits) #### getVisibleModelLimits ▸ **getVisibleModelLimits**(`ignoreModelLimits?`): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) Return visible model limits #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `ignoreModelLimits` | `boolean` | flag defines whether to ignore ModelLimits or not | #### Returns [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getVisibleModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getvisiblemodellimits) #### getWorldTransform ▸ **getWorldTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations. #### Returns [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getWorldTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getworldtransform) #### getZIndex ▸ **getZIndex**(): `number` Returns node z-index (null if not set) #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getzindex) #### getZoomLevel ▸ **getZoomLevel**(): `number` Returns current zoom level (based on current scale). May be a fractional number #### Returns `number` #### hasCssClass ▸ **hasCssClass**(`cssClass`): `boolean` Check if node has specified css class #### Parameters | Name | Type | Description | | --- | --- | --- | | `cssClass` | `string` | css class name | #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[hasCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#hascssclass) #### hasEventListener ▸ **hasEventListener**(`type`, `callback?`): `boolean` Check if a list of event listeners for this type contains this listener #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `string` | type of event or property | | `Optional` `callback` | `Function` | to be called, if null, check if any callback is registered | #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#haseventlistener) #### indexOfBaseLayer ▸ **indexOfBaseLayer**(`baseLayer`): `number` Return index of overlay ( index of the specified child or -1 if baseLayer is not found) #### Parameters | Name | Type | Description | | --- | --- | --- | | `baseLayer` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | baseLayer to check index | #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[indexOfBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#indexofbaselayer) #### indexOfChild ▸ **indexOfChild**(`node`): `number` Return index of child ( index of the specified child or -1 if node is not found) #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to check index | #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[indexOfChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#indexofchild) #### indexOfOverlay ▸ **indexOfOverlay**(`overlay`): `number` Return index of overlay ( index of the specified child or -1 if overlay is not found) #### Parameters | Name | Type | Description | | --- | --- | --- | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | overlay to check index | #### Returns `number` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[indexOfOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#indexofoverlay) #### initializeFloatingAnnotationTool ▸ `Protected` **initializeFloatingAnnotationTool**(): [`FloatingAnnotationTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.tools-2.floatingannotationtool.floatingannotationtool) #### Returns [`FloatingAnnotationTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.tools-2.floatingannotationtool.floatingannotationtool) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[initializeFloatingAnnotationTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#initializefloatingannotationtool) #### initializeLayout ▸ **initializeLayout**(`settings`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Parameters | Name | Type | | --- | --- | | `settings` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#options) | #### Returns [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[initializeLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#initializelayout) #### initializeTools ▸ `Protected` **initializeTools**(`options?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) function call in the constructor to initialize tools in the widget
This widget contains by default :
- [CrossHair](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.crosshair.crosshair) tool
- [RubberBand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.rubberband.rubberband) tool
- [Panning](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.panning.panning) tool
- [HorizontalScroll](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.scroll.horizontalscroll.horizontalscroll)
- [VerticalScroll](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.scroll.verticalscroll.verticalscroll)
#### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#options) | tools options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[initializeTools](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#initializetools) #### insertAxis ▸ **insertAxis**(`axisIndex`, `axis`, `location`, `connectedObject?`): `Object` Insert new axis and connect with object #### Parameters | Name | Type | Description | | --- | --- | --- | | `axisIndex` | `number` | desired axis index | | `axis` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | [`AxisOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#annotatednode#axisoptions) | new axis instance or options | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | location of annotation for adding new axis | | `Optional` `connectedObject` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | connected object of axis | #### Returns `Object` | Name | Type | | --- | --- | | `axis` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | | `group` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[insertAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#insertaxis) #### insertBaseLayer ▸ **insertBaseLayer**(`index`, `baseLayer`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Insert child baseLayer at specified index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | specified index | | `baseLayer` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | a baseLayer to add | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[insertBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#insertbaselayer) #### insertChild ▸ **insertChild**(`index`, `node`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Insert child node at specified index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | specified index | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | a child node to add | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[insertChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#insertchild) #### insertLayer ▸ **insertLayer**(`layer`, `index`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Inserts a Layer, if the layer is already a child, this moves it. Layer can be inserted at a z depth or index as required.
For Example map.insertLayer(layer, index); **`Fires`** [Events.onLayersModified](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#events#onlayersmodified) **`Fires`** [Events.onLayerAdded](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#events#onlayeradded) #### Parameters | Name | Type | Description | | --- | --- | --- | | `layer` | [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) | Layer to insert | | `index` | `number` | where to insert layer | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### insertOverlay ▸ **insertOverlay**(`index`, `overlay`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Insert child overlay at specified index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | specified index | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | a overlay to add | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[insertOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#insertoverlay) #### invalidate ▸ **invalidate**(`bounds?`, `force?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Invalidate node #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | optional rectangular area to be invalidated, or force flag if rectangle is empty | | `Optional` `force` | `boolean` | optional boolean parameter that can force invalidation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[invalidate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#invalidate) #### invalidateLayout ▸ **invalidateLayout**(`propagate?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Notify that layout is invalidated. Send event [Events.LayoutInvalidated](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#events#events#layoutinvalidated) #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `propagate` | `boolean` | propagate invalidate layout to parent | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[invalidateLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#invalidatelayout) #### invalidateParent ▸ **invalidateParent**(`bounds?`, `force?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Invalidate parent area #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | area to invalidate | | `Optional` `force` | `boolean` | force | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[invalidateParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#invalidateparent) #### isClippingEnabled ▸ **isClippingEnabled**(): `boolean` Returns if clipping is enabled or not for this node. #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isClippingEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isclippingenabled) #### isDisposed ▸ **isDisposed**(): `boolean` Returns whether this object has been disposed #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isdisposed) #### isEventPropagationEnabled ▸ **isEventPropagationEnabled**(): `boolean` Return true if event propagation is enabled from child to parent #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isEventPropagationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#iseventpropagationenabled) #### isHorizontalFlip ▸ **isHorizontalFlip**(): `boolean` Return true if the representation is flipped horizontally #### Returns `boolean` flip #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isHorizontalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#ishorizontalflip) #### isLayoutInvalidated ▸ **isLayoutInvalidated**(): `boolean` Return true if layout is invalid #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isLayoutInvalidated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#islayoutinvalidated) #### isNotificationEnabled ▸ **isNotificationEnabled**(): `boolean` return state of notification #### Returns `boolean` current notification state #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isnotificationenabled) #### isPickingChildrenEnabled ▸ **isPickingChildrenEnabled**(): `boolean` Returns if picking children is enabled or not for this node. #### Returns `boolean` pickingChildren #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isPickingChildrenEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#ispickingchildrenenabled) #### isSelectable ▸ **isSelectable**(): `boolean` Returns true if node can be picked/selected. #### Returns `boolean` The selectable flag #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isselectable) #### isSilent ▸ **isSilent**(): `boolean` Return true if the event dispatcher doesn't notify any events #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#issilent) #### isVerticalFlip ▸ **isVerticalFlip**(): `boolean` Return true if the representation is flipped vertically #### Returns `boolean` flip #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isVerticalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isverticalflip) #### listToolsNames ▸ **listToolsNames**(): `string`[] List all the tools contained in this composite. Prepend their parent tools parent using a '.'. #### Returns `string`[] #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[listToolsNames](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#listtoolsnames) #### load ▸ **load**(): `Promise`<[`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map)> Returns promise that is resolved when all current map layers are loaded and map is ready to be rendered #### Returns `Promise`<[`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map)> #### loadTemplate ▸ **loadTemplate**(`template`, `registry?`): `void` Load template loads the saved visual properties of the current template. It is only a visual representation of the current widget. It does not contain any data #### Parameters | Name | Type | Description | | --- | --- | --- | | `template` | `string` | template to be applied to current widget | | `Optional` `registry` | [`Registry`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.registry.registry) | registry | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[loadTemplate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#loadtemplate) #### moveTo ▸ **moveTo**(`area`, `vAlign?`, `hAlign?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) MoveTo position of node to specified area #### Parameters | Name | Type | Description | | --- | --- | --- | | `area` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | specified area | | `Optional` `vAlign` | `string` | vertical alignment. It can be "top", "bottom", "center". | | `Optional` `hAlign` | `string` | horizontal alignment It can be "left", "right", "center". | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[moveTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#moveto) #### notify ▸ **notify**<`E`>(`type`, `source`, `args?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Notify listeners of the Node #### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `E` | type of event | | `source` | [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) | source who called the event | | `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#eventmap)[`E`] | event arguments | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#notify) #### notifyRoot ▸ `Protected` **notifyRoot**(`event`, `source`, `args?`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Notify an even to root node #### Parameters | Name | Type | Description | | --- | --- | --- | | `event` | `string` | type of event | | `source` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | source who called the event | | `Optional` `args` | `any` | event arguments | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[notifyRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#notifyroot) #### off ▸ **off**<`E`>(`type?`, `callback?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type. #### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `type` | `E` | type of the event | | `Optional` `callback` | (`eventType`: `E`, `sender`: [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#eventmap)[`E`]) => `void` | function to be called | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#off) #### on ▸ **on**<`E`>(`type`, `callback`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

#### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `E` | type of event or property | | `callback` | (`eventType`: `E`, `sender`: [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#eventmap)[`E`]) => `void` | to be called | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#on) #### onBoundsChanged ▸ `Protected` **onBoundsChanged**(`bounds`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Occurs when bounds has been changed #### Parameters | Name | Type | Description | | --- | --- | --- | | `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | bound of the node in the parent coordinates | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[onBoundsChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#onboundschanged) #### onChildAdded ▸ `Protected` **onChildAdded**(`child`): `void` This method is called it child or children are added #### Parameters | Name | Type | Description | | --- | --- | --- | | `child` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Iterator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.iterator.iterator)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | added child | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[onChildAdded](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#onchildadded) #### onChildRemoved ▸ `Protected` **onChildRemoved**(`child`): `void` This method is called it child or children are removed #### Parameters | Name | Type | Description | | --- | --- | --- | | `child` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | removed child | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[onChildRemoved](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#onchildremoved) #### onParentChanged ▸ `Protected` **onParentChanged**(`node`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) This method is called when parent changes. Do not call it directly. #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to change parent | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[onParentChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#onparentchanged) #### onVisibilityChanged ▸ `Protected` **onVisibilityChanged**(): `void` This method is called if visibility is changed. Send event [Events.VisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#events#visibilitychanged) #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#onvisibilitychanged) #### pan ▸ **pan**(`dx`, `dy`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) attempts to translate the model using the specific x, y translation **`Fires`** [Events.ModelVisibleLimitsChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#events#modelvisiblelimitschanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `dx` | `number` | relative horizontal change | | `dy` | `number` | relative vertical change | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[pan](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#pan) #### panModelTo ▸ **panModelTo**(`target`, `animationOptions?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Pans the content to the point. #### Parameters | Name | Type | Description | | --- | --- | --- | | `target` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | Point where to pan in model space | | `Optional` `animationOptions` | [`PanAnimationOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#pananimationoptions) | Animation options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[panModelTo](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#panmodelto) #### panTo ▸ **panTo**(`center`, `coordSystem?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Pans the map to the point. #### Parameters | Name | Type | Description | | --- | --- | --- | | `center` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point where to pan | | `Optional` `coordSystem` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | [`GeodeticSystem`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#geodeticsystem) | if null assumes map system | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### panningHandle ▸ `Protected` **panningHandle**(`sender`, `eventArgs`): `void` Handles the panning tool events for properly panning widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `sender` | [`Panning`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.panning.panning) | sender | | `eventArgs` | [`PanningEventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.panningeventargs.panningeventargs) | event args | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[panningHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#panninghandle) #### postRendering ▸ `Protected` **postRendering**(`context`, `callback?`): `void` To be called after rendering, used for PDF output #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | | `Optional` `callback` | () => `void` | callback to be called after rendering | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[postRendering](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#postrendering) #### preRendering ▸ `Protected` **preRendering**(`context`, `callback?`): `void` Occurs before child rendering #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | | `Optional` `callback` | () => `void` | callback to be called after rendering of geometry | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[preRendering](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#prerendering) #### rebuild ▸ **rebuild**(`force?`, `changes?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Rebuild node. This method resets state, cache, and invalidate node. #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `force` | `boolean` | optional boolean parameter that can force invalidation | | `Optional` `changes` | [`StateChanges`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#statechanges) | optional parameter to specify a reason of changes | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[rebuild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#rebuild) #### refreshLayout ▸ **refreshLayout**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Refresh layout of inner components of the widget #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[refreshLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#refreshlayout) #### registerAnimationStyle ▸ **registerAnimationStyle**(`root`): `void` Register animation style. #### Parameters | Name | Type | Description | | --- | --- | --- | | `root` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | root node for node | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[registerAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#registeranimationstyle) #### removeAxis ▸ **removeAxis**(`axis`): `void` remove axis #### Parameters | Name | Type | Description | | --- | --- | --- | | `axis` | [`Axis`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) | axis to be removed | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeAxis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removeaxis) #### removeBaseLayer ▸ **removeBaseLayer**(`baseLayer`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove child baseLayer #### Parameters | Name | Type | Description | | --- | --- | --- | | `baseLayer` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | baseLayer or array of nodes to be removed | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeBaseLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removebaselayer) #### removeChild ▸ **removeChild**(`node`, `disposeChildren?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove child node #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | node or array of nodes to be removed | | `Optional` `disposeChildren` | `boolean` | automatically dispose children. If it is true then method dispose is called for each child. | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removechild) #### removeCssClass ▸ **removeCssClass**(`cssclass`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Removes css class from node #### Parameters | Name | Type | Description | | --- | --- | --- | | `cssclass` | `string` | `string`[] | css class name('s) | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removecssclass) #### removeInvalidateHandler ▸ **removeInvalidateHandler**(`handler`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove invalidate handler **`Deprecated`** since 4.0, use Node.off instead #### Parameters | Name | Type | Description | | --- | --- | --- | | `handler` | `Function` | handler to be notified about invalidation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removeinvalidatehandler) #### removeLayer ▸ **removeLayer**(`layer`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Removes a Layer **`Fires`** [Events.onLayerRemoved](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#events#onlayerremoved) #### Parameters | Name | Type | Description | | --- | --- | --- | | `layer` | [`AbstractLayer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.layers.abstractlayer.abstractlayer) | Layer to remove | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### removeLegend ▸ **removeLegend**(`legendPanel`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) remove legend #### Parameters | Name | Type | | --- | --- | | `legendPanel` | [`LegendPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.legends.legendpanel.legendpanel) | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeLegend](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removelegend) #### removeOverlay ▸ **removeOverlay**(`overlay`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Remove child overlay #### Parameters | Name | Type | Description | | --- | --- | --- | | `overlay` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | overlay or array of nodes to be removed | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removeoverlay) #### removeTitle ▸ **removeTitle**(`location`): `void` remove title in the location #### Parameters | Name | Type | Description | | --- | --- | --- | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | of the title | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[removeTitle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#removetitle) #### render ▸ **render**(`context`): `void` Render group #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render group | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[render](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#render) #### renderAsync ▸ **renderAsync**(`context`, `callback`): `void` Render node in asynchronous mode. This implementation doesn't support cache for now. #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | The rendering context to be used to draw the node | | `callback` | () => `void` | callback function | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderasync) #### renderBackground ▸ `Protected` **renderBackground**(`context`, `bounds`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Render background #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render background | | `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | group bounds | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderBackground](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderbackground) #### renderBaseLayers ▸ `Protected` **renderBaseLayers**(`context`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render baseLayers | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderBaseLayers](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderbaselayers) #### renderBaseLayersAsync ▸ `Protected` **renderBaseLayersAsync**(`context`, `callback`): `void` Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render overlays | | `callback` | () => `void` | callback function | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderBaseLayersAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderbaselayersasync) #### renderChildren ▸ `Protected` **renderChildren**(`context`): `void` Render children #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderChildren](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderchildren) #### renderChildrenAsync ▸ `Protected` **renderChildrenAsync**(`context`, `callback`): `void` Render children async #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | | `callback` | () => `void` | callback function to be called then all children are rendered | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderChildrenAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderchildrenasync) #### renderContent ▸ `Protected` **renderContent**(`context`): `void` render to specified context. This method calls preRendering, renderChildren, postRendering #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderContent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#rendercontent) #### renderContentAsync ▸ `Protected` **renderContentAsync**(`context`, `callback`): `void` Render children in asynchronous mode #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | The rendering context to be used to draw the node | | `callback` | () => `void` | callback function to be called then all children are rendered | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderContentAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#rendercontentasync) #### renderOverlays ▸ `Protected` **renderOverlays**(`context`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render overlays | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderOverlays](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderoverlays) #### renderOverlaysAsync ▸ `Protected` **renderOverlaysAsync**(`context`, `callback`): `void` Render overlays on top of cache in asynchronous mode. This method calls renderOverlays #### Parameters | Name | Type | Description | | --- | --- | --- | | `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | context to render overlays | | `callback` | () => `void` | callback function | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[renderOverlaysAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#renderoverlaysasync) #### restoreToolState ▸ **restoreToolState**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Restore tools state #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[restoreToolState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#restoretoolstate) #### resumeUpdate ▸ **resumeUpdate**(`rebuild?`, `changes?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Resume auto update #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `rebuild` | `boolean` | force rebuild | | `Optional` `changes` | [`StateChanges`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#statechanges) | optional parameter to specify a reason of changes | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[resumeUpdate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#resumeupdate) #### rotate ▸ **rotate**(`theta`, `x`, `y`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Rotate bounds around a given coordinate #### Parameters | Name | Type | Description | | --- | --- | --- | | `theta` | `number` | angle to rotate node, in radians | | `x` | `number` | x coordinate to rotate around | | `y` | `number` | y coordinate to rotate around | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[rotate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#rotate) #### saveTemplate ▸ **saveTemplate**(`registry?`): `string` Save template saves visual properties of the current template. It is only a visual representation of the current widget. It does not contain any data #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `registry` | [`Registry`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.registry.registry) | registry | #### Returns `string` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[saveTemplate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#savetemplate) #### saveToolsState ▸ **saveToolsState**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Saves tools state #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[saveToolsState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#savetoolsstate) #### scale ▸ **scale**(`xx`, `yy`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Scale node #### Parameters | Name | Type | Description | | --- | --- | --- | | `xx` | `number` | x scale factor | | `yy` | `number` | y scale factor | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[scale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#scale) #### scaleModel ▸ **scaleModel**(`xx`, `yy`, `posX?`, `posY?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Scale node's contents. **`Fires`** [Events.ModelVisibleLimitsChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#events#modelvisiblelimitschanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `xx` | `number` | x scale factor | | `yy` | `number` | y scale factor | | `Optional` `posX` | `number` | x position to scale from (in pxl) | | `Optional` `posY` | `number` | y position to scale from (in pxl) | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[scaleModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#scalemodel) #### setAnimationStyle ▸ **setAnimationStyle**(`style`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets animation style #### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`AnimationStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.animationstyle.animationstyle) | animation style | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setanimationstyle) #### setAnnotationSize ▸ **setAnnotationSize**(`annotationSize?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) apply size (width or height) to annotation (convenience method) **`Example`** ```ts { * west : 50, * east : '10%', * south: 'auto' * } ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `annotationSize` | [`AnnotationSize`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#annotationsize) | JSON to hold (width or height) of the annotation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setAnnotationSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setannotationsize) #### setAnnotationsOptions ▸ **setAnnotationsOptions**(`options`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets annotations' options. currently setAnnotationOptions can only modify existing annotation, while the constructor for the widget can create new ones. #### Parameters | Name | Type | Description | | --- | --- | --- | | `options` | [`AnnotationOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#annotatednode#annotationoptions) | JSON to hold annotations' options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setAnnotationsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setannotationsoptions) #### setAutoModelLimitsMode ▸ **setAutoModelLimitsMode**(`mode`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds. This is convenient method. It creates [AutoModelLimitsStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.automodellimitsstrategy.automodellimitsstrategy) #### Parameters | Name | Type | Description | | --- | --- | --- | | `mode` | `boolean` | Model Limits Logics to be used | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setAutoModelLimitsMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setautomodellimitsmode) #### setAutoModelLimitsStrategy ▸ **setAutoModelLimitsStrategy**(`strategy`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set Model Limits Logics Strategy #### Parameters | Name | Type | Description | | --- | --- | --- | | `strategy` | [`ModelLimitsStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.modellimitsstrategy.modellimitsstrategy) | Model Limits logic strategy to use | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setAutoModelLimitsStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setautomodellimitsstrategy) #### setBounds ▸ **setBounds**(`bounds`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets bounds of the map #### Parameters | Name | Type | Description | | --- | --- | --- | | `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#rect#options) | bound of the map | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setbounds) #### setCache ▸ **setCache**(`cache`, `rebuild?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets cache to be used to cache #### Parameters | Name | Type | Description | | --- | --- | --- | | `cache` | [`Cache`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.cache.cache) | cache to be used | | `Optional` `rebuild` | `boolean` | rebuild cache | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setCache](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcache) #### setCenterModelLimits ▸ **setCenterModelLimits**(`limits`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets inner model limits #### Parameters | Name | Type | Description | | --- | --- | --- | | `limits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | inner limits | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcentermodellimits) #### setChild ▸ **setChild**(`index`, `node`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Replace child node by index #### Parameters | Name | Type | Description | | --- | --- | --- | | `index` | `number` | index of the node | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setChild](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setchild) #### setClipStyle ▸ **setClipStyle**(`style`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets a new clipping style #### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath) | [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle) | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#clipstyle#options) | a new clipping style | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setClipStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setclipstyle) #### setContentOrientation ▸ **setContentOrientation**(`orientation`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set content orientation #### Parameters | Name | Type | Description | | --- | --- | --- | | `orientation` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | content orientation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setContentOrientation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcontentorientation) #### setCss ▸ **setCss**(`style`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets CSS style. This style will be applied for all inserted elements #### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.css-1#cssstyle#type) | CSS style to be applied to inserted elements | | `Optional` `merge` | `boolean` | merge flag | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setCss](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcss) #### setCssClass ▸ **setCssClass**(`name`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets css class name of the node to be used to apply CSS style #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | css class name of the node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcssclass) #### setCssTransform ▸ **setCssTransform**(`transform`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set CSS transformation #### Parameters | Name | Type | Description | | --- | --- | --- | | `transform` | `string` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) | transformation css transformation instruction or Transformation instance | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setCssTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setcsstransform) #### setDesiredHeight ▸ **setDesiredHeight**(`value`, `silent?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets desired height of the group as a layoutable object #### Parameters | Name | Type | Description | | --- | --- | --- | | `value` | `string` | `number` | desired height to set, use 'auto' for automatic desired height | | `Optional` `silent` | `boolean` | silent setting | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setDesiredHeight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setdesiredheight) #### setDesiredWidth ▸ **setDesiredWidth**(`value`, `silent?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets desired width of the group as a layoutable object #### Parameters | Name | Type | Description | | --- | --- | --- | | `value` | `string` | `number` | desired width to set | | `Optional` `silent` | `boolean` | silent setting | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setDesiredWidth](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setdesiredwidth) #### setExportLimits ▸ **setExportLimits**(`limits`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets export limits #### Parameters | Name | Type | Description | | --- | --- | --- | | `limits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | export limits | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setExportLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setexportlimits) #### setExportScale ▸ **setExportScale**(`scale`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets export scale. #### Parameters | Name | Type | Description | | --- | --- | --- | | `scale` | `Object` | scale | | `scale.x` | `number` | scale by x form model to device | | `scale.y` | `number` | scale by y form model to device | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setExportScale](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setexportscale) #### setFillStyle ▸ **setFillStyle**(`fillStyle`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets fill style #### Parameters | Name | Type | Description | | --- | --- | --- | | `fillStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#fillstyle#type) | a new fill style | | `Optional` `merge` | `boolean` | true if you want to merge fillStyle with existing attribute, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setfillstyle) #### setHorizontalFlip ▸ **setHorizontalFlip**(`enable`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set horizontal flip of the representation #### Parameters | Name | Type | Description | | --- | --- | --- | | `enable` | `boolean` | enable flip | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setHorizontalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#sethorizontalflip) #### setId ▸ **setId**(`id`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Allows the user to associate any identifier #### Parameters | Name | Type | Description | | --- | --- | --- | | `id` | `string` | `number` | object id | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setid) #### setInfiniteMode ▸ **setInfiniteMode**(`infinityMode`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set infinity mode flag to draw composite without collision check #### Parameters | Name | Type | Description | | --- | --- | --- | | `infinityMode` | `boolean` | infinity mode flag | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setInfiniteMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setinfinitemode) #### setLayout ▸ **setLayout**(`layout`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Associate layout with a group. #### Parameters | Name | Type | Description | | --- | --- | --- | | `layout` | `Record`<`string`, `any`> | [`Layout`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layout.layout) | layout instance to be set or layout properties to apply | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setlayout) #### setLayoutInvalidated ▸ `Protected` **setLayoutInvalidated**(`invalidated`): `void` Set invalidation status #### Parameters | Name | Type | Description | | --- | --- | --- | | `invalidated` | `boolean` | invalidated layout | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setLayoutInvalidated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setlayoutinvalidated) #### setLayoutStyle ▸ **setLayoutStyle**(`layoutStyle`, `silent?`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) specify desired layout style #### Parameters | Name | Type | Description | | --- | --- | --- | | `layoutStyle` | [`LayoutStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layoutstyle.layoutstyle)<`string` | `number`> | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#layoutstyle#options)<`string` | `number`> | desired layout style | | `Optional` `silent` | `boolean` | silent setting | | `Optional` `merge` | `boolean` | true if you want to merge layoutStyle with existing attribute, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setLayoutStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setlayoutstyle) #### setLineStyle ▸ **setLineStyle**(`lineStyle`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets border color Returns this #### Parameters | Name | Type | Description | | --- | --- | --- | | `lineStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#linestyle#type) | line style or options | | `Optional` `merge` | `boolean` | true if you want to merge lineStyle with existing attribute, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setlinestyle) #### setLocalTransform ▸ **setLocalTransform**(`localTransform`, `force?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets local transformation to be used to transform from local to parent coordinate #### Parameters | Name | Type | Description | | --- | --- | --- | | `localTransform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) | local transformation for this node | | `Optional` `force` | `boolean` | boolean flag to force update event if transformations are equal, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setLocalTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setlocaltransform) #### setMapScale ▸ **setMapScale**(`scale`, `onCurrentParallel?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets the current map scale #### Parameters | Name | Type | Description | | --- | --- | --- | | `scale` | `number` | map scale | | `Optional` `onCurrentParallel` | `boolean` | true, if you need to use factor, else false | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### setMapScaleObject ▸ **setMapScaleObject**(`mapscale`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets the Map scale object that is anchored in the one position of the map #### Parameters | Name | Type | Description | | --- | --- | --- | | `mapscale` | [`MapScale`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.util-3.mapscale.mapscale) | map scale | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### setMarginsStyle ▸ **setMarginsStyle**(`margins`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets margins style #### Parameters | Name | Type | Description | | --- | --- | --- | | `margins` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#spacestyle#type)<`string` | `number`> | margins style | | `Optional` `merge` | `boolean` | true if you want to merge marginsStyle with existing attribute, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setMarginsStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setmarginsstyle) #### setModelLimits ▸ **setModelLimits**(`limits`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets inner model limits #### Parameters | Name | Type | Description | | --- | --- | --- | | `limits` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#rect#type) | inner limits | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setmodellimits) #### setModelTransformation ▸ **setModelTransformation**(`transformation`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Attempts to set local transformation for the model. NOTE: the local transformation set may not be equal to transformation passed - it depends on current ScaleScrollStrategy set on the node. #### Parameters | Name | Type | Description | | --- | --- | --- | | `transformation` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) | transformation to set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setModelTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setmodeltransformation) #### setName ▸ **setName**(`name`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets name of the node #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | The node name | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setname) #### setNotification ▸ **setNotification**(`notify`, `force?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) set notification state #### Parameters | Name | Type | Description | | --- | --- | --- | | `notify` | `boolean` | flag set to invalidate parent or not | | `Optional` `force` | `boolean` | true if parent should be invalidated immediately | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setnotification) #### setOpacity ▸ **setOpacity**(`opacity`, `blendMode?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets node opacity #### Parameters | Name | Type | Description | | --- | --- | --- | | `opacity` | `number` | node opacity from 0 to 1 | | `Optional` `blendMode` | [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode) | opacity blend mode. If it is normal, opacity will be replaced. | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setOpacity](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setopacity) #### setOptions ▸ **setOptions**(`options?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets options #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`OptionsBase`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#map#optionsbase) | options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### setPaddingStyle ▸ **setPaddingStyle**(`paddingStyle`, `merge?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets padding style #### Parameters | Name | Type | Description | | --- | --- | --- | | `paddingStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#spacestyle#type)<`string` | `number`> | padding style | | `Optional` `merge` | `boolean` | true if you want to merge paddingStyle with existing attribute, false by default | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setPaddingStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setpaddingstyle) #### setParent ▸ **setParent**(`parent`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets parent node. Don't call this method directly. It is internal method. #### Parameters | Name | Type | Description | | --- | --- | --- | | `parent` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | a parent node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setparent) #### setProperties ▸ **setProperties**(`properties?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets all the properties pertaining to this object #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `properties` | `Omit`<[`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#options), `"model"`> | properties | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setproperties) #### setProperty ▸ **setProperty**(`name`, `value`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets dynamic property by name #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | property name | | `value` | `any` | property value | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setproperty) #### setRenderingFilter ▸ **setRenderingFilter**(`filter`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets filter to be applied before rendering and picking #### Parameters | Name | Type | Description | | --- | --- | --- | | `filter` | [`IFilter`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.ifilter.ifilter) | filter to set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setRenderingFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setrenderingfilter) #### setResponsiveStyle ▸ **setResponsiveStyle**(`style`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets responsive style. #### Parameters | Name | Type | Description | | --- | --- | --- | | `style` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.responsive#responsivestyle#options) | [`ResponsiveStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.responsive.responsivestyle.responsivestyle) | responsive style | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setResponsiveStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setresponsivestyle) #### setScaleScrollStrategy ▸ **setScaleScrollStrategy**(`delegate`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) set the scale scroll strategy to apply to the widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `delegate` | [`Delegate`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#scalescrollstrategy#delegate) | scaleScrollStrategy to set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setScaleScrollStrategy](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setscalescrollstrategy) #### setScaleUnit ▸ **setScaleUnit**(`unit`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets scale unit #### Parameters | Name | Type | Description | | --- | --- | --- | | `unit` | `string` | [`AbstractUnit`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.abstractunit.abstractunit) | new unit of this map | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### setSelectable ▸ **setSelectable**(`selectable`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Allows to select node. If node is not selectable then child node is not selectable. #### Parameters | Name | Type | Description | | --- | --- | --- | | `selectable` | `boolean` | flag to allow node selection | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setselectable) #### setSilent ▸ **setSilent**(`bool`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set silent mode #### Parameters | Name | Type | Description | | --- | --- | --- | | `bool` | `boolean` | flag to enable silent mode | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setsilent) #### setTag ▸ **setTag**(`tag`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Allows the user to associate any arbitrary object with the node. #### Parameters | Name | Type | Description | | --- | --- | --- | | `tag` | `any` | The object to be associated with the node. | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#settag) #### setTitleOptions ▸ **setTitleOptions**(`location`, `options`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) set options for title #### Parameters | Name | Type | Description | | --- | --- | --- | | `location` | [`AnnotationLocation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#annotationlocation) | of the title | | `options` | `Omit`<[`TitleOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#titleoptions), `"location"`> | title options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setTitleOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#settitleoptions) #### setTool ▸ `Protected` **setTool**(`tool`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set root tool associated to this widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `tool` | [`CompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.compositetool.compositetool) | tool to be set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#settool) #### setToolsOptions ▸ **setToolsOptions**(`options?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set Tools Options **`Example`** ```ts //To prevent the selection tool from deselecting the previously selected points, for example user can do the following: annotatedWidget.setToolsOptions({ 'selection': { 'resetselection': false } }); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`ToolsOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#toolsoptions) | JSON which defines tools options | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setToolsOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#settoolsoptions) #### setVerticalFlip ▸ **setVerticalFlip**(`flip`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Set vertical flip of the representation #### Parameters | Name | Type | Description | | --- | --- | --- | | `flip` | `boolean` | flag to set the vertical flip of the representation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setVerticalFlip](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setverticalflip) #### setVisible ▸ **setVisible**(`value`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets visibility of the node. Send event [Events.VisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#events#visibilitychanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `value` | `boolean` | flag specifying visibility of the node | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setvisible) #### setVisibleCenterModelLimits ▸ **setVisibleCenterModelLimits**(`newVisibleModelLimits`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Attempts to set model's visible limits to specified limits. NOTE: the limits set may not be equal to the limit passed - it depends on current ScaleScrollStrategy set on the node. **`Fires`** [Events.ModelVisibleLimitsChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#events#modelvisiblelimitschanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `newVisibleModelLimits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | limits to set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setVisibleCenterModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setvisiblecentermodellimits) #### setVisibleModelLimits ▸ **setVisibleModelLimits**(`newVisibleModelLimits`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Attempts to set model's visible limits to specified limits. NOTE: the limits set may not be equal to the limit passed - it depends on current ScaleScrollStrategy set on the node. #### Parameters | Name | Type | Description | | --- | --- | --- | | `newVisibleModelLimits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | limits to set | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setVisibleModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setvisiblemodellimits) #### setZIndex ▸ **setZIndex**(`value`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Sets z-index for node (set null for default) #### Parameters | Name | Type | Description | | --- | --- | --- | | `value` | `number` | index determining node z-position | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[setZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#setzindex) #### setZoomLevel ▸ **setZoomLevel**(`level`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Changes current map scale so it fits provided zoom level #### Parameters | Name | Type | Description | | --- | --- | --- | | `level` | `number` | desired zoom level | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### shear ▸ **shear**(`shx`, `shy`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Shear this node's bounds #### Parameters | Name | Type | Description | | --- | --- | --- | | `shx` | `number` | x-axis shear | | `shy` | `number` | y-axis shear | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[shear](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#shear) #### suspendUpdate ▸ **suspendUpdate**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Suspend auto update #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[suspendUpdate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#suspendupdate) #### synchronizeViewLimits ▸ `Protected` **synchronizeViewLimits**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[synchronizeViewLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#synchronizeviewlimits) #### toString ▸ **toString**(): `string` Returns a string representation of this object (generally the classname) #### Returns `string` A string representation #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#tostring) #### transformFromMap ▸ **transformFromMap**(`point`, `to`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) Transform a point from map coordinate system to specified coordinate system #### Parameters | Name | Type | Description | | --- | --- | --- | | `point` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point to transform | | `to` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | [`GeodeticSystem`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#geodeticsystem) | system converting from | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### transformPoint ▸ **transformPoint**(`point`, `from`, `to`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) Transform point #### Parameters | Name | Type | Description | | --- | --- | --- | | `point` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point to transform | | `from` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | [`GeodeticSystem`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#geodeticsystem) | system converting from | | `to` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | [`GeodeticSystem`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#geodeticsystem) | system converting to | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### transformToMap ▸ **transformToMap**(`point`, `from`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) Transform a point from coordinate system to map coordinate system #### Parameters | Name | Type | Description | | --- | --- | --- | | `point` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point to transform | | `from` | [`AbstractSystem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.coordinatesystems.abstractsystem.abstractsystem) | [`GeodeticSystem`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#geodeticsystem) | system converting from | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### translate ▸ **translate**(`tx`, `ty`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Translate bounds #### Parameters | Name | Type | Description | | --- | --- | --- | | `tx` | `number` | x translation | | `ty` | `number` | y translation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[translate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#translate) #### translateModel ▸ **translateModel**(`tx`, `ty`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Translates widget's contents. **`Fires`** [Events.ModelVisibleLimitsChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.widgets-1#annotatedwidget#events#modelvisiblelimitschanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `tx` | `number` | x translation | | `ty` | `number` | y translation | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[translateModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#translatemodel) #### unregisterAnimationStyle ▸ **unregisterAnimationStyle**(`root`): `void` Unregister animation style. #### Parameters | Name | Type | Description | | --- | --- | --- | | `root` | [`AnimatedNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.animatednode.animatednode) | root node for node | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[unregisterAnimationStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#unregisteranimationstyle) #### updateLayout ▸ **updateLayout**(`targets?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Updates layout(s) **`Fires`** [Events.LayoutUpdated](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#events#events#layoutupdated) #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `targets` | [`ILayoutable`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.ilayoutable.ilayoutable)[] | optional parameter about which element to layout | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[updateLayout](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#updatelayout) #### updateSceneTransformation ▸ **updateSceneTransformation**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Update scene transformation #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[updateSceneTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#updatescenetransformation) #### updateState ▸ **updateState**(`regions?`, `changes?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `regions` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)[] | optional array to return invalid rectangles in the parent coordinates | | `Optional` `changes` | [`StateChanges`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#statechanges) | optional parameter to specify a reason of changes | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[updateState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#updatestate) #### updateSuspended ▸ **updateSuspended**(): `boolean` Return state of suspend state #### Returns `boolean` state of update #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[updateSuspended](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#updatesuspended) #### updateTimeStamp ▸ `Protected` **updateTimeStamp**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Update time stamp to indicate that Node or Children has been changed. #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[updateTimeStamp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#updatetimestamp) #### zoom ▸ **zoom**(`amount`, `posX?`, `posY?`): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) Scale node's contents. #### Parameters | Name | Type | Description | | --- | --- | --- | | `amount` | `number` | zoom factor (> 1 for in, < 1 for out) | | `Optional` `posX` | `number` | x position to scale from (in pxl) | | `Optional` `posY` | `number` | y position to scale from (in pxl) | #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### zoomHandle ▸ `Protected` **zoomHandle**(`sender`, `eventArgs`): `void` Handles the zoom tool events for properly scaling widget #### Parameters | Name | Type | Description | | --- | --- | --- | | `sender` | [`Zoom`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.zoom.zoom) | sender | | `eventArgs` | [`ZoomEventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.zoomeventargs.zoomeventargs) | event args | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[zoomHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#zoomhandle) #### zoomIn ▸ **zoomIn**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) zoom in, with default factor = 5/4 #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[zoomIn](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#zoomin) #### zoomOut ▸ **zoomOut**(): [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) zoom out, with default factor = 5/4 #### Returns [`Map`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.map.map) this #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[zoomOut](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#zoomout) #### zoomToRect ▸ **zoomToRect**(`limits?`): `void` Sets visible model limits, keeping the full limits resolution #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `limits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | the visible model limits | #### Returns `void` #### Overrides [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[zoomToRect](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#zoomtorect) #### enableSceneGraphNotification ▸ `Static` **enableSceneGraphNotification**(`enabled`): `void` Enable / disable all notifications #### Parameters | Name | Type | Description | | --- | --- | --- | | `enabled` | `boolean` | sets if this object sends notifications | #### Returns `void` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[enableSceneGraphNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#enablescenegraphnotification) #### findParent ▸ `Static` **findParent**<`T`>(`node`, `classType`, `filter?`): `InstanceType`<`T`> Find root of the node with specified type #### Type parameters | Name | Type | | --- | --- | | `T` | extends [`Constructor`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.base#constructor)<`any`> | #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to start search | | `classType` | `T` | type of the class to search for | | `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | additional filter to apply | #### Returns `InstanceType`<`T`> #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#findparent) ▸ `Static` **findParent**(`node`, `classType`, `filter?`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Find root of the node with specified type #### Parameters | Name | Type | Description | | --- | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to start search | | `classType` | `string` | interface name to search for | | `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | additional filter to apply | #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#findparent) #### getClassName ▸ `Static` **getClassName**(): `string` #### Returns `string` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#getclassname-1) #### isSceneGraphNotificationEnabled ▸ `Static` **isSceneGraphNotificationEnabled**(): `boolean` Return status of the global notification for all nodes. #### Returns `boolean` #### Inherited from [AnnotatedWidget](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget).[isSceneGraphNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.widgets-1.annotatedwidget.annotatedwidget#isscenegraphnotificationenabled)