Skip to content
HomeDemosDocsChangelogPricing
Log In
Get MapSVG
MapSVG 8/Documentation

MapOptions

Interface: MapOptions

Section titled “Interface: MapOptions”

MapOptions interface is used to control the correct types of map options, passed during the initialization of the map or updating it.

Properties

Section titled “Properties”

actions?

Section titled “actions?”
optional actions: object;

directoryItem

Section titled “directoryItem”
directoryItem: object;
directoryItem.click
Section titled “directoryItem.click”
click: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
directoryItem.hover
Section titled “directoryItem.hover”
hover: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
directoryItem.mouseout
Section titled “directoryItem.mouseout”
mouseout: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
directoryItem.touch
Section titled “directoryItem.touch”
touch: object;
Index Signature
Section titled “Index Signature”
[key: string]: any

map

Section titled “map”
map: object;
map.afterLoad
Section titled “map.afterLoad”
afterLoad: object;
map.afterLoad.selectMarker
Section titled “map.afterLoad.selectMarker”
selectMarker: boolean;
map.afterLoad.selectRegion
Section titled “map.afterLoad.selectRegion”
selectRegion: boolean;

marker

Section titled “marker”
marker: object;
marker.click
Section titled “marker.click”
click: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
marker.mouseout
Section titled “marker.mouseout”
mouseout: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
marker.mouseover
Section titled “marker.mouseover”
mouseover: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
marker.mouseover.showTooltip
Section titled “marker.mouseover.showTooltip”
showTooltip: boolean;
marker.touch
Section titled “marker.touch”
touch: object;
Index Signature
Section titled “Index Signature”
[key: string]: any

region

Section titled “region”
region: object;
region.click
Section titled “region.click”
click: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
region.mouseout
Section titled “region.mouseout”
mouseout: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
region.mouseover
Section titled “region.mouseover”
mouseover: object;
Index Signature
Section titled “Index Signature”
[key: string]: any
region.mouseover.showTooltip
Section titled “region.mouseover.showTooltip”
showTooltip: boolean;
region.touch
Section titled “region.touch”
touch: object;
Index Signature
Section titled “Index Signature”
[key: string]: any

backend?

Section titled “backend?”
optional backend: boolean;

choropleth?

Section titled “choropleth?”
optional choropleth: ChoroplethOptions;

clustering?

Section titled “clustering?”
optional clustering: object;

on

Section titled “on”
on: boolean;

colors?

Section titled “colors?”
optional colors: ColorsOptions;

colorsIgnore?

Section titled “colorsIgnore?”
optional colorsIgnore: boolean;

containers?

Section titled “containers?”
optional containers: object;
Section titled “footer”
footer: object;
footer.height
Section titled “footer.height”
height: string;
footer.on
Section titled “footer.on”
on: boolean;
footer.width
Section titled “footer.width”
width: string;
Section titled “header”
header: object;
header.height
Section titled “header.height”
height: string;
header.on
Section titled “header.on”
on: boolean;
header.width
Section titled “header.width”
width: string;
Section titled “leftSidebar”
leftSidebar: object;
leftSidebar.height
Section titled “leftSidebar.height”
height: string;
leftSidebar.on
Section titled “leftSidebar.on”
on: boolean;
leftSidebar.width
Section titled “leftSidebar.width”
width: string;
Section titled “rightSidebar”
rightSidebar: object;
rightSidebar.height
Section titled “rightSidebar.height”
height: string;
rightSidebar.on
Section titled “rightSidebar.on”
on: boolean;
rightSidebar.width
Section titled “rightSidebar.width”
width: string;

controls?

Section titled “controls?”
optional controls: ControlsOptions;

css?

Section titled “css?”
optional css: string;

cursor?

Section titled “cursor?”
optional cursor: string;

data_objects?

Section titled “data_objects?”
optional data_objects: any;

data_regions?

Section titled “data_regions?”
optional data_regions: any;

database?

Section titled “database?”
optional database: DatabaseOptions;

db_map_id?

Section titled “db_map_id?”
optional db_map_id: string | number;

defaultMarkerImage?

Section titled “defaultMarkerImage?”
optional defaultMarkerImage: string;

detailsView?

Section titled “detailsView?”
optional detailsView: object;

autoresize

Section titled “autoresize”
autoresize: boolean;

containerId

Section titled “containerId”
containerId: string;

location

Section titled “location”
location:
  | "map"
  | "custom"
  | "leftSidebar"
  | "rightSidebar"
  | "header"
  | "footer"
  | "fullscreen";

margin

Section titled “margin”
margin: string;

mobileFullscreen

Section titled “mobileFullscreen”
mobileFullscreen: boolean;

width

Section titled “width”
width: string;

disableAll?

Section titled “disableAll?”
optional disableAll: boolean;

events?

Section titled “events?”
optional events: object;

Index Signature

Section titled “Index Signature”
[key: string]: string

extension?

Section titled “extension?”
optional extension: any;

filters?

Section titled “filters?”
optional filters: FilterOptions;

filtersSchema?

Section titled “filtersSchema?”
optional filtersSchema: SchemaField[];

fitMarkers?

Section titled “fitMarkers?”
optional fitMarkers: boolean;

fitMarkersOnStart?

Section titled “fitMarkersOnStart?”
optional fitMarkersOnStart: boolean;

fitSingleMarkerZoom?

Section titled “fitSingleMarkerZoom?”
optional fitSingleMarkerZoom: number;

galleries?

Section titled “galleries?”
optional galleries: ArrayIndexed<GalleryOptionsInterface>;

googleMaps?

Section titled “googleMaps?”
optional googleMaps: object;

apiKey

Section titled “apiKey”
apiKey: string;

center

Section titled “center”
center: GeoPoint;

drawingTools?

Section titled “drawingTools?”
optional drawingTools: boolean;

geometry?

Section titled “geometry?”
optional geometry: boolean;

language

Section titled “language”
language: string;

minZoom

Section titled “minZoom”
minZoom: number;

on

Section titled “on”
on: boolean;

zoom

Section titled “zoom”
zoom: number;

groups?

Section titled “groups?”
optional groups: ArrayIndexed<GroupOptionsInterface>;

height?

Section titled “height?”
optional height: number;

id

Section titled “id”
id: number;

inBackend?

Section titled “inBackend?”
optional inBackend: boolean;

labelsMarkers?

Section titled “labelsMarkers?”
optional labelsMarkers: object;

on

Section titled “on”
on: boolean;

labelsRegions?

Section titled “labelsRegions?”
optional labelsRegions: object;

on

Section titled “on”
on: boolean;

layersControl?

Section titled “layersControl?”
optional layersControl: LayersControlOptionsInterface;

loadingText?

Section titled “loadingText?”
optional loadingText: string;

lockAspectRatio?

Section titled “lockAspectRatio?”
optional lockAspectRatio: boolean;

markerLastID?

Section titled “markerLastID?”
optional markerLastID: number;
Section titled “menu?”
optional menu: DirectoryOptions;

middlewares?

Section titled “middlewares?”
optional middlewares: object;

mapLoad

Section titled “mapLoad”
mapLoad: string;

render

Section titled “render”
render: string;

request

Section titled “request”
request: string;

response

Section titled “response”
response: string;

mobileView?

Section titled “mobileView?”
optional mobileView: object;

Index Signature

Section titled “Index Signature”
[key: string]: any

multiSelect?

Section titled “multiSelect?”
optional multiSelect: boolean;

padding?

Section titled “padding?”
optional padding: object;

bottom

Section titled “bottom”
bottom: number;

left

Section titled “left”
left: number;
Section titled “right”
right: number;

top

Section titled “top”
top: number;

popovers?

Section titled “popovers?”
optional popovers: PopoversOptions;

previousMapsIds?

Section titled “previousMapsIds?”
optional previousMapsIds: (string | number)[];

regionChoroplethField?

Section titled “regionChoroplethField?”
optional regionChoroplethField: string;

regionPrefix?

Section titled “regionPrefix?”
optional regionPrefix: string;

regions?

Section titled “regions?”
optional regions: RegionOptionsCollection;

regionStatuses?

Section titled “regionStatuses?”
optional regionStatuses: RegionStatusOptionsCollection;

responsive?

Section titled “responsive?”
optional responsive: boolean;

scroll?

Section titled “scroll?”
optional scroll: ScrollOptions;

source?

Section titled “source?”
optional source: string;

svgData?

Section titled “svgData?”
optional svgData: string;

svgFileVersion?

Section titled “svgFileVersion?”
optional svgFileVersion: number;

templates?

Section titled “templates?”
optional templates: object;

detailsView

Section titled “detailsView”
detailsView: string;

detailsViewRegion

Section titled “detailsViewRegion”
detailsViewRegion: string;

directory

Section titled “directory”
directory: string;

directoryItem

Section titled “directoryItem”
directoryItem: string;

labelRegion

Section titled “labelRegion”
labelRegion: string;

popoverMarker

Section titled “popoverMarker”
popoverMarker: string;

popoverRegion

Section titled “popoverRegion”
popoverRegion: string;

tooltipMarker

Section titled “tooltipMarker”
tooltipMarker: string;

tooltipRegion

Section titled “tooltipRegion”
tooltipRegion: string;

title?

Section titled “title?”
optional title: string;

tooltips?

Section titled “tooltips?”
optional tooltips: TooltipsOptions;

viewBox?

Section titled “viewBox?”
optional viewBox: number[];

width?

Section titled “width?”
optional width: number;

zoom?

Section titled “zoom?”
optional zoom: ZoomOptions;

Zoom