Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebGLMap

A WebGLMap is identical to luciad.view.Map, except it uses the browser's WebGL capabilities for hardware-accelerated rendering.

To create a hardware-accelerated 2D map, do: 

map = new WebGLMap("map");

To create a hardware-accelerated 3D map, use reference EPSG:4978: 

map = new WebGLMap("map", { reference: ReferenceProvider.getReference("EPSG:4978") });

Please refer to the documentation of Map for all the details.

In addition to the constructor options on Map, you can pass:

  • maxMemoryUsageHint, a literal with cpuMB and/or gpuMB properties. See maxMemoryUsageHint for details.

For more details on WebGL, hardware-accelerated maps, please refer to the LuciadRIA Developer's Guide. The appendix WebGL system requirements and limitations contains details on supported devices and browsers, considerations, limitations, and so on.

since

2016.0

Hierarchy

Implements

Overview

Enumerations

Constructors

Events

Accessors

Methods

Constructors

constructor

  • Creates a new WebGL map.

    Parameters

    • node: string | HTMLElement

      either the DOM node in the web-page which will hold the map or that node's id. The container for a map is typically a DIV-element.

    • Optional options: WebGLMapConstructorOptions

      the map configuration

    Returns WebGLMap

Events

on

  • (event: "PostRender", callback: (glContext: WebGL2RenderingContext) => void, context?: any): Handle
  • (event: "idle", callback: () => void, context?: any): Handle
  • (event: "SelectionChanged", callback: (selectionChangeEvents: { selectionChanges: SelectionChangeInfo[] }) => void, context?: any): Handle
  • (event: "HoverChanged", callback: (hoverChangeEvents: { hoverChanges: HoverChangeInfo[] }) => void, context?: any): Handle
  • (event: "MapChange", callback: () => void, context?: any): Handle
  • (event: "ShowBalloon", callback: () => void, context?: any): Handle
  • (event: "HideBalloon", callback: () => void, context?: any): Handle
  • (event: "ControllerChanged", callback: (newController: Controller | null, previousController: Controller | null) => void, context?: any): Handle

  • Event hook that is called every frame after the map's layers have been rendered, but before the frame is displayed. This allows you to paint additional content directly on the GL context in a post-render step.

    The GL context has a depth buffer available for depth testing. This enables the external content to be immersed in the environment, meaning it will not be painted when it is behind opaque obstacles originating from LuciadRIA layers. Make sure to enable depth testing when you want this though.

    Drawing directly on the GL context, or even delegating that to an external renderer, requires some WebGL knowledge and is likely much more complex than rendering through regular LuciadRIA layers. Additionally, this rendering approach comes with some limitations that are documented below, which may not make the content behave the way that you want it to. For those reasons, we recommend to only use this callback when your use case cannot be achieved by conventional means. For example, when you want to display non-animated 3D content, this can be done with LuciadRIA's 3D icons API instead.

    Since this callback is only a post-render step, it is not fully integrated in LuciadRIA's rendering cycle and comes with some limitations:

    • Painting always happens after all layers have been painted. In other words, the external content cannot be painted before or in-between LuciadRIA layers. Note that, even though the painting order is fixed, depth testing can still be used to place your content behind objects in LuciadRIA layers.

    • LuciadRIA controllers cannot interact with the external content. Because the content is painted directly on the GL context, LuciadRIA is essentially not aware of its existence. This makes it impossible to select the content, for example, or use it as an anchor for panning and zooming.

    • Transparent objects from LuciadRIA layers will always appear below the content you paint yourself.

      While depth testing enables you to hide content behind opaque obstacles, the depth buffer does not contain data on transparent obstacles. This means that your content will be painted as though the transparent obstacles are not even there.

      When this situation occurs within or between regular layers, LuciadRIA will blend the colors of the involved objects. This results in a much more natural-looking rendering, as it gives the impression that you're only seeing the object through the transparent obstacle. For content rendered in this post-render step, that color blending is not possible.

    • LuciadRIA effects such as lighting and shadows will not be applied to the external content.

    Note: It is the caller's responsibility to restore the GL context to its initial state after using it. Not meeting this requirement can result in undefined behavior.

    since

    2021.1

    Parameters

    • event: "PostRender"

      The "PostRender" event type

    • callback: (glContext: WebGL2RenderingContext) => void

      callback to be invoked every frame, after the layers have been rendered. The callback gets a WebGL 2 context as parameter, allowing it to paint additional content.

        • (glContext: WebGL2RenderingContext): void

        • Parameters

          • glContext: WebGL2RenderingContext

          Returns void

    • Optional context: any

      value to use as this when executing callback

    Returns Handle

  • see

    Map.on

    Parameters

    • event: "idle"
    • callback: () => void
        • (): void

        • Returns void

    • Optional context: any

    Returns Handle

  • see

    Map.on

    Parameters

    Returns Handle

  • see

    Map.on

    Parameters

    Returns Handle

  • see

    Map.on

    Parameters

    • event: "MapChange"
    • callback: () => void
        • (): void

        • Returns void

    • Optional context: any

    Returns Handle

  • see

    Map.on

    Parameters

    • event: "ShowBalloon"
    • callback: () => void
        • (): void

        • Returns void

    • Optional context: any

    Returns Handle

  • see

    Map.on

    Parameters

    • event: "HideBalloon"
    • callback: () => void
        • (): void

        • Returns void

    • Optional context: any

    Returns Handle

  • see

    Map.on

    Parameters

    • event: "ControllerChanged"
    • callback: (newController: Controller | null, previousController: Controller | null) => void
    • Optional context: any

    Returns Handle

Accessors

adjustDepthRange

  • get adjustDepthRange(): boolean
  • set adjustDepthRange(value: boolean): void

  • A boolean indicating whether the near and far planes of this map's camera should automatically adjust when the camera or terrain gets updated. By default, this is true to avoid rendering artifacts while keeping objects on the earth's surface visible. Setting this to false removes this safeguard but allows you to have more fine-grained control of the near and far planes, for example when you want to be able to navigate close to objects that are far away from the earth.

    since

    2022.0

    Returns boolean

  • A boolean indicating whether the near and far planes of this map's camera should automatically adjust when the camera or terrain gets updated. By default, this is true to avoid rendering artifacts while keeping objects on the earth's surface visible. Setting this to false removes this safeguard but allows you to have more fine-grained control of the near and far planes, for example when you want to be able to navigate close to objects that are far away from the earth.

    since

    2022.0

    Parameters

    • value: boolean

    Returns any

camera

cameraAnimationKey

  • get cameraAnimationKey(): string

controller

  • The currently active controller of the map. A controller defines how user input is interpreted. If no controller is explicitly configured on the map, a number of defaults apply. See the Controller documentation for more details about these defaults.

    map.controller = new BasicCreateController("point");

    Returns Controller | null

  • The currently active controller of the map. A controller defines how user input is interpreted. If no controller is explicitly configured on the map, a number of defaults apply. See the Controller documentation for more details about these defaults.

    map.controller = new BasicCreateController("point");

    Parameters

    Returns any

cursorManager

domNode

  • get domNode(): HTMLElement

  • The DOM node in which the map is contained. This is the same node which was passed by ID at map construction.

    Returns HTMLElement

dotsPerCentimeter

  • get dotsPerCentimeter(): number

  • The number of virtual pixels ("dots") on the screen per centimeter, as determined by the Map. This value usually varies depending on the device, OS-settings and browser.

    Returns number

dotsPerInch

  • get dotsPerInch(): number

  • The number of virtual pixels ("dots") on the screen per inch, as determined by the Map. This value usually varies depending on the device, OS-settings and browser.

    Returns number

effects

  • The graphics effects that are applied on this map. Have a look at GraphicsEffects for a list of effects that are available.

    You should directly assign properties of the effects fields.

    Any effect that has complex parameters (using an object literal) can be disabled by setting its value to null. For simple effects that have boolean toggles, you can turn the effect off by setting the boolean value to false.: 

        map.effects.light = null;
    map.effects.atmosphere = false;

    Returns GraphicsEffects

globeColor

  • get globeColor(): string
  • set globeColor(globeColor: string): void

  • A CSS color string to indicate the desired color of the globe if no imagery layers are present.

    This only has an effect on 3D maps. On 2D maps, there is no globe.

    By default, the globe is light-grey. 

      map.globeColor = "#aabbcc";  // or "rgba(110, 120, 130, 1.0)"

    Returns string

  • A CSS color string to indicate the desired color of the globe if no imagery layers are present.

    This only has an effect on 3D maps. On 2D maps, there is no globe.

    By default, the globe is light-grey. 

      map.globeColor = "#aabbcc";  // or "rgba(110, 120, 130, 1.0)"

    Parameters

    • globeColor: string

    Returns any

hoveredObjects

  • The set of objects which are currently displayed as "hovered" (i.e. a cursor is hovering over them).

    since

    2021.0

    Returns { hovered: WithIdentifier[]; layer: Layer }[]

layerTree

  • The layer tree that contains all of the layers in this map. This property is immutable.

    Returns LayerTree

mapBounds

  • Returns the current bounds of the map as a rectangle in the map's reference.

    Returns Bounds

mapNavigator

mapScale

  • get mapScale(): [number, number]

  • Returns the scale values of this map view as an array of two Numbers (scale along the X-axes and the Y-axes, in that order). This is a read-only property.

    In the case when the unit of measure is a length (like distance, altitude, easting,....), the scale is the ratio between the distance, as it is measured on the screen of the device, to the distance in the real world. This corresponds with paper map scales. For instance to obtain a 1:10000 map display the scale should be set to 1 / 10000.

    In the case when the unit of measure is of a different type (for example, time or temperature), the scale is the ratio of 1cm on the screen per units of measure. For example, such a scale might express something like 1cm equals 5 hours.

    Note that since web browsers do not provide unambiguous information on the correct screen resolution (which is commonly expressed in dpi (dots per inch)), the distance of 1cm on a device's display is an approximation. To retrieve the conversion factor used by LuciadRIA, you can use the dotsPerCentimeter property of the Map.

    Returns [number, number]

mapToViewTransformation

  • The transformation that can be used to transform coordinates specified in the Map's reference to view coordinates (pixels). See viewToMapTransformation for the inverse transformation.

    In a 3D map, this transformation will throw OutOfBoundsError when the world coordinate is not visible in the current view. This happens when the world coordinate is obscured by terrain or on the back-facing side of the globe.

    Returns Transformation

maxMapScale

  • get maxMapScale(): number | [number, number]
  • set maxMapScale(maxScale: number | [number, number]): void

  • The maximum scale value of the map. A user can not zoom in further than this value. The value is an array of 2 positive numbers: the first for the scale along the horizontal axis, the second for the scale along the vertical axis. These values may also be set with a single number value for convenience.

    The default value of the horizontal and vertical components is Infinity, meaning there is no upper scale limit in both dimensions.

    An error will be thrown when attempting to set an invalid value (e.g. the maxMapScale is smaller than the minMapScale).

    Note that this value may conflict with the minimum scale which is implied by the bounds constraint (Map.restrictNavigationToBounds). When this value is smaller than that minimum-scale (which depends on the width/height of those bounds as well as the width/height of the view), the scale of the bounds-restriction will have precedence over this one.

    This value may conflict with the scale implied by the navigation restriction Map.getBoundsNavigationRestriction. Because the map will be zoomed in so no data outside the restriction is shown, that scale value may be larger than this value. If that is the case, the scale value of the restriction will take precedence. Note that in such a case, it is impossible to zoom the map.

    deprecated

    See constraints to configure scale constraints.

    Returns number | [number, number]

  • The maximum scale value of the map. A user can not zoom in further than this value. The value is an array of 2 positive numbers: the first for the scale along the horizontal axis, the second for the scale along the vertical axis. These values may also be set with a single number value for convenience.

    The default value of the horizontal and vertical components is Infinity, meaning there is no upper scale limit in both dimensions.

    An error will be thrown when attempting to set an invalid value (e.g. the maxMapScale is smaller than the minMapScale).

    Note that this value may conflict with the minimum scale which is implied by the bounds constraint (Map.restrictNavigationToBounds). When this value is smaller than that minimum-scale (which depends on the width/height of those bounds as well as the width/height of the view), the scale of the bounds-restriction will have precedence over this one.

    This value may conflict with the scale implied by the navigation restriction Map.getBoundsNavigationRestriction. Because the map will be zoomed in so no data outside the restriction is shown, that scale value may be larger than this value. If that is the case, the scale value of the restriction will take precedence. Note that in such a case, it is impossible to zoom the map.

    deprecated

    See constraints to configure scale constraints.

    Parameters

    • maxScale: number | [number, number]

    Returns any

maxMemoryUsageHint

  • get maxMemoryUsageHint(): { cpuMB: number; gpuMB: number }
  • set maxMemoryUsageHint(hint: { cpuMB: number; gpuMB: number }): void

  • A hint about the memory consumption allowed by this application.

    These hints only apply to internal data managed by the WebGLMap, not to any user data present in the application.

    This can help preventing the browser tab from crashing. If you experience such behavior, try reducing both CPU and GPU memory from the default values. Alternatively, if memory is not a problem and browser is stable enough, pushing those values higher can improve caching efficiency.

    Notes:

    • The values are expressed in megabytes.
    • The memory will be distributed over the layers in your map.
    • The distribution happens automatically and continuously.
    • The distribution can be un-even, so you can have large layers and small layers.
    • Each layer implementation will attempt to restrict its memory usage to its allocation portion.
    • Typically they will scrap cached data to reach the limit.
    • Some layers will reduce quality or amount of data loaded. If so, they will log this clearly.
    • If a layer still needs more memory than allocated, it will log warnings, but otherwise keep using the memory.
    • Your browser's process memory usage may be much larger than these limits. Next to the data in the layers, your application needs memory also. Additionally, the browser typically keeps copies of GPU data, and needs other data structures to drive its Javascript engine and DOM.

    By default, the limits are 500 MB for CPU and 1000 MB for GPU. 

       map.maxMemoryUsageHint = {
     cpuMB: 500,
     gpuMB: 1200
   }

    Returns { cpuMB: number; gpuMB: number }

    • cpuMB: number
    • gpuMB: number

  • A hint about the memory consumption allowed by this application.

    These hints only apply to internal data managed by the WebGLMap, not to any user data present in the application.

    This can help preventing the browser tab from crashing. If you experience such behavior, try reducing both CPU and GPU memory from the default values. Alternatively, if memory is not a problem and browser is stable enough, pushing those values higher can improve caching efficiency.

    Notes:

    • The values are expressed in megabytes.
    • The memory will be distributed over the layers in your map.
    • The distribution happens automatically and continuously.
    • The distribution can be un-even, so you can have large layers and small layers.
    • Each layer implementation will attempt to restrict its memory usage to its allocation portion.
    • Typically they will scrap cached data to reach the limit.
    • Some layers will reduce quality or amount of data loaded. If so, they will log this clearly.
    • If a layer still needs more memory than allocated, it will log warnings, but otherwise keep using the memory.
    • Your browser's process memory usage may be much larger than these limits. Next to the data in the layers, your application needs memory also. Additionally, the browser typically keeps copies of GPU data, and needs other data structures to drive its Javascript engine and DOM.

    By default, the limits are 500 MB for CPU and 1000 MB for GPU. 

       map.maxMemoryUsageHint = {
     cpuMB: 500,
     gpuMB: 1200
   }

    Parameters

    • hint: { cpuMB: number; gpuMB: number }
      • cpuMB: number
      • gpuMB: number

    Returns any

minMapScale

  • get minMapScale(): number | [number, number]
  • set minMapScale(minScale: number | [number, number]): void

  • The minimum scale value of the map. A user can not zoom out further than this value. The value is an array of 2 positive numbers: the first for the scale along the horizontal axis, the second for the scale along the vertical axis. These values may also be set with a single number value for convenience.

    The default value of the horizontal and vertical components is 0, meaning there is no lower scale limit in both dimensions.

    An error will be thrown when attempting to set an invalid value (e.g. the minMapScale is larger than the maxMapScale). 

    map.minMapScale = 1/200000;
map.maxMapScale = 1/50000;
    deprecated

    See constraints to configure scale constraints.

    Returns number | [number, number]

  • The minimum scale value of the map. A user can not zoom out further than this value. The value is an array of 2 positive numbers: the first for the scale along the horizontal axis, the second for the scale along the vertical axis. These values may also be set with a single number value for convenience.

    The default value of the horizontal and vertical components is 0, meaning there is no lower scale limit in both dimensions.

    An error will be thrown when attempting to set an invalid value (e.g. the minMapScale is larger than the maxMapScale). 

    map.minMapScale = 1/200000;
map.maxMapScale = 1/50000;
    deprecated

    See constraints to configure scale constraints.

    Parameters

    • minScale: number | [number, number]

    Returns any

reference

selectedObjects

  • The selected objects of the map. This is an array of Objects where each Object contains the layer and the selected objects as properties. The name of those properties is layer and selected respectively.

    Performing an action on each selected object of a certain layer can for example be achieved as shown below. 

      var map = ...;
  var selection = map.selectedObjects;
  var i, j;
  var layer, selectedObjects,selectedObject;
  for ( i = 0; i < selection.length; i++ ){
    layer = selection[i].layer;
    if ( isSearchedLayer( layer ) ){
      selectedObjects = selection[i].selected;//array of the selected objects for layer
      for ( j = 0; j < selectedObjects.length; j++ ){
        selectedObject = selectedObjects[j];
        //do something with the selected object
      }
    }
  }

    Returns { layer: Layer; selected: WithIdentifier[] }[]

totalSize

  • get totalSize(): [number, number]

  • The size of the view - including the border - as an array with two Numbers, representing the width and height in pixels.

    Returns [number, number]

viewSize

  • get viewSize(): [number, number]

  • The size of the view - excluding the border - as an array with two Numbers, representing the width and height in pixels. This is the size of the area where the data (not the axes) is rendered.

    Returns [number, number]

viewToMapTransformation

Methods

clearHovered

  • (): void

  • Clear the current set of hovered objects. See hoverObjects for more information.

    since

    2021.0

    Returns void

clearSelection

  • (): void

destroy

  • (): void

  • This method must be called if the map is to be removed from the web page. This method cleans up the DOM and unregisters DOM event handlers.

    Returns void

emit

  • (event: string, ...args: any[]): void

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns void

getBoundsNavigationRestriction

  • Retrieve the bounds to which the navigation is restricted. You should not modify this object while it is set on the map.

    Returns Bounds | null

    the navigation restriction.

getViewToMapTransformation

  • Creates a Transformation object that is used to transform a view position to a corresponding world (map) position in 3D scenes, based on a mechanism that is defined by LocationMode parameter.

    In 3D space there are multiple interpretations possible for a given view point expressed in pixel coordinates. Possible options are:

    • LocationMode.CLOSEST_SURFACE - This transformation yields a world point position corresponding to the visible object at the view location closest to the viewer (camera eye point). The closest 3D object can be represented by 3D meshes, point clouds, extruded shapes, 3D icons or the terrain.
    • LocationMode.TERRAIN - This transformation yields a world point position on the terrain.
    • LocationMode.ELLIPSOID - This transformation yields a world point position on the ellipsoid.

    Note: In 2D space the LocationMode parameter is disregarded and the returned Transformation object is same as the one obtained by viewToMapTransformation.

    If the view coordinate does not represent a point on an object or terrain, then OutOfBoundsError will be thrown.

    View point in 3D scene View to map transformation results in context of the locationMode property
    The first image shows the view point that was used for the transformations. The second image shows from a different perspective the transformation results, points that were created by the Transformation object with different locationMode properties.

    since

    2018.0

    Parameters

    Returns Transformation

hideBalloon

  • (): void

  • Hides the currently shown balloon, if any.

    Returns void

hoverObjects

  • Updates the set of objects which are displayed as "hovered" (i.e. a cursor is hovering over them). Note that this method probably should not be called except from a custom Controller which is reacting to a cursor. If you try to hover an object that is not available in the layer, a ProgrammingError will be thrown. Objects that do not pass the layer's filter (if any) will not be hovered.

    since

    2021.0

    Parameters

    • hovered: PickInfo[]

      a list of objects organized by layer

    Returns void

invalidate

  • (): void

  • refreshes the map unconditionally.

    since

    2021.1

    Returns void

isHovered

  • Determine whether a particular object on a layer is displayed as "hovered" (i.e. a cursor is hovering over it).

    since

    2021.0

    Parameters

    • layer: Layer

      The layer on which the object is sitting

    • object: WithIdentifier

      The object whose hover status is to be determined

    Returns boolean

    true if the object is hovered

isInBorder

  • (border: Border, x: number, y: number): boolean

  • Determines whether a view coordinate is inside one of the map borders or not. See the Map constructor to define a border.

    Parameters

    • border: Border

      the border for which you want to verify the given coordinate

    • x: number

      the x coordinate

    • y: number

      the y coordinate

    Returns boolean

    true if the coordinate is located in the map's border, false otherwise

isSelected

  • Determine whether a particular object on a layer is selected.

    Parameters

    • layer: Layer

      The layer on which the object is sitting

    • object: WithIdentifier

      The object whose selection status is to be determined

    Returns boolean

    true if the object is selected

onClick

  • Override this when you wish to respond to click events on the map

    Parameters

    Returns boolean

onCreateContextMenu

  • (contextMenu: ContextMenu, contextMenuInfo: any): void

  • Override this method to add view-wide content to the map's context menu.

    Parameters

    • contextMenu: ContextMenu

      the context menu

    • contextMenuInfo: any

    Returns void

onShowContextMenu

  • Override this method to display a populated context menu. Implementations of this method should provide the required glue code to display the context menu using UI toolkit dependent code.

    Parameters

    • position: number[]

      the page position at which to show the context menu. The position already compensates for the current scrolling offset of the document

    • contextMenu: ContextMenu

      the context menu

    Returns void

pickAt

  • Retrieves all touched Features in an array of {luciad.view.PickInfo} objects. The type of the underlying layer determines the content of the array:

    • For FeatureLayer, the method returns the touched Features directly from the model
    • For TileSet3DLayer, the method returns an array of proxy features with metadata about the touched 3D geometry. For more information and edge cases, consult the developer guide.

    A pick info object is a JavaScript object with two properties: the objects that were touched, and the layer these objects reside in. One pickinfo object for each layer with a touched object will be added to the result.

    Parameters

    • x: number

      an x location (view space, in pixels)

    • y: number

      an y location (view coordinates, in pixels)

    • aSensitivity: number

      the maximum distance (in pixels) between a touched object and [x,y].

    • Optional paintRepresentations: PaintRepresentation[]

    Returns PickInfo[]

    a list of pick info objects. Layers without touched objects are not in the list.

pickAtRectangle

  • Retrieves all touched Features in an array of pick info objects: a pick info object is a JavaScript object with two properties: the objects that were touched, and the layer these objects reside in. One pickinfo object for each layer with a touched object will be added to the result.

    Parameters

    • x: number

      a x location (view-space, in pixels, the x-coordinate of the center of the rectangle)

    • y: number

      a y location (view-space, in pixels, the y-coordinate of the center of the rectangle)

    • width: number

      the width of the rectangle in which the objects must lie (in pixels) width will be clamped to 1 if it's smaller than 1.

    • height: number

      the height of the rectangle in which the objects must lie (in pixels) height will be clamped to 1 if it's smaller than 1.

    • Optional paintRepresentations: PaintRepresentation[]

    Returns PickInfo[]

    a list of pick info objects. Layers without touched objects are not in the list.

pickClosestObject

  • Retrieves the first touched Feature. The return value of the result is null if no object is touched, or a PickInfo object, with two properties: the objects that were touched (in this case it will be an array with a single element), and the layer that object resides in.

    The closest object is picked by checking distances between the input location and feature shapes, or their labels if the paintRepresentations parameter includes the PaintRepresentation.LABEL.

    Parameters

    • x: number

      an x location (view space, in pixels)

    • y: number

      an y location (view space, in pixels)

    • sensitivity: number

      the maximum distance (in pixels) between a touched object and [x,y].

    • Optional paintRepresentations: PaintRepresentation[]

    Returns PickInfo | null

    a pick info object containing the first touched object, or null.

pickClosestObjectRectangle

  • Retrieves the first touched Feature. The return value of the result is null if no object is touched, or a PickInfo object, with two properties: the objects that were touched (in this case it will be an array with a single element), and the layer that object resides in.

    The closest object is picked by checking distances between the input location and feature shapes, or their labels if the paintRepresentations parameter includes the PaintRepresentation.LABEL.

    Parameters

    • x: number

      an x location (view space, in pixels, the x-coordinate of the center of the rectangle)

    • y: number

      an y location (view space, in pixels, the y-coordinate of the center of the rectangle)

    • width: number

      the width of the rectangle in which the first touched object must lie (in pixels) width will be clamped to 1 if it's smaller than 1.

    • height: number

      the height of the rectangle in which the first touched object must lie (in pixels) height will be clamped to 1 if it's smaller than 1.

    • Optional paintRepresentations: PaintRepresentation[]

    Returns PickInfo | null

    a pick info object containing the first touched object, or null.

resize

  • (): void

  • This method can be called when the size of the map's container has changed. The map will automatically refit itself to the size of the Map container at that time.

    The map listens by default to window resize events to resize automatically. However, if the map container is resized by JavaScript, for example by a JavaScript SplitContainer component that divides the web page in two parts that can be resized, there is no way to detect this resizing of the map container automatically. In that case this method can be called by the application developer

    Returns void

restoreState

  • Restores the state of the map based on a state object that has been returned by the saveState method.

    It is possible to restore the state of a map with a reference that's different from this map's reference. Note that this is only true if a matching camera position can be found.

    For example, it is not possible to restore a map state that's looking at Australia if this map has a Polar Stereographic North reference (because the southern hemisphere is not defined in that projection). In that case, an Error is thrown.

    Parameters

    Returns Promise<void>

    A promise that will be resolved after the restoreState operation has finished.

    Non-animated restoreState operations are synchronous and effective immediately. An already resolved Promise will be returned. In this case, you don't have to use the Promise callbacks to wait for the operation to be completed (but you can, this is useful when switching between animated and non-animated versions).

    For animated restoreState operations, the call is asynchronous. The returned Promise will be resolved when the restoreState animation has completely finished. If the restoreState animation is interrupted (for example, by another animation), the promise is rejected.

restrictNavigationToBounds

  • (bounds: Bounds, options?: { padding?: { bottom?: number; left?: number; right?: number; top?: number } }): void

  • Specify a bounds which identifies the area beyond which the map cannot zoom or pan. When set, a user will not be able to zoom or pan to an area that falls outside this bounds. The default value is null.

    While the bounds can be specified in any spatial reference, the constraints will be evaluated on a bounds in the spatial reference of the map. For example, if the map's reference is in a Mercator grid reference, but the bounds constraint is specified in a geodetic reference, this bounds will be first converted to a bounds in a Mercator grid reference.


    In general, this transformation of the bounds to the map's reference may make the bounds larger. For example, a rectangle in longitude-latitude, will not be a rectangle in a reference with a Polar projection, so the area needs to be distorted somewhat. For high accuracy, it is thus best to use specify the bounds in the reference of the Map.
    See also Transformation for more information about transforming coordinates between reference systems.

    Visual feedback will be shown when the user hits the edges of the constraint during panning. Note that the style of this feedback cannot be modified.

    When calling this method and the center of the view is not inside this bounds, the map will fit on this bounds.

    To cancel the constraint, call this method with null.

    On a 3D map, the constraint is ignored.

    On a 2D map, rotation is not possible when there is a constraint.

    deprecated

    See constraints to configure bounds constraints.

    Parameters

    • bounds: Bounds

      the bounding box restriction.

    • Optional options: { padding?: { bottom?: number; left?: number; right?: number; top?: number } }
      • Optional padding?: { bottom?: number; left?: number; right?: number; top?: number }
        • Optional bottom?: number
        • Optional left?: number
        • Optional right?: number
        • Optional top?: number

    Returns void

saveState

  • (): unknown

  • Returns the current state of the map, so that it can be restored at a later time. Currently this state encompasses a snapshot of the mapToViewTransformation configuration. The returned state object does not have a fixed layout, so accessing properties of the state is not allowed.

    The state of the map does not include the state of the individual layers, nor any of the the navigation or scale restrictions.

    If you're using a custom map reference, this reference needs to have an identifier when saving the map state. When restoring the saved state, ensure the reference can be retrieved from the ReferenceProvider, using the reference identifier.

    Returns unknown

    the current map state

selectObjects

  • Selects a number of objects, passed to this method as an array of PickInfo objects. A PickInfo object is a JavaScript object with two properties: the objects property is an array of the objects that must be selected, the layer property indicates what the layer is these objects are supposed to be in. If you try to select an object that is not available in the layer, a ProgrammingError will be thrown.
    Note: You can select features only on a layer that is marked as selectable. Also, objects that do not pass the layer's filter will not be selected either.

    Parameters

    Returns void

showBalloon

  • Places a balloon on the map. All parameters except the object parameter are optional. If the contentProvider option is present it will be used to generate the balloon content. If not, the balloonContentProvider of the layer will be used to generate the balloon content, provided the layer is configured with one. In all other cases, a string representation of the object will be used as the balloon's content.


    The balloon can be styled using the following CSS selectors:

    • .luciad .lcdBalloon: The balloon's container element. This element is absolutely positioned by LuciadRIA.
    • .luciad .lcdBalloon .lcdFrame: A container that wraps the header and the content.
    • .luciad .lcdBalloon .lcdHeader: The header of the balloon. Contains the close button.
    • .luciad .lcdBalloon .lcdClose: The close button of the balloon.
    • .luciad .lcdBalloon .lcdContent: The main content of the balloon.

    See samples/common/sample-common-style.css for an example usage of these selectors.


    Only one balloon instance can be shown at the same time. Consider using labels if you want to show balloons for multiple objects at the same time. Labels support HTML so they can show the same contents as a balloon. An additional benefit is that labels can be decluttered.

    Parameters

    • options: { contentProvider?: (obj: Feature | Shape) => string | HTMLElement; layer?: FeatureLayer | TileSet3DLayer; object: Feature | Shape; panTo?: boolean }

      An options object that may contain the following properties:

      • {Object} object: The object to which the balloon belongs to. This may be a Feature which is visualized by the Layer, or a {luciad.shape.*}. If this object is a Feature, it should belong to the model of the layer. If it is a Shape, it will be used as the position for the balloon.
      • {luciad.view.feature.FeatureLayer} layer: The layer the object belongs to. If the contentProvider option is omitted, this layer's balloonContentProvider will be used to generate the balloon's content.
      • {Function} contentProvider: a function which accepts a single parameter, and returns the contents for the balloon. The parameter is the object for which the balloon is shown. The return value of the function may be a string or a DOM-node.
      • {Boolean} panTo: whether of not the view should be panned to center on the balloon. 
      ...
//show balloon on the 1st selected object when the selection changes on the map.
map.on("SelectionChanged", function(event) {
  var showBalloonObject = null, showBalloonLayer = null;
  for(var i = 0; i < event.selectionChanges.length; i++) {
    var selectionChange = event.selectionChanges[i];
    if (selectionChange.selected.length > 0) {
      showBalloonObject = selectionChange.selected[0];
      showBalloonLayer = selectionChange.layer;
      break;
    }
  }
  if (showBalloonObject) {
    map.showBalloon({
      panTo: true,
      layer: showBalloonLayer,
      object: showBalloonObject,
      contentProvider: function(o){
        return "You've selected object with id: " + o.id;
      }
    });
  } else {
    map.hideBalloon();
  }
});
...

    Returns void

showContextMenu

  • (position: number[], contextMenuInfo: any): boolean

  • Call this method to show a context menu at the given position.

    Parameters

    • position: number[]

      the page position at which to show the context menu. The passed position should compensate for the current scrolling offset of the document

    • contextMenuInfo: any

      the context menu info object. This object will be passed to onCreateContextMenu

    Returns boolean

    a boolean indicating whether a context menu was shown. If no context menu was shown (because there are no items in the menu, cf. onCreateContextMenu), false is returned.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method