MapIFrameAPI

Global

Methods

connect(cback)

Connection dialog

Parameters:
Name Type Description
cback function

Type Definitions

centerOptions

Center options

Type:
  • Object
Properties:
Name Type Argument Description
center Array.<number> <optional>

[longitude,latitude]
zoom number <optional>

zoom level if center or max zoom if extent
extent Array.<number> <optional>

the extent to fit [lonMin, latMin, lonMax, latMax]
layerId number <optional>

id of a layer to fit if zoom is defined use it as max zoom
selection boolean <optional>

to center on seleced features
offsetZoom number <optional>

zoom offset when layerId or selection (final zoom will be incremented by offsetZoom)

Condition

Condition for object selection

Type:
  • Object
Properties:
Name Type Argument Default Description
layerId number <optional>

the layer to search in, default use the first layer
attr string

name of attribute to test
op string

operation name: '=','!=','<', '<=', '>=', '>', 'contain', '!contain', 'regexp' or '!regexp'
val *

value to test
matchAll boolean <optional>
 false

match all conditions
useCase boolean <optional>
 false

case sensitive

filterResult

Result of a filtering

Type:
  • Object
Properties:
Name Type Description
nb number

number of features filtered (other features in the layer are hidden)
size number

total number of feaures

GeoJSONFeature

A feature in a GeoJSON format

Type:
  • Object
Properties:
Name Type Description
type string

'feature'
gometry JSONGeometry

feature geometry
properties Object

a list of properties as key/value

JSONCoordinate

An array of numbers representing a lon,lat coordinate. Example: [16, 48].

Type:
  • Array.<number>

JSONGeometry

JSON Geometry format

Type:
  • Object
Properties:
Name Type Description
type string

Geometry type: 'Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', or 'MultiPolygon'
coordinates JSONCoordinate | Array.<JSONCoordinate> | Array.<Array.<JSONCoordinate>>

list of coordinates

JSONLayer

Layer desciption as JSON object

Type:
  • Object
Properties:
Name Type Description
id number

layer ID
name string

layer name
title string

layer title
description string

layer description
type string

'image' or 'vector'
visible boolean

layer visibility
opacity boolean

layer opacity [0,1]
displayInLayerSwitcher boolean

the layer appears in the layer switcher or not
theme string

layer theme
inview boolean

the layer is displayed in the thematic layer