Interface: mapRegion

Extends

• region

Type:

• string

Default Value:

• null

Example

Get option copyrightNotice after initialization.

var value = apex.region( "myRegionId" ).copyrightNotice;

Type:

• Array.<Object>

Properties:

Example

Get or set option customStyles after initialization.

// get
var value = apex.region( "myRegionId" ).customStyles;
// set
apex.region( "myRegionId" ).customStyles = [
   {
       "name": "MyCamera",
       "width": 20,
       "height": 20,
       "paint-order": "stroke",
       "viewBox": "0 0 20 20",
       "elements": [
           {
               "type": "path",
               "d": "M15 4h-1.2l-.9-1.2c-.4-.5-1-.8-1.6-.8H8.8c-.7 0-1.3.3-1.6.8L6.2 4H5c-1.1 0-2 .9-2 2v5c0 1.1.9 2 2 2h2.2l2.4 4.7c.1.2.4.3.7.2.1 0 .2-.1.2-.2l2.4-4.7H15c1.1 0 2-.9 2-2V6c0-1.1-.9-2-2-2zm-5 7c-1.4 0-2.5-1.1-2.5-2.5S8.6 6 10 6s2.5 1.1 2.5 2.5S11.4 11 10 11z"
           }
       ]
    }
];

Type:

• jQuery

Inherited From:

• region#element

Example

Get option element after initialization.

var value = apex.region( "myRegionId" ).element;

Type:

• string

Default Value:

• null

Example

Get option itemsToSubmit after initialization.

var value = apex.region( "myRegionId" ).itemsToSubmit;

Type:

• Object

Properties:

Default Value:

• null

Example

Get or set option layerMessages after initialization.

// get
var value = apex.region( "myRegionId" ).layerMessages;
// set
apex.region( "myRegionId" ).layerMessages = { position: "top" };

Type:

• Array.<Object>

Properties:

Example

Get option layers after initialization.

var value = apex.region( "myRegionId" ).layers;

Type:

• boolean

Default Value:

• false

Example

Get option lazyLoading after initialization.

var value = apex.region( "myRegionId" ).lazyLoading;

Type:

• Object

Properties:

Default Value:

• null

Example

Get or set option legend after initialization.

// get
var value = apex.region( "myRegionId" ).legend;
// set
apex.region( "myRegionId" ).legend = { positon: "start", title: "My layers" };

Type:

• Object

Properties:

Default Value:

• null

Example

Get option mapData after initialization.

var value = apex.region( "myRegionId" ).mapData;

Type:

• Object

Properties:

Example

Get or set option mapFeatures after initialization.

// get
var value = apex.region( "myRegionId" ).mapFeatures;
// set
apex.region( "myRegionId" ).mapFeatures = { 
    mousewheelZoom: true, 
    scaleBar: true, 
    circleTool: true, 
    browserLocation: true, 
    rectangleZoom: true, 
    distanceTool: true, 
    overviewMap: true, 
    infiniteMap: true 
};

Type:

• string

Default Value:

• null

Example

Get or set option mapStatusItem after initialization.

// get
var value = apex.region( "myRegionId" ).mapStatusItem;
// set
apex.region( "myRegionId" ).mapStatusItem = "P1_STATUS_ITEM";

Type:

• string

Default Value:

• "metric"

Example

Get or set option mapUnitSystem after initialization.

// get
var value = apex.region( "myRegionId" ).mapUnitSystem;
// set
apex.region( "myRegionId" ).mapUnitSystem = "metric";

Type:

• Object

Properties:

Example

Get or set option navigationBar after initialization.

// get
var value = apex.region( "myRegionId" ).navigationBar;
// set
apex.region( "myRegionId" ).navigationBar = { type: "full", position: "top-right" };

Type:

• boolean

Default Value:

• false

Example

Get option resetMapPosition after initialization.

var value = apex.region( "myRegionId" ).resetMapPosition;

Type:

• Object

Properties:

Example

Get or set option tileLayer after initialization.

// get
var value = apex.region( "myRegionId" ).tileLayer;
// set
apex.region( "myRegionId" ).tileLayer = { name: "osm-bright", darkmodeName: "osm-dark-matter" };

Type:

• string

Overrides:

• region#type

Type:

• boolean

Default Value:

• false

Example

Get option useVectorTileLayers after initialization.

var value = apex.region( "myRegionId" ).useVectorTileLayers;

Properties:

Example

Bind an event listener to the spatialmapchanged event:

$( ".selector" ).on( "spatialmapchanged", function( event, data ) {
    // do something with data.changeType, data.layers, data.bbox, data.zoom, data.pitch, data.bearing and data.circle
} );

Properties:

Example

Bind an event listener to the spatialmapclick event:

$( ".selector" ).on( "spatialmapclick", function( event, data ) {
    // do something with data.lat and data.lng
} );

Properties:

Example

Bind an event listener to the spatialmapinitialized event:

$( ".selector" ).on( "spatialmapinitialized", function() {
    // do something when map region is initialized
} );

Properties:

Example

Bind an event listener to the spatialmapobjectclick event:

$( ".selector" ).on( "spatialmapobjectclick", function( event, data ) {
    // do something with data.id, data.lat, data.lng, data.tooltip, data.infoWindow, data.cluster_id and data.point_count
} );

Parameters:

Example

This example add a new feature to the map.

apex.region( "regionId" ).addFeature( 
  apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), 
  {
    id: "6tgy767836",
    geometry: {
      type: "Point",
      coordinates: [ -108.852, 15.8821667 ]
    },
    infoWindow: {
      title: "Title text",
      body: "Body text"
    },
    tooltip: "Tooltip text"
  } 
);

Example

This example removes the circle drawn with the circle tool.

apex.region( "regionId" ).clearCircle();

Parameters:

Examples

This example close all opened info window pop-ups.

apex.region( "regionId" ).closeAllInfoWindows();

This example close all opened info window pop-ups, but only from the specified layer

apex.region( "regionId" ).closeAllInfoWindows( apex.region( "regionId" ).getLayerIdByName( "earthquakes" ) );

Parameters:

Example

This example close the specified info window pop-up.

apex.region( "regionId" ).closeInfoWindow( apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "6tgy767836" );

Example

This example close the tooltip pop-up.

apex.region( "regionId" ).closeTooltip();

Parameters:

Examples

This example display the tooltip pop-up.

apex.region( "regionId" ).displayPopup( "tooltip", apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "6tgy767836" );

This example display the info window pop-up. This pop-up will not be focused after open.

apex.region( "regionId" ).displayPopup( "infoWindow", apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "6tgy767836", false );

This example display the info window pop-up on a polygon at the specified position.

apex.region( "regionId" ).displayPopup( "infoWindow", apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "8jd4760465", false, { lng: 0, lat: 0 } );

Overrides:

• region#focus

Example

This example focus the map.

apex.region( "regionId" ).focus();

Returns:

Type

Object

Example

This example gets the current circle drawn with circle tool.

apex.region( "regionId" ).getCircle();

Parameters:

Returns:

Type

Object

Example

This example gets the specified feature object.

apex.region( "regionId" ).getFeature( apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "0i97th6465" );

Parameters:

Returns:

Type

number

Example

This example gets the id of the specified layer.

apex.region( "regionId" ).getLayerIdByName( "earthquakes" );

Returns:

Type

Array.<Object>

Example

This example gets all the layers objects.

apex.region( "regionId" ).getLayers();

Returns:

Type

Object

Example

This example gets the current map window BBOX and the zoom level in one object.

apex.region( "regionId" ).getMapBboxAndZoomLevel();

Returns:

Type

Object

Example

This example gets the current map center and the zoom level in one object.

apex.region( "regionId" ).getMapCenterAndZoomLevel();

Returns:

Type

Object

Example

This example gets the maplibre map object.

apex.region( "regionId" ).getMapObject();

Returns:

Type

Object

Example

This example gets the map pitch and bearing properties in one object.

apex.region( "regionId" ).getMapPitchAndBearing();

Returns:

Type

Object

Example

This example gets the current map bbox, zoom level, pitch and bearing values in one object.

apex.region( "regionId" ).getMapStatus();

Parameters:

Inherited From:

• region#off

Example

This example removes all event handlers for the selectionChange event of an Interactive Grid region. Note that the short event name "selectionChange" can be used rather than the full name "interactivegridselectionchange". See also interactiveGrid#event:selectionchange.

apex.region( interactiveGridRegionId ).off( "selectionChange" );

Parameters:

Inherited From:

• region#on

Example

This example handles the selectionChange event of an Interactive Grid region by logging a message to the console. Note that the short event name "selectionChange" can be used rather than the full name "interactivegridselectionchange". See also interactiveGrid#event:selectionchange

apex.region( interactiveGridRegionId ).on( "selectionChange", function(event, data) {
    console.log("Selection changed; # records selected is", data.selectedRecords.length );
} );

Overrides:

• region#refresh

Example

This example make an ajax request to server to update layers data.

apex.region( "regionId" ).refresh();

Parameters:

Example

This example removes the specified feature from the map.

apex.region( "regionId" ).removeFeature( apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), "8jd4760465" );

Example

This example resets the map instance.

apex.region( "regionId" ).reset();

Parameters:

Example

This example centers the map to Washington, D.C.

var lng = -77.050636,
    lat = 38.889248;
apex.region( "regionId" ).setCenter( [ lng, lat ] );

Parameters:

Example

This example sets the zoom level to 3.

apex.region( "regionId" ).setZoomLevel( 3 );

Parameters:

Example

This example update the specified feature from series in the map.

apex.region( "regionId" ).updateFeature( 
  apex.region( "regionId" ).getLayerIdByName( "earthquakes" ), 
  {
    id: "6tgy767836",
    geometry: {
      type: "Point",
      coordinates: [ -128.852, 55.8821667 ]
    },
    infoWindow: {
      title: "My info window title",
      body: "My info window body"
    },
    tooltip: "My tooltip content"
  } 
);