GotMap-1.0.0.js
  • GotMapEngine

    • GotMap-1.0.0.js

    Namespace: GotMap

    Main GotMap file contains functionality for instantiating the map, managing layers and events

    GotMapEngine

    Object GotMapEngine
    Location: \GotMap-1.0.0.js, line: 70

    Container for all gotmap functionality, e.g. the namespace

    Requires:

    ControlPositions

    Object GotMapEngine.ControlPositions
    Location: \GotMap-1.0.0.js, line: 104

    Control positions (map corner to put a control to)

    Properties

    Name Datatype Description
    TopLeft string Top left of the map.
    TopRight string Top right of the map.
    BottomLeft string Bottom left of the map.
    BottomRight string Bottom right of the map.

    Options

    Object GotMapEngine.Options
    Location: \GotMap-1.0.0.js, line: 122

    Container for the map settings, all map instances get their own deep copy of this when they are created

    Properties

    Name Datatype Description
    DivId string READONLY Id of the div in which the map is displayed
    IconRootUrl string http url pointing to the location of default icons
    Mapengine string The background map layer
    DefaultLat double Latitude coordinate of the maps center point upon creation
    DefaultLng double longitude coordinate of the maps center point upon creation
    DefaultZoom int The zoom level the map will have upon creation
    MaxZoomLevel int The maximul allowed level to zoom to (only editable before creation)
    DisableClusteringAtZoom int Sets the zoom level att which to show the geometries instead of the cluster groups, set it to 0 to disable clustering.
    MaxClusterRadius int The maximum radius that a cluster will cover from the central marker (in pixels).

    MarkerOptions

    Object GotMap.Options.MarkerOptions
    Location: \GotMap-1.0.0.js, line: 149

    Container for the marker options

    Properties

    Name Datatype Description
    IconUrl string The name of the marker icon to use when drawing (the icon must be placed in the defined IconRootUrl in the Options)
    IconSize Array An array containing width and height of the icon image ex:[25, 41]
    IconAnchor Array An array containing the x and y coordinates of where the point of the marker icon is located. ex:[12, 41]
    PopupAnchor Array An array containing the x and y coordinates of where the popup should be located
    ShadowIconUrl string The name of the marker shadow icon to use when drawing (the icon must be placed in the defined IconRootUrl in the Options)
    ShadowSize Array An array containing width and height of the shadow icon image ex:[25, 30]
    ShadowAnchor: Array An array containing the x and y coordinates of where the point of the marker shadow icon is located. ex:[7, 30]
    Draggable bool Sets whether the marker should be draggable or not

    Style

    Object GotMap.Options.Style
    Location: \GotMap-1.0.0.js, line: 173

    Container for the default Style, full use of SVG styling is available for more information. See: http://www.w3.org/TR/SVG/styling.html
    NOTE: All SVG style options are not implemented into the geojson styling!

    Properties

    Name Datatype Description
    color string The default color of the drawn lines, polygons, circles and rectangles
    opacity double The opacity of polygons, circles and rectangles outlining
    fillColor string The color of the inside of polygons, circles and rectangles
    fillOpacity string The opacity of the inside polygons, circles and rectangles
    radius int The radius of a circle marker
    weight int The stroke width in pixels.

    DrawOptions

    Object GotMap.Options.DrawOptions
    Location: \GotMap-1.0.0.js, line: 220

    Container for the draw settings

    Properties

    Name Datatype Description
    Positions string Defines where the draw controls will be placed (Use GotMapEngine.ControlPositions)
    Line bool Enables / Disables the line drawing control
    Polygon bool Enables / Disables the polygon drawing control
    Marker bool Enables / Disables the marker drawing control
    Edit bool Enables / Disables the edit control
    Remove bool Enables / Disables the remove control, NOTE: Edit must be enabled when enabling Remove
    Color string The default color of the drawn lines, polygons, circles and rectangles
    Opacity string The opacity of polygons, circles and rectangles outlining
    FillColor string The color of the inside of polygons, circles and rectangles
    FillOpacity string The opacity of the inside polygons, circles and rectangles

    ScaleToolOptions

    Object GotMapEngine.Options.ScaleToolOptions
    Location: \GotMap-1.0.0.js, line: 244

    Container for the scale tool options

    Properties

    Name Datatype Description
    Enable bool Enables / Disables the tool
    Positions string Defines where the tool will be placed (Use GotMapEngine.ControlPositions)
    Maximum int width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500)
    Metric bool Whether to show the metric scale line (m/km).
    Imperial bool Whether to show the imperial scale line (mi/ft).

    WmsLayerDefinitions

    Object GotMapEngine.Options.WmsLayerDefinitions
    Location: \GotMap-1.0.0.js, line: 261

    Container for the added wmslayers.
    All layerdefinitions added to this before instantiate of the map will be automaticly added to the map.

    See WmsLayerDefinition for more info.

    GotMap

    function GotMapEngine.GotMap
    Location: \GotMap-1.0.0.js, line: 272

    Constructor for GotMap

    Parameters

    Name Datatype Description
    divId string The div in which the map will be displayed

    AddLegend

    function GotMapEngine.GotMap.AddLegend
    Location: \GotMap-1.0.0.js, line: 314

    Adds a legend container to the map.

    Parameters

    Name Datatype Description
    content string The Html which will be shown inside the legend container.
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    position GotMapEngine.ControlPositions Defines which corner to place the legend. See ControlPositions
    className string The name of the css class for the container.

    AddFindMeControl

    function GotMapEngine.GotMap.AddFindMeControl
    Location: \GotMap-1.0.0.js, line: 337

    Adds a find me button control to the map.

    Parameters

    Name Datatype Description
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    zoomLevel int Index of the zoom level to zoom to
    animate bool OPTIONAL Default false, Animates the paning
    setMarker bool OPTIONAL Default false, sets a marker on your position
    position GotMapEngine.ControlPositions Defines which corner to place the addfindmecontrol. See ControlPositions

    RestackFindMeControl

    function GotMapEngine.GotMap.RestackFindMeControl
    Location: \GotMap-1.0.0.js, line: 381

    Controls are stacked from the corner set in their position, this readds the control to the map so it sits last in the control stack

    AddStreetSearchControl

    function GotMapEngine.GotMap.AddStreetSearchControl
    Location: \GotMap-1.0.0.js, line: 426

    Adds a street search field control to the map
    Uses http://geocoder.tkgbg.se/ to find streets and addresses in Gothenburg.

    Requires:

    Parameters

    Name Datatype Description
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    position GotMapEngine.ControlPositions Which corner to place the control (default topleft).
    useMarkers bool Flag whether to user markers, will render points as circles if false.

    GetZoom

    function GotMapEngine.GotMap.GetZoom
    Location: \GotMap-1.0.0.js, line: 636

    Fetches the maps current zoom level index

    Returns: int Index of the maps current zoom level

    SetZoom

    function GotMapEngine.GotMap.SetZoom
    Location: \GotMap-1.0.0.js, line: 643

    Zooms the map to a desired zoom level

    Parameters

    Name Datatype Description
    zoomLevel int Index of the desired zoom level

    ZoomPanToLatLng

    function GotMapEngine.GotMap.ZoomPanToLatLng
    Location: \GotMap-1.0.0.js, line: 654

    Pans the map to a specified point and zooms to the desired zoom level

    Parameters

    Name Datatype Description
    lat double Latitude coordinate to pan to
    lng double Longitude coordinate to pan to
    options object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    zoomLevel int Index of the zoom level to zoom to
    animated bool Default false, Animates the paning

    AddMeasureControl

    function GotMapEngine.GotMap.AddMeasureControl
    Location: \GotMap-1.0.0.js, line: 672

    Adds a measure tool to the map

    Requires:

    Parameters

    Name Datatype Description
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    position GotMapEngine.ControlPositions Defines which corner to place the legend. See ControlPositions

    RestackMeasureControl

    function GotMapEngine.GotMap.RestackMeasureControl
    Location: \GotMap-1.0.0.js, line: 719

    Controls are stacked from the corner set in their position, this readds the control to the map so it sits last in the control stack

    AddScaleControl

    function GotMapEngine.GotMap.AddScaleControl
    Location: \GotMap-1.0.0.js, line: 734

    Adds a scale control to the map

    Parameters

    Name Datatype Description
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    position Options.ScaleToolOptions.Position Which corner to place the control
    maxWidth Options.ScaleToolOptions.MaxWidth What size of the scale control
    metric Options.ScaleToolOptions.Metric Flag for showing metric
    imperial Options.ScaleToolOptions.Imperial Flag for showing imperial

    RestackScaleControl

    function GotMapEngine.GotMap.RestackScaleControl
    Location: \GotMap-1.0.0.js, line: 748

    Controls are stacked from the corner set in their position, this readds the control to the map so it sits last in the control stack

    RestackZoomControl

    function GotMapEngine.GotMap.RestackZoomControl
    Location: \GotMap-1.0.0.js, line: 758

    Controls are stacked from the corner set in their position, this readds the control to the map so it sits last in the control stack

    AddLayerToLayersControl

    function GotMapEngine.GotMap.AddLayerToLayersControl
    Location: \GotMap-1.0.0.js, line: 771

    Adds a layer to the layercontrol

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    RemoveLayerFromLayersControl

    function GotMapEngine.GotMap.RemoveLayerFromLayersControl
    Location: \GotMap-1.0.0.js, line: 783

    Adds a layer to the layercontrol

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    RestackLayersControl

    function GotMapEngine.GotMap.RestackLayersControl
    Location: \GotMap-1.0.0.js, line: 794

    Controls are stacked from the corner set in their position, this readds the control to the map so it sits last in the control stack

    LayerManager

    Object GotMapEngine.GotMap.LayerManager
    Location: \GotMap-1.0.0.js, line: 893

    Handles all layer related functionality

    Layers

    Object GotMapEngine.GotMap.LayerManager.Layers
    Location: \GotMap-1.0.0.js, line: 907

    Container for all added layers

    AddLayer

    function GotMapEngine.GotMap.LayerManager.AddLayer
    Location: \GotMap-1.0.0.js, line: 916

    Adds a layer to the map

    Parameters

    Name Datatype Description
    layer Object The layer
    layerName string The name of the layer
    layerType GotMap.LayerManager.LayerTypes The type of layer
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    excludeFromClustering bool OPTIONAL Whether the layer should be excluded from the main clustering

    AddPointToLayer

    function GotMapEngine.GotMap.LayerManager.AddPointToLayer
    Location: \GotMap-1.0.0.js, line: 932

    Adds a point to a specific layer

    Returns: Object The point geometry (L.marker/L.circleMarker)

    Parameters

    Name Datatype Description
    layer Object The layer to which the point will be added
    pointDefinition Object See PointDefinition for more info.

    ClearLayer

    function GotMapEngine.GotMap.LayerManager.ClearLayer
    Location: \GotMap-1.0.0.js, line: 979

    Removes all geometries from a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer

    ClearAllLayers

    function GotMapEngine.GotMap.LayerManager.ClearAllLayers
    Location: \GotMap-1.0.0.js, line: 995

    Removes all geometries from all layers

    GetLayer

    function GotMapEngine.GotMap.LayerManager.GetLayer
    Location: \GotMap-1.0.0.js, line: 1020

    Gets a specific layer

    Returns: Object The layer if it exists else undefined

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    GetAllFeaturesOnLayer

    function GotMapEngine.GotMap.LayerManager.GetAllFeaturesOnLayer
    Location: \GotMap-1.0.0.js, line: 1031

    Gets all objects on a specific layer

    Returns: Array An array containing all the objects on the specified layer

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    GetAllFeaturesOnLayer

    function GotMapEngine.GotMap.LayerManager.GetAllFeaturesOnLayer
    Location: \GotMap-1.0.0.js, line: 1049

    Gets all objects on a specific layer

    Returns: Array An array containing all the objects on the specified layer

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    GetLayerType

    function GotMapEngine.GotMap.LayerManager.GetLayerType
    Location: \GotMap-1.0.0.js, line: 1085

    Gets the type of the layer

    Returns: string The type of layer defined in LayerManager.LayerTypes

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    HideLayer

    function GotMapEngine.GotMap.LayerManager.HideLayer
    Location: \GotMap-1.0.0.js, line: 1095

    Hides a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer

    HideAllLayers

    function GotMapEngine.GotMap.LayerManager.HideAllLayers
    Location: \GotMap-1.0.0.js, line: 1113

    Hides all layers

    LayerExists

    function GotMapEngine.GotMap.LayerManager.LayerExists
    Location: \GotMap-1.0.0.js, line: 1134

    Checks if a layer with the specified name exists

    Returns: bool True if the layer exists else false

    Parameters

    Name Datatype Description
    layerName string The name of the layer

    RemoveAllLayers

    function GotMapEngine.GotMap.LayerManager.RemoveAllLayers
    Location: \GotMap-1.0.0.js, line: 1141

    Removes all layers

    RemoveLayer

    function GotMapEngine.GotMap.LayerManager.RemoveLayer
    Location: \GotMap-1.0.0.js, line: 1161

    Removes a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer

    ShowLayer

    function GotMapEngine.GotMap.LayerManager.ShowLayer
    Location: \GotMap-1.0.0.js, line: 1177

    Shows a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer

    ShowAllLayers

    function GotMapEngine.GotMap.LayerManager.ShowAllLayers
    Location: \GotMap-1.0.0.js, line: 1195

    Shows all layers

    ZoomToFeaturesOnLayer

    function GotMapEngine.GotMap.LayerManager.ZoomToFeaturesOnLayer
    Location: \GotMap-1.0.0.js, line: 1217

    Zooms the map as close as possible to show all objects on a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    maxZoom int OPTIONAL The maximum zoomlevel to zoom to

    GeoJsonManager

    Object GotMapEngine.GotMap.GeoJsonManager
    Location: \GotMap-1.0.0.js, line: 1331

    Handles all GeoJson related functionality (layers and geometries) in the map

    Requires:

    AddFeaturesToLayer

    function GotMapEngine.GotMap.GeoJsonManager.AddFeaturesToLayer
    Location: \GotMap-1.0.0.js, line: 1338

    Adds the GeoJson data to the layer and renders it on the map

    Parameters

    Name Datatype Description
    geoJson Array The GeoJson formated geometry data. A complete GeoJSON Format specification can be found at http://geojson.org/geojson-spec.html
    layerName string The name of the new layer, adds a new layer if the layer doesn't exist.

    AddWktToLayer

    function GotMapEngine.GotMap.GeoJsonManager.AddWktToLayer
    Location: \GotMap-1.0.0.js, line: 1382

    Adds well known text specified geometries to the layer and renders it on the map

    Parameters

    Name Datatype Description
    wkt string The well known text to add
    layerName string The name of the new layer, adds a new layer if the layer doesn't exist.
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    useMarkers bool Flag whether to user markers, will render points as circles if false.
    popUpContent string Html content to render in the popup, no popup will be added if undefined.

    AddLayer

    function GotMapEngine.GotMap.GeoJsonManager.AddLayer
    Location: \GotMap-1.0.0.js, line: 1426

    Adds a new GeoJsonLayer to the map.

    Parameters

    Name Datatype Description
    layerName string The name of the new layer.
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    excludeFromClustering bool OPTIONAL Whether the layer should be excluded from the main clustering.

    GetLayer

    function GotMapEngine.GotMap.GeoJsonManager.GetLayer
    Location: \GotMap-1.0.0.js, line: 1454

    Gets a specific layer (creats a new layer if a layer with the specified name doesn't exist)

    Returns: Object The layer

    Parameters

    Name Datatype Description
    layerName string The name of the layer to get

    GetLayerAsWKT

    function GotMapEngine.GotMap.GeoJsonManager.GetLayerAsWKT
    Location: \GotMap-1.0.0.js, line: 1471

    Fetches all geometries on a layer as a WKT(well known text)

    Requires:

    Returns: String The geometries on the layer as a WKT

    Parameters

    Name Datatype Description
    layerName string The name of the layer to get as WKT

    Draw

    Object GotMapEngine.GotMap.Draw
    Location: \GotMap-1.0.0.js, line: 1603

    Container for all drawfunctionality
    Note: Drawn features will be GeoJSON

    EnableDrawing

    function GotMapEngine.GotMap.Draw.EnableDrawing
    Location: \GotMap-1.0.0.js, line: 1618

    Enables the drawing tool on the specified layer

    Requires:

    Parameters

    Name Datatype Description
    layerName string The name of the layer to which the drawn geometries will be added.
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    language string Sets the language of the draw tool for gotmap

    DisableDrawing

    function GotMapEngine.GotMap.Draw.DisableDrawing
    Location: \GotMap-1.0.0.js, line: 1721

    Disables drawing

    GetDrawnFeaturesAsWKT

    function GotMapEngine.GotMap.Draw.GetDrawnFeaturesAsWKT
    Location: \GotMap-1.0.0.js, line: 1737

    Fetches all features on the draw layer as a WKT

    RestrictToArea

    function GotMapEngine.GotMap.Draw.RestrictToArea
    Location: \GotMap-1.0.0.js, line: 1756

    Restricts drawing to a specified area

    Parameters

    Name Datatype Description
    areaWKT string A string containing a polygon definition in well known text.
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    color string Sets the color of the marker
    fillcolor string Sets the fillcolor of the marker
    fillOpacity int Sets the opacity of the fillcolor for the marker

    SetLanguage

    function GotMap.Draw.SetLanguage
    Location: \GotMap-1.0.0.js, line: 1913

    Sets the language in the drawtool
    Available languages: English(en), Swedish(sv-SE)

    Parameters

    Name Datatype Description
    language string The language code of the desired language.

    ClusterManager

    Object GotMapEngine.GotMap.ClusterManager
    Location: \GotMap-1.0.0.js, line: 1996

    Handles all clustering functionality

    AddLayer

    function GotMapEngine.GotMap.ClusterManager.AddLayer
    Location: \GotMap-1.0.0.js, line: 2006

    Adds a new GeoJsonLayer to the map

    Parameters

    Name Datatype Description
    layerName string The name of the new layer
    options Object An object containing various alternativs for the function.

    Options

    Name Datatype Description
    disableClusteringAtZoom int OPTIONAL Sets the zoom level at which to show the geometries instead of the cluster groups.
    maxClusterRadius int OPTIONAL The maximum radius that a cluster will cover from the central marker (in pixels).

    AddPointToLayer

    function GotMapEngine.GotMap.ClusterManager.AddPointToLayer
    Location: \GotMap-1.0.0.js, line: 2046

    Adds a point to a specific layer

    Parameters

    Name Datatype Description
    layerName string The name of the new layer
    pointDefinition Object See PointDefinition for more info.

    GetLayer

    function GotMapEngine.GotMap.ClusterManager.GetLayer
    Location: \GotMap-1.0.0.js, line: 2057

    Gets a specific layer (creats a new layer if a layer with the specified name doesn't exist)

    Returns: Object The layer

    Parameters

    Name Datatype Description
    layerName string The name of the layer to get

    OverlayManager

    Object GotMapEngine.GotMap.OverlayManager
    Location: \GotMap-1.0.0.js, line: 2210

    Handles all overlays

    AddWmsLayer

    function GotMap.OverlayManager.AddWmsLayer
    Location: \GotMap-1.0.0.js, line: 2217

    Used for adding a wms layer to the map

    Parameters

    Name Datatype Description
    wmsLayerDefinition Object an object containing all necessary information to create the wms layer, se GotMapEngine.PreDefinedWmsLayerDefinitions for reference

    GetWmsLayer

    function GotMap.OverlayManager.GetWmsLayer
    Location: \GotMap-1.0.0.js, line: 2250

    Used for getting a specific wms layer in the map

    Parameters

    Name Datatype Description
    name String the name of the desired wms layer

    RemoveWmsLayer

    function GotMap.OverlayManager.RemoveWmsLayer
    Location: \GotMap-1.0.0.js, line: 2273

    Used for removing a specific wms layer from the map

    Parameters

    Name Datatype Description
    wmsLayer L.TileLayer.WMS the layer to remove, tip: use the function GetWmsLayer

    EventManager

    Object GotMapEngine.GotMap.EventManager
    Location: \GotMap-1.0.0.js, line: 2346

    Handles all events and event callbacks in the map

    OnGeometryClickCallback

    function GotMapEngine.GotMap.EventManager.OnGeometryClickCallback
    Location: \GotMap-1.0.0.js, line: 2352

    Assignable callback function that will be called when a Click event is fired from a geometry

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnPointDragStartCallback

    function GotMapEngine.GotMap.EventManager.OnPointDragStartCallback
    Location: \GotMap-1.0.0.js, line: 2357

    Assignable callback function that will be called when a DragStart event is fired from a marker

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnPointDragCallback

    function GotMapEngine.GotMap.EventManager.OnPointDragCallback
    Location: \GotMap-1.0.0.js, line: 2362

    Assignable callback function that will be called when a Drag event is fired from a marker

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnPointDragEndCallback

    function GotMapEngine.GotMap.EventManager.OnPointDragEndCallback
    Location: \GotMap-1.0.0.js, line: 2367

    Assignable callback function that will be called when a DragEnd event is fired from a marker

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnGeometryMouseOverCallback

    function GotMapEngine.GotMap.EventManager.OnGeometryMouseOverCallback
    Location: \GotMap-1.0.0.js, line: 2372

    Assignable callback function that will be called when a MouseOver event is fired from a geometry

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnGeometryMouseOutCallback

    function GotMapEngine.GotMap.EventManager.OnGeometryMouseOutCallback
    Location: \GotMap-1.0.0.js, line: 2377

    Assignable callback function that will be called when a MouseOut event is fired from a geometry

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnMapZoomEndCallback

    function GotMapEngine.GotMap.EventManager.OnMapZoomEndCallback
    Location: \GotMap-1.0.0.js, line: 2382

    Assignable callback function that will be called when a ZoomEnd event is fired from the map

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target.feature)

    OnWmsLayerLoadedCallback

    function GotMapEngine.GotMap.EventManager.OnWmsLayerLoadedCallback
    Location: \GotMap-1.0.0.js, line: 2387

    Assignable callback function that will be called when a wms layer is loaded

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target)

    OnDrawCreated

    function GotMapEngine.GotMap.EventManager.OnDrawCreated
    Location: \GotMap-1.0.0.js, line: 2392

    Assignable callback function that will be called on completion of a drawn object via the drawing tool

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target)

    OnDrawEdited

    function GotMapEngine.GotMap.EventManager.OnDrawEdited
    Location: \GotMap-1.0.0.js, line: 2397

    Assignable callback function that will be called when editing completed via the drawing tool

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target)

    OnDrawDeleted

    function GotMapEngine.GotMap.EventManager.OnDrawDeleted
    Location: \GotMap-1.0.0.js, line: 2402

    Assignable callback function that will be called when deleting completed via the drawing tool

    Parameters

    Name Datatype Description
    e Object The object (tip: e.target)

    OnStreetSearchErrorCallback

    function GotMapEngine.GotMap.EventManager.OnStreetSearchErrorCallback
    Location: \GotMap-1.0.0.js, line: 2406

    Assignable callback function that will be called when an error occurs in the street search

    OnStreetSearchGeometryNotFoundCallback

    function GotMapEngine.GotMap.EventManager.OnStreetSearchGeometryNotFoundCallback
    Location: \GotMap-1.0.0.js, line: 2410

    Assignable callback function that will be called when street geometry was found

    OnFindMeShowPositionCallBack

    function GotMapEngine.GotMap.EventManager.OnFindMeShowPositionCallBack
    Location: \GotMap-1.0.0.js, line: 2416

    Assignable callback function that will be called when FindMe control has found the position

    Parameters

    Name Datatype Description
    lat double Latitude of the found position
    lng double Longitude of the found position

    CollisionDetection

    Object GotMapEngine.GotMap.CollisionDetection
    Location: \GotMap-1.0.0.js, line: 2583

    Container for collision detection functions

    IsGeoJSONFeatureWithinPolygon

    function GotMapEngine.GotMap.CollisionDetection.IsGeoJSONFeatureWithinPolygon
    Location: \GotMap-1.0.0.js, line: 2590

    Checks if a GeoJSON feature is inside a polygon

    Returns: bool True if the feature is within the polygon else false

    Parameters

    Name Datatype Description
    feature Object The GeoJSON feature to check
    polygonCoordinates Array A array containing all the points of the polygon ([{lat, lng}, ...])

    IsPointOnPolygon

    function GotMapEngine.GotMap.CollisionDetection.IsPointOnPolygon
    Location: \GotMap-1.0.0.js, line: 2646

    Checks if a point(coordinats array) is inside a polygon

    Returns: bool True if the point is on the polygon else false

    Parameters

    Name Datatype Description
    pointCoordinatesArray Array A Array containing the coordinates of the point
    polygonCoordinates Array A array containing all the points of the polygon ([{lat, lng}, ...])

    LineIntersectsWithPolygon

    function GotMapEngine.GotMap.CollisionDetection.LineIntersectsWithPolygon
    Location: \GotMap-1.0.0.js, line: 2667

    Checks if a line intersects with any edge of a polygon

    Returns: bool True if the line intersects with any edge of the polygon else false

    Parameters

    Name Datatype Description
    linePointA Array A Array containing the coordinates of the lines start position
    linePointB Array A Array containing the coordinates of the lines end position
    polygonCoordinates Array A array containing all the points of the polygon ([{lat, lng}, ...])

    Helpers

    Object GotMapEngine.GotMap.Helpers
    Location: \GotMap-1.0.0.js, line: 2719

    Container for common helper functions

    WKTPolygonToCoordinatesArray

    function GotMapEngine.GotMap.Helpers.WKTPolygonToCoordinatesArray
    Location: \GotMap-1.0.0.js, line: 2724

    Transforms a well known text polygon to a point array

    Returns: Array The array containing all the points of the polygon ([{lat, lng}, ...])

    Parameters

    Name Datatype Description
    wkt string The well known text polygon

    ObjectDefinitions

    Object GotMapEngine.ObjectDefinitions
    Location: \GotMap-1.0.0.js, line: 2760

    Container for the definitions of the objects that some of the functions in GotMap2 uses.

    PointDefinition

    Object GotMapEngine.ObjectDefinitions.PointDefinition
    Location: \GotMap-1.0.0.js, line: 2770

    Properties

    Name Datatype Description
    Id int The identifier of the feature.
    UseMarker bool Whether to use markers or points.
    MarkerOptions object See MarkerOptions for more info.
    Style object See Style for more info.
    Lat double Latitude of the point.
    Lng double Longitude of the point.
    PopupHtml string Html that will be added to the popup.
    Draggable bool Whether the feature is dragable.

    WmsLayerDefinition

    Object GotMapEngine.GotMap.ObjectDefinitions.WmsLayerDefinition
    Location: \GotMap-1.0.0.js, line: 2790

    Properties

    Name Datatype Description
    Url string The url to the geoserver that is housing the WMS layer
    Name string The name that will be displayed in the layerscontrol
    Layer string WMS layer to show
    Styles string OPTIONAL Comma-separated list of WMS styles
    Format string WMS image format (use 'image/png' for layers with transparency)
    Transparent bool If true, the WMS service will return images with transparency
    MaxZoom int OPTIONAL The maximum zoom of the WMS layer, will default to GotMap.Options.MaxZoomLevel
    EnableOnLoad bool Flags whether to load the layer by default or not