MapOptions

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

Index

Properties

• actions
• backend
• choropleth
• clustering
• colors
• colorsIgnore
• containers
• controls
• css
• cursor
• data_objects
• data_regions
• database
• db_map_id
• defaultMarkerImage
• detailsView
• disableAll
• events
• extension
• filters
• filtersSchema
• fitMarkers
• fitMarkersOnStart
• fitSingleMarkerZoom
• galleries
• googleMaps
• groups
• height
• id
• inBackend
• labelsMarkers
• labelsRegions
• layersControl
• loadingText
• lockAspectRatio
• markerLastID
• menu
• middlewares
• mobileView
• multiSelect
• padding
• popovers
• previousMapsIds
• regionChoroplethField
• regionPrefix
• regionStatuses
• regions
• responsive
• scroll
• source
• svgData
• svgFileVersion
• templates
• title
• tooltips
• viewBox
• width
• zoom

Properties

optionalactions

actions?: { directoryItem: { click: {}; hover: {}; mouseout: {}; touch: {} }; map: { afterLoad: { selectMarker: boolean; selectRegion: boolean } }; marker: { click: {}; mouseout: {}; mouseover: { showTooltip: boolean }; touch: {} }; region: { click: {}; mouseout: {}; mouseover: { showTooltip: boolean }; touch: {} } }

Type declaration

• directoryItem: { click: {}; hover: {}; mouseout: {}; touch: {} }

  • click: {}

    • [key string]: any

  • hover: {}

    • [key string]: any

  • mouseout: {}

    • [key string]: any

  • touch: {}

    • [key string]: any

• map: { afterLoad: { selectMarker: boolean; selectRegion: boolean } }

  • afterLoad: { selectMarker: boolean; selectRegion: boolean }

    • selectMarker: boolean

    • selectRegion: boolean

• marker: { click: {}; mouseout: {}; mouseover: { showTooltip: boolean }; touch: {} }

  • click: {}

    • [key string]: any

  • mouseout: {}

    • [key string]: any

  • mouseover: { showTooltip: boolean }

    • [key string]: any

    • showTooltip: boolean

  • touch: {}

    • [key string]: any

• region: { click: {}; mouseout: {}; mouseover: { showTooltip: boolean }; touch: {} }

  • click: {}

    • [key string]: any

  • mouseout: {}

    • [key string]: any

  • mouseover: { showTooltip: boolean }

    • [key string]: any

    • showTooltip: boolean

  • touch: {}

    • [key string]: any

optionalbackend

backend?: boolean

optionalchoropleth

choropleth?: ChoroplethOptions

optionalclustering

clustering?: { on: boolean }

Type declaration

• on: boolean

optionalcolors

colors?: ColorsOptions

optionalcolorsIgnore

colorsIgnore?: boolean

optionalcontainers

containers?: { footer: { height: string; on: boolean; width: string }; header: { height: string; on: boolean; width: string }; leftSidebar: { height: string; on: boolean; width: string }; rightSidebar: { height: string; on: boolean; width: string } }

Type declaration

• footer: { height: string; on: boolean; width: string }

  • height: string

  • on: boolean

  • width: string

• header: { height: string; on: boolean; width: string }

  • height: string

  • on: boolean

  • width: string

• leftSidebar: { height: string; on: boolean; width: string }

  • height: string

  • on: boolean

  • width: string

• rightSidebar: { height: string; on: boolean; width: string }

  • height: string

  • on: boolean

  • width: string

optionalcontrols

controls?: ControlsOptions

optionalcss

css?: string

optionalcursor

cursor?: string

optionaldata_objects

data_objects?: any

optionaldata_regions

data_regions?: any

optionaldatabase

database?: DatabaseOptions

optionaldb_map_id

db_map_id?: string | number

optionaldefaultMarkerImage

defaultMarkerImage?: string

optionaldetailsView

detailsView?: { autoresize: boolean; containerId: string; location: map | leftSidebar | rightSidebar | header | footer | custom | fullscreen; margin: string; mobileFullscreen: boolean; width: string }

Type declaration

• autoresize: boolean

• containerId: string

• location: map | leftSidebar | rightSidebar | header | footer | custom | fullscreen

• margin: string

• mobileFullscreen: boolean

• width: string

optionaldisableAll

disableAll?: boolean

optionalevents

events?: {}

Type declaration

• [key string]: string

optionalextension

extension?: any

optionalfilters

filters?: FilterOptions

optionalfiltersSchema

filtersSchema?: SchemaField[]

optionalfitMarkers

fitMarkers?: boolean

optionalfitMarkersOnStart

fitMarkersOnStart?: boolean

optionalfitSingleMarkerZoom

fitSingleMarkerZoom?: number

optionalgalleries

galleries?: ArrayIndexed<GalleryOptionsInterface>

optionalgoogleMaps

googleMaps?: { apiKey: string; center: GeoPoint; drawingTools?: boolean; geometry?: boolean; language: string; minZoom: number; on: boolean; zoom: number }

Type declaration

• apiKey: string

• center: GeoPoint

• optionaldrawingTools?: boolean

• optionalgeometry?: boolean

• language: string

• minZoom: number

• on: boolean

• zoom: number

optionalgroups

groups?: ArrayIndexed<GroupOptionsInterface>

optionalheight

height?: number

id

id: number

optionalinBackend

inBackend?: boolean

optionallabelsMarkers

labelsMarkers?: { on: boolean }

Type declaration

• on: boolean

optionallabelsRegions

labelsRegions?: { on: boolean }

Type declaration

• on: boolean

optionallayersControl

layersControl?: LayersControlOptionsInterface

optionalloadingText

loadingText?: string

optionallockAspectRatio

lockAspectRatio?: boolean

optionalmarkerLastID

markerLastID?: number

optionalmenu

menu?: DirectoryOptions

optionalmiddlewares

middlewares?: { mapLoad: string; render: string; request: string; response: string }

Type declaration

• mapLoad: string

• render: string

• request: string

• response: string

optionalmobileView

mobileView?: {}

Type declaration

• [key string]: any

optionalmultiSelect

multiSelect?: boolean

optionalpadding

padding?: { bottom: number; left: number; right: number; top: number }

Type declaration

• bottom: number

• left: number

• right: number

• top: number

optionalpopovers

popovers?: PopoversOptions

optionalpreviousMapsIds

previousMapsIds?: (string | number)[]

optionalregionChoroplethField

regionChoroplethField?: string

optionalregionPrefix

regionPrefix?: string

optionalregionStatuses

regionStatuses?: Record<string, { color: string; disabled: boolean; label: string; value: string }>

optionalregions

regions?: { disabled: boolean; fill: string; id: string; title: string }[]

optionalresponsive

responsive?: boolean

optionalscroll

scroll?: ScrollOptions

optionalsource

source?: string

optionalsvgData

svgData?: string

optionalsvgFileVersion

svgFileVersion?: number

optionaltemplates

templates?: { detailsView: string; detailsViewRegion: string; directory: string; directoryItem: string; labelRegion: string; popoverMarker: string; popoverRegion: string; tooltipMarker: string; tooltipRegion: string }

Type declaration

• detailsView: string

• detailsViewRegion: string

• directory: string

• directoryItem: string

• labelRegion: string

• popoverMarker: string

• popoverRegion: string

• tooltipMarker: string

• tooltipRegion: string

optionaltitle

title?: string

optionaltooltips

tooltips?: TooltipsOptions

optionalviewBox

viewBox?: number[]

optionalwidth

width?: number

optionalzoom

zoom?: ZoomOptions

Zoom