MapsvgClient

Client class, globally available as mapsvg or window.mapsvg. It contains all of the classes and utilities. Example usage:

// Init objects
const map = new mapsvg.map(...)
const location = new mapsvg.location(...)

// Get map
const map = mapsvg.getById(12)

// Use utilities
if(mapsvg.utils.env.isPhone()) {
  // do something for mobile devices
}

const capitalizedString = map.utils.strings.ucfirst("orange") // > Orange

Hierarchy

Mapsvg
- MapsvgClient

Constructors

constructor

new MapsvgClient(): MapsvgClient

Overrides Mapsvg.constructor
Returns MapsvgClient

Properties

ResizeSensor

ResizeSensor: typeof ResizeSensor = ResizeSensor

_nonce

_nonce: string

arrayIndexed

arrayIndexed: typeof ArrayIndexed = ArrayIndexed

customObject

customObject: typeof Model = Model

defaultMarkerImage

defaultMarkerImage: string

distanceSearch

distanceSearch: any

formBuilder

formBuilder: typeof FormBuilder = FormBuilder

geoPoint

geoPoint: typeof GeoPoint = GeoPoint

googleMaps

googleMaps: { apiIsLoading: boolean; apiKey: string; loaded: boolean; onLoadCallbacks: () => void[] }

Type declaration

apiIsLoading: boolean
apiKey: string
loaded: boolean
onLoadCallbacks: () => void[]

googleMapsApiLoaded

googleMapsApiLoaded: boolean = false

google_maps_api_key

google_maps_api_key: string

initialized

initialized: boolean

instances

instances: MapSVGMap[]

loaded

loaded: boolean = false

location

location: typeof Location = Location

map

map: typeof MapSVGMap = MapSVGMap

mapsRepository

mapsRepository: typeof MapsRepository = MapsRepository

mapsV2Repository

mapsV2Repository: typeof MapsV2Repository = MapsV2Repository

marker

marker: typeof Marker = Marker

markerImages

markerImages: { file: string; folder: string; relativeUrl?: string; url: string }[]

mediaUploader

mediaUploader: any

mouse

mouse: { x: number; y: number } = ...

Type declaration

x: number
y: number

query

query: typeof Query = Query

region

region: typeof Region = Region

repository

repository: typeof Repository = Repository

routes

routes: MapsvgRoutes

schema

schema: typeof Schema = Schema

schemaRepository

schemaRepository: typeof SchemaRepository = SchemaRepository

screenPoint

screenPoint: typeof ScreenPoint = ScreenPoint

server

server: typeof Server = Server

svgPoint

svgPoint: new (x?: number, y?: number, z?: number, w?: number) => DOMPoint = SVGPoint

Type declaration

- new (x?: number, y?: number, z?: number, w?: number): DOMPoint
- Parameters
  - optionalx: number
  - optionaly: number
  - optionalz: number
  - optionalw: number
  Returns DOMPoint

templatesLoaded

templatesLoaded: Record<string, boolean> = {}

useRepository

useRepository: { (name: regions | SchemaOptions, map: MapSVGMap): Repository; (name: SchemaOptions | objects, map: MapSVGMap): Repository; (name: SchemaOptions | schemas, map: MapSVGMap): SchemaRepository; (name: SchemaOptions | maps, map: MapSVGMap): MapsRepository }

Type declaration

- (name: regions | SchemaOptions, map: MapSVGMap): Repository
- (name: SchemaOptions | objects, map: MapSVGMap): Repository
- (name: SchemaOptions | schemas, map: MapSVGMap): SchemaRepository
- (name: SchemaOptions | maps, map: MapSVGMap): MapsRepository
- Parameters
  - name: regions | SchemaOptions
  - map: MapSVGMap
  Returns Repository
- Parameters
  - name: SchemaOptions | objects
  - map: MapSVGMap
  Returns Repository
- Parameters
  - name: SchemaOptions | schemas
  - map: MapSVGMap
  Returns SchemaRepository
- Parameters
  - name: SchemaOptions | maps
  - map: MapSVGMap
  Returns MapsRepository

utils

utils: { env: { getBrowser: () => { firefox: boolean; ie: boolean; safari: boolean }; getDevice: () => { android: boolean; ios: boolean }; getMouseCoords: (e: any) => { x: number; y: number }; getUserAgent: () => string; isMac: () => boolean; isPhone: () => boolean }; files: { getFileType: (url: any) => JS | CSS | Unknown; loadFile: (file: any) => Promise<unknown>; loadFiles: (files: any) => Promise<any[]> }; funcs: { geocode: (query: any, callback: any) => boolean; throttle: (method: any, delay: any, scope: any, params: any) => void }; http: { handleFailedRequest: (response: any) => void }; numbers: { compareVersions: (v1: any, v2: any) => -1 | 0 | 1; isNumber: (n: any) => boolean; parseBoolean: (string: any) => boolean }; strings: { convertToText: (obj: any) => any; fixColorHash: (color: string) => string; functionFromString: Object; removeLeadingSlash: (str: any) => any; safeURL: (url: any) => any; toSnakeCase: (str: string) => string; ucfirst: (string: any) => any } } = utils

Type declaration

env: { getBrowser: () => { firefox: boolean; ie: boolean; safari: boolean }; getDevice: () => { android: boolean; ios: boolean }; getMouseCoords: (e: any) => { x: number; y: number }; getUserAgent: () => string; isMac: () => boolean; isPhone: () => boolean }
- getBrowser: () => { firefox: boolean; ie: boolean; safari: boolean }
  - - (): { firefox: boolean; ie: boolean; safari: boolean }
    - Returns { firefox: boolean; ie: boolean; safari: boolean }
      - firefox: boolean
      - ie: boolean
      - safari: boolean
- getDevice: () => { android: boolean; ios: boolean }
  - - (): { android: boolean; ios: boolean }
    - Returns { android: boolean; ios: boolean }
      - android: boolean
      - ios: boolean
- getMouseCoords: (e: any) => { x: number; y: number }
  - - (e: any): { x: number; y: number }
    - Parameters
      - e: any
      Returns { x: number; y: number }
      - x: number
      - y: number
- getUserAgent: () => string
  - - (): string
    - Returns string
- isMac: () => boolean
  - - (): boolean
    - Returns boolean
- isPhone: () => boolean
  - - (): boolean
    - Returns boolean
files: { getFileType: (url: any) => JS | CSS | Unknown; loadFile: (file: any) => Promise<unknown>; loadFiles: (files: any) => Promise<any[]> }
- getFileType: (url: any) => JS | CSS | Unknown
  - - (url: any): JS | CSS | Unknown
    - Parameters
      - url: any
      Returns JS | CSS | Unknown
- loadFile: (file: any) => Promise<unknown>
  - - (file: any): Promise<unknown>
    - Parameters
      - file: any
      Returns Promise<unknown>
- loadFiles: (files: any) => Promise<any[]>
  - - (files: any): Promise<any[]>
    - Parameters
      - files: any
      Returns Promise<any[]>
funcs: { geocode: (query: any, callback: any) => boolean; throttle: (method: any, delay: any, scope: any, params: any) => void }
- geocode: (query: any, callback: any) => boolean
  - - (query: any, callback: any): boolean
    - Parameters
      - query: any
      - callback: any
      Returns boolean
- throttle: (method: any, delay: any, scope: any, params: any) => void
  - - (method: any, delay: any, scope: any, params: any): void
    - Parameters
      - method: any
      - delay: any
      - scope: any
      - params: any
      Returns void
http: { handleFailedRequest: (response: any) => void }
- handleFailedRequest: (response: any) => void
  - - (response: any): void
    - Parameters
      - response: any
      Returns void
numbers: { compareVersions: (v1: any, v2: any) => -1 | 0 | 1; isNumber: (n: any) => boolean; parseBoolean: (string: any) => boolean }
- compareVersions: (v1: any, v2: any) => -1 | 0 | 1
  - - (v1: any, v2: any): -1 | 0 | 1
    - Parameters
      - v1: any
      - v2: any
      Returns -1 | 0 | 1
- isNumber: (n: any) => boolean
  - - (n: any): boolean
    - Parameters
      - n: any
      Returns boolean
- parseBoolean: (string: any) => boolean
  - - (string: any): boolean
    - Parameters
      - string: any
      Returns boolean
strings: { convertToText: (obj: any) => any; fixColorHash: (color: string) => string; functionFromString: Object; removeLeadingSlash: (str: any) => any; safeURL: (url: any) => any; toSnakeCase: (str: string) => string; ucfirst: (string: any) => any }
- convertToText: (obj: any) => any
  - - (obj: any): any
    - Parameters
      - obj: any
      Returns any
- fixColorHash: (color: string) => string
  - - (color: string): string
    - Parameters
      - color: string
      Returns string
- functionFromString: Object
- removeLeadingSlash: (str: any) => any
  - - (str: any): any
    - Parameters
      - str: any
      Returns any
- safeURL: (url: any) => any
  - - (url: any): any
    - Parameters
      - url: any
      Returns any
- toSnakeCase: (str: string) => string
  - - (str: string): string
    - Parameters
      - str: string
      Returns string
- ucfirst: (string: any) => any
  - - (string: any): any
    - Parameters
      - string: any
      Returns any

version

version: string = "process.env.VERSION"

staticinitialized

initialized: boolean = false

Accessors

googleMapsApiKey

get googleMapsApiKey(): string

Inherited from Mapsvg.googleMapsApiKey
Returns string

nonce

get nonce(): string
set nonce(_nonce: string): void

Inherited from Mapsvg.nonce
Returns string
Inherited from Mapsvg.nonce
Parameters
- _nonce: string
Returns void

Methods

addInstance

addInstance(mapsvg: any): void

Inherited from Mapsvg.addInstance
Parameters
- mapsvg: any
Returns void

extend

extend(sub: any, base: any): void

Inherited from Mapsvg.extend
Parameters
- sub: any
- base: any
Returns void

extendBuiltins

extendBuiltins(): void

Inherited from Mapsvg.extendBuiltins
Returns void

get

get(index: any): MapSVGMap

Inherited from Mapsvg.get
Parameters
- index: any
Returns MapSVGMap

getByContainerId

getByContainerId(id: any): MapSVGMap

Inherited from Mapsvg.getByContainerId
Parameters
- id: any
Returns MapSVGMap

getById

getById(id: any): MapSVGMap

Inherited from Mapsvg.getById
Parameters
- id: any
Returns MapSVGMap

init

init(options: MapsvgFrontendParams): Promise<void>

Inherited from Mapsvg.init
Parameters
- options: MapsvgFrontendParams
Returns Promise<void>

lazyLoadMap

lazyLoadMap(container: HTMLElement): void

Inherited from Mapsvg.lazyLoadMap
Parameters
- container: HTMLElement
Returns void

loadMap

loadMap(container: HTMLElement): void

Inherited from Mapsvg.loadMap
Parameters
- container: HTMLElement
Returns void

loadMaps

loadMaps(): void

Inherited from Mapsvg.loadMaps
Returns void

receiveMessageFromIframe

receiveMessageFromIframe(event: any): void

Inherited from Mapsvg.receiveMessageFromIframe
Parameters
- event: any
Returns void

setEventHandlers

setEventHandlers(): void

Inherited from Mapsvg.setEventHandlers
Returns void

unloadMaps

unloadMaps(): void

Inherited from Mapsvg.unloadMaps
Returns void

staticinitialize

initialize(options: MapsvgFrontendParams): void

Inherited from Mapsvg.initialize
Parameters
- options: MapsvgFrontendParams
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MapsvgClient

Properties

ResizeSensor

_nonce

arrayIndexed

customObject

defaultMarkerImage

distanceSearch

formBuilder

geoPoint

googleMaps

Type declaration

apiIsLoading: boolean

apiKey: string

loaded: boolean

onLoadCallbacks: () => void[]

googleMapsApiLoaded

google_maps_api_key

initialized

instances

loaded

location

map

mapsRepository

mapsV2Repository

marker

markerImages

mediaUploader

meta

mouse

Type declaration

x: number

y: number

query

region

repository

routes

schema

schemaRepository

screenPoint

server

svgPoint

Type declaration

Parameters

optionalx: number

optionaly: number

optionalz: number

optionalw: number

Returns DOMPoint

templatesLoaded

useRepository

Type declaration

Parameters

name: regions | SchemaOptions

map: MapSVGMap

Returns Repository

Parameters

name: SchemaOptions | objects

map: MapSVGMap

Returns Repository

Parameters

name: SchemaOptions | schemas

map: MapSVGMap

Returns SchemaRepository

Parameters

name: SchemaOptions | maps

map: MapSVGMap

Returns MapsRepository

utils

Type declaration

env: { getBrowser: () => { firefox: boolean; ie: boolean; safari: boolean }; getDevice: () => { android: boolean; ios: boolean }; getMouseCoords: (e: any) => { x: number; y: number }; getUserAgent: () => string; isMac: () => boolean; isPhone: () => boolean }

getBrowser: () => { firefox: boolean; ie: boolean; safari: boolean }