Community Forum

Map JS API v1.4

Map JS API Reference v1.4
  1. BaseGeometry class
  2. BasePolygon class
  3. Circle class
  4. Data class
  5. GeometryCollection class
  6. LineString class
  7. LinearRing class
  8. MultiLineString class
  9. MultiPoint class
  10. MultiPolygon class
  11. Point class
  12. Polygon class
  13. DirectionsRenderer class
  14. DirectionsService class
  15. InfoWindow class
  16. LatLng class
  17. LatLngBounds class
  18. MVCArray class
  19. MVCObject class
  20. Map class
  21. Marker class
  22. OverlayView class
  23. Point class
  24. Polygon class
  25. Polyline class
  26. Rectangle class
  27. Size class
  28. StoresOverlay class
  29. Feature class
  30. CircleOptions Interface
  31. Coordinates Interface
  32. Geometry Interface
  33. DirectionLeg Interface
  34. DirectionRequest Interface
  35. DirectionResult Interface
  36. DirectionRoute Interface
  37. DirectionsBounds Interface
  38. DirectionsOverviewPolyline Interface
  39. DirectionsRendererOptions Interface
  40. DirectionsWayPoint Interface
  41. Distance Interface
  42. Duration Interface
  43. FeatureData Interface
  44. FlyToOptions Interface
  45. GeoJSONFeature Interface
  46. GeoJSONFeatureCollection Interface
  47. GeoJSONGeometry Interface
  48. GeoJSONGeometryCollection Interface
  49. GeoJSONLineString Interface
  50. GeoJSONMultiLineString Interface
  51. GeoJSONMultiPoint Interface
  52. GeoJSONMultiPolygon Interface
  53. GeoJSONPoint Interface
  54. GeoJSONPolygon Interface
  55. GeoJSONPosition Interface
  56. GeoJSONRawGeometry Interface
  57. GeometryArray Interface
  58. GeometryClasses Interface
  59. GeometryCollectionElement Interface
  60. GeometryData Interface
  61. GeometryOptions Interface
  62. GeometryType Interface
  63. GestureHandlingMode Interface
  64. Icon Interface
  65. IconSequence Interface
  66. InfoWindowOptions Interface
  67. LatLngBoundsLiteral Interface
  68. LatLngLiteral Interface
  69. MapEventListener Interface
  70. MapOptions Interface
  71. MapPanes Interface
  72. MapStyleSpec Interface
  73. MapStyler Interface
  74. MarkerLabel Interface
  75. MarkerLabelOptions Interface
  76. MarkerOptions Interface
  77. Padding Interface
  78. PointLiteral Interface
  79. PolygonFillOptions Interface
  80. PolygonOptions Interface
  81. PolylineOptions Interface
  82. RectangleOptions Interface
  83. SizeLiteral Interface
  84. Style Interface
  85. StyleFunction Interface
  86. StyleOptions Interface
  87. StyleRule Interface
  88. SymbolIcon Interface
  89. TypedStyleRule Interface
  90. DirectionStatus Enum
  91. TravelMode Enum
  92. UnitSystem Enum
  93. woosmap.map.event Namespace
  94. woosmap.map.geometry Namespace

BaseGeometry class

woosmap.map.BaseGeometry
This class extends woosmap.map.MVCObject.
Constructor
BaseGeometry
BaseGeometry(options)
Parameters:

Methods
getDraggable
getDraggable()
Parameters: None
Return Type: boolean

Returns whether the geometry is draggable or not.

getEditable
getEditable()
Parameters: None
Return Type: boolean

Returns whether the geometry is editable or not.

getMap
getMap()
Parameters: None
Return Type: (Map | null)

Returns the current parent Map.

getVisible
getVisible()
Parameters: None
Return Type: boolean

Returns whether the geometry is visible or not.

setDraggable
setDraggable(draggable)
Parameters:
  • draggable: boolean
Return Type: void

Sets the geometry draggable.

setEditable
setEditable(editable)
Parameters:
  • editable: boolean
Return Type: void

Sets the geometry editable.

setMap
setMap(map)
Parameters:
  • map: Map | null
Return Type: void

Sets the map object to display on. if map is null, the geometry will be removed from the current map.

setVisible
setVisible(visible)
Parameters:
  • visible: boolean
Return Type: void

Sets the visibility of the geometry.

BasePolygon class

woosmap.map.BasePolygon
This class extends BaseGeometry.
Constructor
BasePolygon
BasePolygon(options)
Parameters:

Circle class

woosmap.map.Circle
This class extends BasePolygon.
Constructor
Circle
Circle(options)
Parameters:

Constructs a Circle.


Methods
getBounds
getBounds()
Parameters: None
Return Type: LatLngBounds

Returns the bounds for the circle geometry.

getCenter
getCenter()
Parameters: None
Return Type: LatLng

Returns the center for the circle geometry.

getRadius
getRadius()
Parameters: None
Return Type: number

Returns the radius for the circle geometry.

setCenter
setCenter(center)
Parameters:
Return Type: void

Sets the center for the circle.

setRadius
setRadius(radius)
Parameters:
  • radius: number
Return Type: void

Sets the radius for the circle.

setOptions
setOptions(options)
Parameters:
Return Type: void

Sets the options for the circle.

Data class

woosmap.map.Data
This class extends woosmap.map.MVCObject.

A layer for displaying geospatial data. Points can be displayed.

Constructor
Data
Data()
Parameters: None

Creates an empty collection.


Methods
add
add(feature)
Parameters:
Return Type: void

Adds the feature passed as parameter.

remove
remove(feature)
Parameters:
Return Type: void

Remove the feature passed as parameter.

addGeoJson
addGeoJson(geojson, options?)
Parameters:
Return Type: void

Adds GeoJSON features to the collection. Give this method a parsed JSON. The imported features are returned. Throws an exception if the GeoJSON could not be imported.

toGeoJson
toGeoJson(callback)
Parameters:
Return Type: void

Exports the features in the collection to a GeoJSON object.

contains
contains(feature)
Parameters:
Return Type: boolean

Checks whether the given feature is in the collection.

forEach
forEach(callback)
Parameters:
  • callback: (feature: Feature) => void
Return Type: void

Repeatedly invokes the given function, passing a feature in the collection to the function on each invocation. The order of iteration through the features is undefined.

getFeatureById
getFeatureById(id)
Parameters:
  • id: string
Return Type: (Feature | null)

Returns the feature matching the id.

getMap
getMap()
Parameters: None
Return Type: (Map | null)

Returns the map on which the features are displayed.

setMap
setMap(map)
Parameters:
  • map: Map | null
Return Type: void

Renders the features on the specified map. If map is set to null, the features will be removed from the map.

setStyle
setStyle(style)
Parameters:
Return Type: void

Sets the style for all features in the collection. Styles specified on a per-feature basis via overrideStyle() continue to apply. Pass either an object with the desired style options, or a function that computes the style for each feature. The function will be called every time a feature’s properties are updated.

getStyle
getStyle()
Parameters: None
Return Type: StyleFunction | StyleOptions

Gets the style for all features in the collection.

overrideStyle
overrideStyle(feature, style)
Parameters:
Return Type: void

Changes the style of a feature. These changes are applied on top of the style specified by setStyle(). Style properties set to null revert to the value specified via setStyle().

revertStyle
revertStyle(feature?)
Parameters:
Return Type: void

Removes the effect of previous overrideStyle() calls. The style of the given feature reverts to the style specified by setStyle(). If no feature is given, all features have their style reverted.

loadGeoJson
loadGeoJson(url, options?, callback?)
Parameters:
  • url: string
  • options: {idPropertyName: string}
  • callback: (data: Feature[]) => void
Return Type: void

Loads GeoJSON features to the collection from an url. If a callback is provided it will be called with the imported features.

Events
removefeature

This event is triggered when a feature was removed.

addfeature

This event is triggered when a feature was added.

click

This event is triggered when a feature is clicked.

contextmenu

This event is triggered when a feature is right-clicked.

dblclick

This event is triggered when a feature is double clicked.

mousedown
mouseup
mouseout

This event is triggered when the mouse moves out of a feature.

mouseover

This event is triggered when a feature was hovered

mouseenter

This event is triggered when a feature is hovered.

GeometryCollection class

woosmap.map.Data.GeometryCollection
Constructor
GeometryCollection
GeometryCollection(elements)
Parameters:

Constructs a geometry collection from an array of geometries.


Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: GeometryCollectionElement

Returns the n-th Geometry of the GeometryCollection.

getArray
getArray()
Parameters: None
Return Type: GeometryArray
getLength
getLength()
Parameters: None
Return Type: number
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void
getType
getType()
Parameters: None
Return Type: "GeometryCollection"

Returns "GeometryCollection".

LineString class

woosmap.map.Data.LineString
Constructor
LineString
LineString(points)
Parameters:

Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: LatLng

Returns the n-th Point (as LatLng) of the LineString.

getArray
getArray()
Parameters: None
Return Type: LatLng[]

Returns the points of the linestring as an array of LatLng.

getLength
getLength()
Parameters: None
Return Type: number

Returns the count of points in the linestring.

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void
getType
getType()
Parameters: None
Return Type: "LineString"

LinearRing class

woosmap.map.Data.LinearRing
This class extends LineString.
Constructor
LinearRing
LinearRing(points)
Parameters:

Constructs a linear ring.


MultiLineString class

woosmap.map.Data.MultiLineString
Constructor
MultiLineString
MultiLineString(linestrings)
Parameters:

Constructs a MultiLineString. A MultiLineString is a collection of LineString.


Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: LineString

Returns the n-th LineString of the MultiLineString.

getArray
getArray()
Parameters: None
Return Type: LineString[]
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void
getType
getType()
Parameters: None
Return Type: "MultiLineString"

Returns "MultiLineString".

MultiPoint class

woosmap.map.Data.MultiPoint
Constructor
MultiPoint
MultiPoint(points)
Parameters:

Constructs a Multipoint geometry.


Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: LatLng

Returns n-th Point of the MultiPoint.

getArray
getArray()
Parameters: None
Return Type: LatLng[]

Return the array of points

getLength
getLength()
Parameters: None
Return Type: number

Returns the length of the multipoint.

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void

For each point calls the callback.

getType
getType()
Parameters: None
Return Type: "MultiPoint"

Returns "MultiPoint".

MultiPolygon class

woosmap.map.Data.MultiPolygon
Constructor
MultiPolygon
MultiPolygon(elements)
Parameters:

Constructs a MultiPolygon geometry. A MultiPolygon is a set of Polygons.


Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: Polygon

Returns the n-th polygon of the MultiPolygon.

getArray
getArray()
Parameters: None
Return Type: Polygon[]

Returns the array of Polygons that makes the MultiPolygon.

getLength
getLength()
Parameters: None
Return Type: number

Return the count of Polygon in the MultiPolygon.

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void
getType
getType()
Parameters: None
Return Type: string

Returns "MultiPolygon".

Point class

woosmap.map.Data.Point
Constructor
Point
Point(point)
Parameters:

Constructs a Point geometry


Methods
get
get()
Parameters: None
Return Type: LatLng

Returns the point geometry

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void
getType
getType()
Parameters: None
Return Type: "Point"

Returns "Point".

Polygon class

woosmap.map.Data.Polygon
Constructor
Polygon
Polygon(elements)
Parameters:

Constructs a Polygon, using a set of linear ring.


Methods
getAt
getAt(n)
Parameters:
  • n: number
Return Type: LinearRing

Returns the n-th LinearRing of the Polygon.

getArray
getArray()
Parameters: None
Return Type: LinearRing[]

Returns the array of LinearRing that composes the Polygon.

getLength
getLength()
Parameters: None
Return Type: number

Returns the count of LinearRings that composes the Polygon.

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback: (point: LatLng) => void
Return Type: void

For each LinearRing call callback.

getType
getType()
Parameters: None
Return Type: "Polygon"

Returns "Polygon".

DirectionsRenderer class

woosmap.map.DirectionsRenderer
This class extends woosmap.map.MVCObject.
Constructor
DirectionsRenderer
DirectionsRenderer(options)
Parameters:

Methods
setMap
setMap(map)
Parameters:
  • map: Map | null
Return Type: void

Sets the map where to render the directions.

setDirections
setDirections(directions)
Parameters:
Return Type: void

Sets the directions result to render.

setRouteIndex
setRouteIndex(routeIndex)
Parameters:
  • routeIndex: number
Return Type: void

Sets the route index in the DirectionResult object to render. By default the first route (0) will be rendered.

Events
routeIndex_changed

This event is triggered when the routeIndex changes.

DirectionsService class

woosmap.map.DirectionsService
Constructor
DirectionsService
DirectionsService()
Parameters: None

Methods
route
route(request, callback)
Parameters:
Return Type: void

Issue a directions search request.

InfoWindow class

woosmap.map.InfoWindow
This class extends woosmap.map.MVCObject.
Constructor
InfoWindow
InfoWindow(options)
Parameters:

Methods
open
open(map, anchor)
Parameters:
Return Type: void

Opens the info window.

close
close()
Parameters: None
Return Type: void

Closes this InfoWindow by removing it from the DOM structure.

setContent
setContent(content)
Parameters:
  • content: string
Return Type: void

Sets the info window content

setPosition
setPosition(positionOrMarker)
Parameters:
Return Type: void

Sets the anchor

setOffset
setOffset(offset)
Parameters:
Return Type: void

Sets the offset

setMarker
setMarker(marker?)
Parameters:
Return Type: void

Sets the marker

setMap
setMap(map)
Parameters:
  • map: Map | null
Return Type: void

Sets the info window map.

getMap
getMap()
Parameters: None
Return Type: (Map | null)

Gets the current map bound to the

LatLng class

woosmap.map.LatLng
Constructor
LatLng
LatLng(lat, lng?)
Parameters:

Creates a LatLng object representing a geographic point. Latitude is specified in degrees within the range [-90, 90]. Longitude is specified in degrees within the range [-180, 180]. Set noWrap to true to enable values outside of this range. Note the ordering of latitude and longitude.


Properties
lat
Type: () => number

Returns the latitude in degrees.

lng
Type: () => number

Returns the longitude in degrees.

Methods
equals
equals(other)
Parameters:
Return Type: boolean

Comparison function.

toJSON
toJSON()
Parameters: None
Return Type: LatLngLiteral

Converts to JSON representation. This function is intended to be used via JSON.stringify.

toString
toString()
Parameters: None
Return Type: string

LatLngBounds class

woosmap.map.LatLngBounds
Constructor
LatLngBounds
LatLngBounds(northEast?, southWest?)
Parameters:

Creates a LatLngBounds object


Methods
extend
extend(latlng)
Parameters:
Return Type: void

Extends the current bounds with point.

contains
contains(latlng)
Parameters:
Return Type: boolean

Checks if current bounds contain latlng.

intersects
intersects(other)
Parameters:
Return Type: boolean

Checks if bounds are intersecting with other.

union
union(other)
Parameters:
Return Type: void

Computes the union of this bounds and other.

getNorthEast
getNorthEast()
Parameters: None
Return Type: LatLng

Returns the north-east corner of this bounds.

getSouthWest
getSouthWest()
Parameters: None
Return Type: LatLng

Returns the south-west corner of this bounds.

getCenter
getCenter()
Parameters: None
Return Type: LatLng

Computes the center of the latlng bounds.

isEmpty
isEmpty()
Parameters: None
Return Type: boolean

Checks if the current bounds are empty.

MVCArray class

woosmap.map.MVCArray
This class extends woosmap.map.MVCObject.
Constructor
MVCArray
MVCArray(array?)
Parameters:
  • array: T[]

Methods
clear
clear()
Parameters: None
Return Type: void

Removes all elements from the array.

forEach
forEach(callback)
Parameters:
  • callback: (element: T, index: number) => void
Return Type: void

Iterate over each element, calling the provided callback. The callback is called for each element like: callback(element, index).

getArray
getArray()
Parameters: None
Return Type: T[]
getAt
getAt(i)
Parameters:
  • i: number index
Return Type: T

Get the element at the specified index.

getLength
getLength()
Parameters: None
Return Type: number

Get the number of elements in this array.

insertAt
insertAt(i, elem)
Parameters:
  • i: number
  • elem: T
Return Type: void

Inserts an element at the specified index.

pop
pop()
Parameters: None
Return Type: T

Removes the last element of the array and returns that element.

push
push(elem)
Parameters:
  • elem: T
Return Type: number

Adds one element to the end of the array and returns the new length of the array.

removeAt
removeAt(i)
Parameters:
  • i: number
Return Type: T

Removes an element from the specified index.

setAt
setAt(i, elem)
Parameters:
  • i: number
  • elem: T
Return Type: void

Sets an element at the specified index.

indexOf
indexOf(elem)
Parameters:
  • elem: T
Return Type: number

Returns the index of a given element.

MVCObject class

woosmap.map.MVCObject

Constructor for MVCObject.

Constructor
MVCObject
MVCObject()
Parameters: None

Constructor for MVCObject.


Methods
bindTo
bindTo(key, target, targetKey?, notify?)
Parameters:
  • key: string the property to be bound
  • target: object the object to bind to
  • targetKey: string optional the name of the property on the target, if different from the name of the property on the observer
  • notify: boolean optional do not call _changed callback upon binding
Return Type: void

Binds the property identified by ‘key’ to the specified target.

isPropertyBound
isPropertyBound(key)
Parameters:
  • key: string the property to set
Return Type: boolean

Is this property a complex object - is it bound as either observer or target

get
get(key)
Parameters:
  • key: string the property to fetch
Return Type: mixed

Returns the value of the property specified by key

set
set(key, value, forceCallback?)
Parameters:
  • key: string the name of the property to set
  • value: mixed the new value of the property identified by key
  • forceCallback: boolean optional call callbacks, regardless of whether the value has changed or not.
Return Type: void

Sets value to key on this.

setOptions
setOptions(keyValuePairs)
Parameters:
  • keyValuePairs: object an object containing key => value of properties to change
Return Type: void

Set all the values of the properties contained in keyValuePairs

unbind
unbind(key)
Parameters:
  • key: string
Return Type: void

Un-bind the property identified by key from its current target

unbindAll
unbindAll()
Parameters: None
Return Type: void

Unbind all bound properties on this object

addListener
addListener(eventName, handler)
Parameters:
  • eventName: String
  • handler: Function
Return Type: MapEventListener

Adds a listener for eventName.

Map class

woosmap.map.Map
This class extends woosmap.map.MVCObject.
Constructor
Map
Map(mapDiv, options?)
Parameters:
  • mapDiv: HTMLElement | string HTMLElement | string
  • options: MapOptions MapOptions

Creates a new map inside the given HTML container, which is typically a DIV element.


Properties
data
Type: Data

An instance of Data, bound to the map. Add features to this Data object to conveniently display them on this map.

Methods
fitBounds
fitBounds(bounds, padding?)
Parameters:
Return Type: void

Sets the viewport to contain the given bounds.

getBounds
getBounds(padding?)
Parameters:
Return Type: LatLngBounds

Returns the lat/lng bounds of the current viewport. Optionally takes a padding parameter.

getCenter
getCenter()
Parameters: None
Return Type: LatLng

Returns the position displayed at the center of the map.

getDiv
getDiv()
Parameters: None
Return Type: HTMLElement
getHeading
getHeading()
Parameters: None
Return Type: number

Returns the compass heading. The heading value is measured in degrees (clockwise) from cardinal direction North.

getTilt
getTilt()
Parameters: None
Return Type: number

Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane

getZoom
getZoom()
Parameters: None
Return Type: number

Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane.

panBy
panBy(x, y)
Parameters:
  • x: number Number of pixels to move the map in the x direction.
  • y: number Number of pixels to move the map in the y direction.
Return Type: void

Changes the center of the map by the given distance in pixels

panTo
panTo(latLng, padding?)
Parameters:
Return Type: void

Changes the center of the map to the given LatLng.

flyTo
flyTo(options)
Parameters:
Return Type: void

Changes any combination of center, zoom, bearing, and pitch, animating the transition along a curve that evokes flight.

panToBounds
panToBounds(latLngBounds, padding)
Parameters:
Return Type: void

Pans the map by the minimum amount necessary to contain the given LatLngBounds. It makes no guarantee where on the map the bounds will be, except that the map will be panned to show as much of the bounds as possible inside {currentMapSizeInPx} - {padding}.

setCenter
setCenter(center, padding?)
Parameters:
Return Type: void

Sets the map center

setHeading
setHeading(heading)
Parameters:
  • heading: number
Return Type: void

Sets the compass heading for map measured in degrees from cardinal direction North.

setTilt
setTilt(tilt)
Parameters:
  • tilt: number
Return Type: void
setZoom
setZoom(zoom)
Parameters:
  • zoom: number
Return Type: void

Events
bounds_changed

This event is fired when the viewport bounds have changed.

center_changed

This event is fired when the map center property changes.

click

This event is fired when the user clicks on the map.

dblclick

This event is fired when the user double-clicks on the map.

drag

This event is repeatedly fired while the user drags the map.

dragend

This event is fired when the user stops dragging the map.

dragstart

This event is fired when the user starts dragging the map.

idle

This event is fired when the map becomes idle after panning or zooming.

mousemove

This event is fired whenever the user’s mouse moves over the map container.

mouseout

This event is fired when the user’s mouse exits the map container.

mouseover

This event is fired when the user’s mouse enters the map container.

rightclick

This event is fired when the DOM contextmenu event is fired on the map container.

zoom_changed

This event is fired when the map zoom property changes.

Marker class

woosmap.map.Marker
This class extends woosmap.map.MVCObject.
Constructor
Marker
Marker(options?)
Parameters:

Constructs a Marker


Properties
cursor
Type: string
map
Type: Map | null
position
Type: LatLng

Methods
setIcon
setIcon(icon)
Parameters:
  • icon: Icon | string
Return Type: void
setMap
setMap(map?)
Parameters:
  • map: (Map | null)
Return Type: void
setOpacity
setOpacity(opacity)
Parameters:
  • opacity: number
Return Type: void

Sets the marker opacity.

getOpacity
getOpacity()
Parameters: None
Return Type: number

Gets the marker opacity.

getPosition
getPosition()
Parameters: None
Return Type: LatLng

Get the marker’s geographical location.The longitude of the result may differ by a multiple of 360 degrees from the longitude previously set by setLngLat because Marker wraps the anchor longitude across copies of the world to keep the marker on screen.

setPosition
setPosition(position)
Parameters:
Return Type: void

Sets the position of the marker

getOffset
getOffset()
Parameters: None
Return Type: Point

Get the marker’s offset.

setOffset
setOffset(offset)
Parameters:
  • offset: Point The offset in pixels as a {@link PointLike} object to apply relative to the element’s center. Negatives indicate left and up.
Return Type: Marker

Sets the offset of the marker

setDraggable
setDraggable(shouldBeDraggable)
Parameters:
  • shouldBeDraggable: boolean Turns drag functionality on/off
Return Type: Marker

Sets the draggable property and functionality of the marker

getDraggable
getDraggable()
Parameters: None
Return Type: boolean

Returns true if the marker can be dragged

setRotation
setRotation(rotation)
Parameters:
  • rotation: number The rotation angle of the marker (clockwise, in degrees), relative to its respective {@link Marker#rotationAlignment} setting.
Return Type: Marker

Sets the rotation property of the marker.

getRotation
getRotation()
Parameters: None
Return Type: number

Returns the current rotation angle of the marker (in degrees).

setRotationAlignment
setRotationAlignment(alignment)
Parameters:
  • alignment: string Sets the rotationAlignment property of the marker.
Return Type: Marker

Sets the rotationAlignment property of the marker.

getRotationAlignment
getRotationAlignment()
Parameters: None
Return Type: string

Returns the current rotationAlignment property of the marker.

setPitchAlignment
setPitchAlignment(alignment?)
Parameters:
  • alignment: string Sets the pitchAlignment property of the marker. If alignment is ‘auto’, it will automatically match rotationAlignment.
Return Type: Marker

Sets the pitchAlignment property of the marker.

getPitchAlignment
getPitchAlignment()
Parameters: None
Return Type: string

Returns the current pitchAlignment property of the marker.

Events
click

This event is fired when the marker was clicked.

mouseover

This event is fired when the mouse enters the area of the marker.

mouseout

This event is fired when the mouse leaves the area of the marker.

clickable_changed

This event is fired when markers clickable property changes.

cursor_changed

This event is fired when markers cursor property changes.

icon_changed

This event is fired when markers icon property changes.

position_changed

This event is fired when markers position property changes.

dragstart

Fired when dragging starts

drag

Fired while dragging

dragend

Fired when the marker is finished being dragged

draggable_changed

This event is fired when markers draggable property changes.

visible_changed

This event is fired when markers visible property changes.

zIndex_changed

This event is fired when markers zIndex property changes.

OverlayView class

woosmap.map.OverlayView
Constructor
OverlayView
OverlayView()
Parameters: None

Methods
setMap
setMap(map)
Parameters:
  • map: Map | null
Return Type: void

Point class

woosmap.map.Point
Constructor
Point
Point(x, y)
Parameters:
  • x: number
  • y: number

Creates a Point object


Methods
equals
equals(other)
Parameters:
Return Type: boolean

Indicates whether some other object is “equal to” this one.

Polygon class

woosmap.map.Polygon
This class extends BasePolygon.
Constructor
Polygon
Polygon(options)
Parameters:

Constructs a polygon.


Methods
getPath
getPath()
Parameters: None
Return Type: MVCArray<LatLng>

Returns the outer path of the polygon.

getPaths
getPaths()
Parameters: None
Return Type: MVCArray<MVCArray<LatLng>>

Returns all the path that compose the polygon.

setOptions
setOptions(options)
Parameters:
Return Type: void

Sets the polygon options.

setPath
setPath(path)
Parameters:
Return Type: void

Sets the polygon path.

setPaths
setPaths(paths)
Parameters:
Return Type: void

Sets the polygon paths.

Polyline class

woosmap.map.Polyline
This class extends BaseGeometry.
Constructor
Polyline
Polyline(options)
Parameters:

Constructs a Polyline.


Methods
getPath
getPath()
Parameters: None
Return Type: MVCArray<LatLng>
setOptions
setOptions(options)
Parameters:
Return Type: void
setPath
setPath(path)
Parameters:
Return Type: void

Rectangle class

woosmap.map.Rectangle
This class extends BasePolygon.
Constructor
Rectangle
Rectangle(options)
Parameters:

Constructs a Rectangle.


Methods
getBounds
getBounds()
Parameters: None
Return Type: LatLngBounds
setBounds
setBounds(bounds)
Parameters:
Return Type: void
setOptions
setOptions(options)
Parameters:
Return Type: void

Size class

woosmap.map.Size
Constructor
Size
Size(width, height)
Parameters:
  • width: number
  • height: number

Creates a Size object


Methods
equals
equals(other)
Parameters:
Return Type: boolean

Indicates whether some other object is “equal to” this one.

StoresOverlay class

woosmap.map.StoresOverlay
This class extends woosmap.map.OverlayView.
Constructor
StoresOverlay
StoresOverlay(style)
Parameters:

Constructs a StoreOverlay


Methods
clearSelection
clearSelection()
Parameters: None
Return Type: void

Clears selected store if any

setSelection
setSelection(feature)
Parameters:
  • feature: Object
Return Type: void

Sets the selected store

setQuery
setQuery(query?)
Parameters:
  • query: (string | null)
Return Type: void

Sets the query used to fetch stores. To clear the query set it to undefined.

setMap
setMap(map?)
Parameters:
  • map: (Map | null)
Return Type: void

Events
store_unselected

This event is triggered when a store previously selected was unselected.

store_selected

This event is triggered when a store is selected

Feature class

woosmap.map.data.Feature
Constructor
Feature
Feature(featureData)
Parameters:

Constructs a new Data.Feature


Methods
getGeometry
getGeometry()
Parameters: None
Return Type: GeometryCollectionElement | GeometryCollection

Returns the feature geometry.

setGeometry
setGeometry(geometry)
Parameters:
Return Type: void

Set the feature geometry.

getId
getId()
Parameters: None
Return Type: string

Returns the feature id.

getProperty
getProperty(name)
Parameters:
  • name: string
Return Type: any

Returns the feature property

removeProperty
removeProperty(name)
Parameters:
  • name: string
Return Type: void

Removes property

setProperty
setProperty(name, newValue)
Parameters:
  • name: string
  • newValue: any
Return Type: void

Sets the value of the specified property. If newValue is undefined this is equivalent to calling removeProperty.

toGeoJson
toGeoJson(callback)
Parameters:
Return Type: void

Exports the feature to a GeoJSON object.

Events
setgeometry

This event is triggered when geometry is set.

removeproperty

This event is triggered when a property is removed.

setproperty

This event is triggered when a property is set.

CircleOptions Interface

Type: PolygonFillOptions
Properties
center
Type: (LatLng | null) | (LatLngLiteral | null)

The center of the circle.
radius?
Type: (number | null)

The radius of the circle.

Coordinates Interface

Type: [number, number]

Geometry Interface

Methods
getType
getType()
Parameters: None
Return Type: T

Returns the type of the geometry.

DirectionLeg Interface

Properties
distance
Type: Distance
duration
Type: Duration
end_location
Type: LatLngLiteral
start_location
Type: LatLngLiteral

DirectionRequest Interface

Properties
destination
Type: LatLng | LatLngLiteral
origin
Type: LatLng | LatLngLiteral
provideRouteAlternatives?
Type: boolean
travelMode?
Type: string
unitSystem?
Type: string
waypoints?
Type: DirectionsWayPoint[]

DirectionResult Interface

Properties
routes
Type: DirectionRoute[]

DirectionRoute Interface

Properties
bounds
Type: DirectionsBounds
legs
Type: DirectionLeg[]
overview_path?
Type: LatLng[]

The decoded overview path.
overview_polyline
Type: DirectionsOverviewPolyline

The encoded overview polyline.
summary
Type: string

The description of the route.

DirectionsBounds Interface

Properties
northeast
Type: LatLngLiteral
southwest
Type: LatLngLiteral

DirectionsOverviewPolyline Interface

Properties
points
Type: string

Contains encoded polyline.

DirectionsRendererOptions Interface

Properties
directions?
Type: DirectionResult
draggable?
Type: boolean
map?
Type: Map
markerOption?
Type: Object
preserveViewport?
Type: boolean
routeIndex?
Type: number
suppressBicyclingLayer?
Type: boolean
suppressInfoWindows?
Type: boolean
suppressMarkers?
Type: boolean
suppressPolylines?
Type: boolean

DirectionsWayPoint Interface

Properties
location
Type: LatLng | LatLngLiteral

Waypoint location.
stopover?
Type: boolean

If set to true the route will be splitted into two legs.

Distance Interface

Properties
text
Type: string
value
Type: number

Duration Interface

Properties
text
Type: string
value
Type: number

FeatureData Interface

Properties
geometry?
Type: GeometryClasses | LatLng | LatLngLiteral
id?
Type: any
properties?
Type: Object

FlyToOptions Interface

Properties
animate?
Type: boolean

Controls weather to animate or not.
around?
Type: LatLng | LatLngLiteral

If zoom is specified, around determines the point around which the zoom is centered.
bearing?
Type: number

The target bearing in degrees.
center?
Type: LatLng | LatLngLiteral

The target center.
duration?
Type: number

The animation’s duration (in milliseconds).
easing?
Type: (_: number) => number

A function taking a time in the range 0..1 and returning a number where 0 is the start state and 1 is the final state.
essential?
Type: boolean

If false, then the animation can be avoided if the user browser has prefers-reduced-motion turned on.
offset?
Type: Point | PointLiteral

The target center relative to real map container center at the end of animation.
padding?
Type: Padding

Padding to apply when centering the map.
pitch?
Type: number

The target pitch (angle towards horizon) in degrees.
zoom?
Type: number

The target zoom level.

GeoJSONFeature Interface

Properties
geometry
Type: GeoJSONGeometry
id?
Type: number | string
properties
Type: {}
type
Type: "Feature"

GeoJSONFeatureCollection Interface

Properties
features
Type: GeoJSONFeature[]
type
Type: "FeatureCollection"

GeoJSONGeometry Interface

Type: GeoJSONPoint | GeoJSONMultiPoint | GeoJSONLineString | GeoJSONMultiLineString | GeoJSONPolygon | GeoJSONMultiPolygon | GeoJSONGeometryCollection

GeoJSONGeometryCollection Interface

Properties
geometries
Type: GeoJSONGeometry[]
type
Type: "GeometryCollection"

GeoJSONLineString Interface

Type: GeoJSONRawGeometry<"LineString", GeoJSONPosition[]>

GeoJSONMultiLineString Interface

Type: GeoJSONRawGeometry<"MultiLineString", GeoJSONPosition[][]>

GeoJSONMultiPoint Interface

Type: GeoJSONRawGeometry<"MultiPoint", GeoJSONPosition[]>

GeoJSONMultiPolygon Interface

Type: GeoJSONRawGeometry<"MultiPolygon", GeoJSONPosition[][][]>

GeoJSONPoint Interface

Type: GeoJSONRawGeometry<"Point", GeoJSONPosition>

GeoJSONPolygon Interface

Type: GeoJSONRawGeometry<"Polygon", GeoJSONPosition[][]>

GeoJSONPosition Interface

Type: [number, number]

GeoJSONRawGeometry Interface

Properties
coordinates
Type: C
type
Type: T

GeometryArray Interface

Type: GeometryCollectionElement[]

GeometryClasses Interface

Type: GeometryCollectionElement | GeometryCollection

GeometryCollectionElement Interface

Type: Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon

GeometryData Interface

Properties
coordinates
Type: any
geometries?
Type: GeometryData[]
type
Type: GeometryType

GeometryOptions Interface

Properties
clickable?
Type: (boolean | null)
draggable?
Type: (boolean | null)
editable?
Type: (boolean | null)
geodesic?
Type: (boolean | null)
map?
Type: (Map | null)
strokeColor?
Type: (string | null)
strokeOpacity?
Type: (number | null)
strokePosition?
Type: string
strokeWeight?
Type: (number | null)
visible?
Type: (boolean | null)

Whether the Geometry is visible or not.
zIndex?
Type: (number | null)

GeometryType Interface

Type: "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "LinearRing" | "Polygon" | "MultiPolygon" | "GeometryCollection"

GestureHandlingMode Interface

Type: "none" | "greedy" | "cooperative" | "auto"

Icon Interface

Properties
anchor?
Type: Point | PointLiteral
labelOrigin?
Type: Point | PointLiteral
scaledSize?
Type: Size | SizeLiteral
size?
Type: Size | SizeLiteral
url
Type: string

IconSequence Interface

Properties
fixedRotation?
Type: (boolean | null)
icon?
Type: (SymbolIcon | null)
offset?
Type: (string | null)
repeat?
Type: (string | null)

InfoWindowOptions Interface

Properties
content?
Type: (string | Node | null)

Content to display in the InfoWindow. This can be an HTML element, a plain-text string, or a string containing HTML. The InfoWindow will be sized according to the content.
disableAutoPan?
Type: (boolean | null)

Disable auto-pan on open. By default, the info window will pan the map so that it is fully visible when it opens.
maxWidth?
Type: (number | null)

Maximum width of the infowindow, regardless of content’s width. This value is only considered if it is set before a call to open.
pixelOffset?
Type: Point

The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored.

LatLngBoundsLiteral Interface

Properties
east
Type: number
north
Type: number
south
Type: number
west
Type: number

LatLngLiteral Interface

Properties
lat
Type: number

Latitude in degrees. Values will be clamped to the range [-90, 90]. This means that if the value specified is less than -90, it will be set to -90. And if the value is greater than 90, it will be set to 90.
lng
Type: number

Longitude in degrees. Values outside the range [-180, 180] will be wrapped so that they fall within the range. For example, a value of -190 will be converted to 170. A value of 190 will be converted to -170. This reflects the fact that longitudes wrap around the globe.

MapEventListener Interface

An event listener, created by woosmap.map.event.addListener() and friends.

Methods
remove
remove()
Parameters: None
Return Type: void

Calling listener.remove() is equivalent to woosmap.map.event.removeListener(listener).

MapOptions Interface

MapOptions object used to define the properties that can be set on a Map.

Properties
center
Type: LatLng | LatLngLiteral

The initial map center to start from.
defaultStyle?
Type: string
disable3dBuilding?
Type: boolean

Disable the rendering of the buildings in 3D when the map is pitched.
disableDefaultUI?
Type: boolean

Disables the default maps controls interface, (default: false).
disableTilt?
Type: boolean

Disable the tilt control for the users, (default: false).
gestureHandling?
Type: GestureHandlingMode

This option controls how the gesture are handled Depending on the value when gesture on the map is detected (scroll on desktop, one finger pan on mobile) an overlay asking the user to use Cmd or Ctrl while scrolling or use two finger gesture to pan on mobile will be shown.

  • cooperative: Shows the overlay only if the page is scrollable.
  • greedy: Never shows the overlay.
  • none: Disables gesture handling. The map cannot be zoomed or paned using gestures.
  • auto: (default) Use cooperative mode if the page is scrollable, else use greedy mode.
styles?
Type: (MapStyleSpec[] | null)
JSON
        [
  {
    "featureType": "poi",
    "stylers": [{
      "visibility": "on"
    }]
  },
  {
    "featureType": "water",
    "stylers": [{
        "saturation": -100
    }]
  }
]
zoom
Type: number

The initial map zoom level to start from.

MapPanes Interface

Properties
floatPane
Type: Element

This pane contains the info window. It is above all map overlays. (Pane 4).
mapPane
Type: Element
markerLayer
Type: Element

This pane is the lowest pane and is above the tiles. It does not receive DOM events. (Pane 0).
overlayLayer
Type: Element

This pane contains polylines, polygons, ground overlays and tile layer overlays. It does not receive DOM events. (Pane 1).
overlayMouseTarget
Type: Element

This pane contains elements that receive DOM events. (Pane 3).

MapStyleSpec Interface

Properties
elementType?
Type: string

The group of elements, to which stylers will be applied. default value: “all”
featureType?
Type: string

The group of feature, to which stylers will be applied. default value: “all”
stylers
Type: MapStyler[]

The rules to apply to the selected features.

MapStyler Interface

Properties
color?
Type: string

The color to use to style features. Expected to be in hex form #RRBBGG.
gamma?
Type: number

Applies a gamma correction on lightness.
hue?
Type: string

The color to extract the hue from. The lightness and saturation will be kept from the original color.
invert_lightness?
Type: boolean

Inverts the lightness.
lightness?
Type: number

Changes the lightness.
saturation?
Type: number

Changes the saturation
visibility?
Type: string

Sets the visibility of the selected features. Expected to be in hex form #RRBBGG. expected values are “on”, “off”
weight?
Type: number

Changes the weight of drawn features (mostly lines, labels outline).

MarkerLabel Interface

Properties
color?
Type: string

The color of the label. Default to: black.
fontSize?
Type: string

The font size of the label in pixels. Default to: 14px.
parsedFontSize
Type: number
text
Type: string

The text to be displayed in the label.

MarkerLabelOptions Interface

Properties
className?
Type: (string | null)

A custom className property to be applied to the label’s element.
color?
Type: (string | null)

The color of the label text. (black by default).
fontFamily?
Type: (string | null)

The font family for the label.
fontSize?
Type: (string | null)

The font size for the label.
fontWeight?
Type: (string | null)

The font weight for the label.
text
Type: string

The text to be displayed in the label.

MarkerOptions Interface

Properties
anchorPoint?
Type: Point

The offset from the marker’s position to the tip of an InfoWindow that has been opened with the marker as anchor.
clickable?
Type: boolean

If true the marker receive the click events. Default value is true.
draggable?
Type: boolean
icon?
Type: string | Icon

The icon to display. When icon is a string it is treated as Icon with the string as url property.
label?
Type: string | MarkerLabelOptions

Adds a letter or number label inside a marker.
map?
Type: Map

The Map where the marker should be displayed.
opacity?
Type: number

The marker’s opacity (min: 0, max: 1)
position
Type: LatLng | LatLngLiteral

The markers’s position.
title?
Type: (string | null)
visible?
Type: boolean

If true the marker will be visible. Default value is true

Padding Interface

Properties
bottom?
Type: number
left?
Type: number
right?
Type: number
top?
Type: number

PointLiteral Interface

Properties
x
Type: number

x coordinate *
y
Type: number

y coordinate *

PolygonFillOptions Interface

Type: GeometryOptions
Properties
fillColor?
Type: (string | null)
fillOpacity?
Type: (number | null)

PolygonOptions Interface

Type: PolygonFillOptions
Properties
paths
Type: (MVCArray<MVCArray<LatLng>> | null) | MVCArray<LatLng> | Array<Array<LatLng | LatLngLiteral>> | Array<LatLng | LatLngLiteral>

The paths of the polygon.

PolylineOptions Interface

Type: GeometryOptions
Properties
path
Type: (MVCArray<LatLng> | null) | LatLng[] | LatLngLiteral[]

The path of the polyline.

RectangleOptions Interface

Type: PolygonFillOptions
Properties
bounds
Type: (LatLngBounds | null) | (LatLngBoundsLiteral | null)

The bounds of the Rectangle.

SizeLiteral Interface

Properties
height
Type: number
width
Type: number

Style Interface

Properties
breakPoint
Type: number
default
Type: StyleRule
rules
Type: TypedStyleRule[]

StyleFunction Interface

Type: (feature: Feature) => StyleOptions

StyleOptions Interface

Properties
animation?
Type: Animation
clickable?
Type: boolean
cursor?
Type: string
draggable?
Type: boolean
editable?
Type: boolean
fillColor?
Type: string
fillOpacity?
Type: number
icon?
Type: string | Icon
iconImage?
Type: string
icons?
Type: IconSequence[]
label?
Type: string | MarkerLabel
opacity?
Type: number
strokeColor?
Type: string
strokeOpacity?
Type: number
strokeWeight?
Type: number
title?
Type: string
visible?
Type: boolean
zIndex?
Type: number

StyleRule Interface

Properties
color
Type: string
icon
Type: Icon
minSize?
Type: number
selectedIcon?
Type: Icon
size?
Type: number

SymbolIcon Interface

Properties
anchor?
Type: (Point | null)

The position of the symbol relative to the marker or polyline. The coordinates of the symbol’s path are translated left and up by the anchor’s x and y coordinates respectively. By default, a symbol is anchored at(0, 0). The position is expressed in the same coordinate system as the symbol’s path.
fillColor?
Type: (string | null)

The symbol’s fill color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to ‘black’. For symbols on polylines, this defaults to the stroke color of the corresponding polyline.
fillOpacity?
Type: (number | null)

The symbol’s fill opacity. Defaults to 0.
labelOrigin?
Type: (Point | null)

The origin of the label relative to the origin of the path, if label is supplied by the marker. By default, the origin is located at(0, 0). The origin is expressed in the same coordinate system as the symbol’s path. ` This property is unused for symbols on polylines.
path
Type: string

The symbol’s path, which is a built-in symbol path, or a custom path expressed using SVG path notation.
rotation?
Type: (number | null)

The angle by which to rotate the symbol, expressed clockwise in degrees. Defaults to 0. A symbol in an IconSequence where fixedRotation is false is rotated relative to the angle of the edge on which it lies.
scale?
Type: (number | null)

The amount by which the symbol is scaled in size. For symbol markers, this defaults to 1; after scaling, the symbol may be of any size. For symbols on a polyline, this defaults to the stroke weight of the polyline; after scaling, the symbol must lie inside a square 22 pixels in size centered at the symbol’s anchor.
strokeColor?
Type: (string | null)

The symbol’s stroke color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to ‘black’. For symbols on a polyline, this defaults to the stroke color of the polyline.
strokeOpacity?
Type: (number | null)

The symbol’s stroke opacity. For symbol markers, this defaults to 1. For symbols on a polyline, this defaults to the stroke opacity of the polyline.
strokeWeight?
Type: (number | null)

The symbol’s stroke weight. Defaults to the scale of the symbol.

TypedStyleRule Interface

Properties
color
Type: string
icon
Type: Icon
selectedIcon?
Type: Icon
type
Type: string

DirectionStatus Enum

Constants
OK

TravelMode Enum

Constants
BICYCLING

Requests a route for a bicycle.

DRIVING

Requests a route for a car.

WALKING

Requests a route for a pedestrian.

UnitSystem Enum

Constants
IMPERIAL

Requests distances to be computed using the imperial system.

METRIC

Requests distances to be computed using the metric system.

woosmap.map.event Namespace

Functions
addListener
addListener(instance, eventName, handler)
Parameters:
  • instance: Object
  • eventName: string
  • handler: Function
Return Type: MapEventListener

Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().

addListenerOnce
addListenerOnce(instance, eventName, handler)
Parameters:
  • instance: Object
  • eventName: string
  • handler: Function
Return Type: MapEventListener

Like addListener, but the handler removes itself after handling the first event.

addDomListener
addDomListener(element, eventName, handler)
Parameters:
  • element: Element
  • eventName: string
  • handler: Function
Return Type: void
removeListener
removeListener(listener)
Parameters:
Return Type: void

Removes the given listener, which should have been returned by addListener above. Equivalent to calling listener.remove().

clearInstanceListeners
clearInstanceListeners(instance)
Parameters:
  • instance: Object
Return Type: void

Removes all listeners for all events for the given instance.

clearListeners
clearListeners(instance, eventName)
Parameters:
  • instance: Object
  • eventName: string
Return Type: void

Removes all listeners for the given event for the given instance.

trigger
trigger(instance, eventName, eventArgs?)
Parameters:
  • instance: Object
  • eventName: string
  • eventArgs: (any[] | null)
Return Type: void

Triggers the given event. All arguments after eventName are passed as arguments to the listeners.

woosmap.map.geometry Namespace

Functions
containsLocation
containsLocation(point, polygon)
Parameters:
Return Type: boolean

Computes whether the given point lies inside the specified polygon.

isLocationOnEdge
isLocationOnEdge(point, poly, tolerance?)
Parameters:
Return Type: boolean

Computes whether the given point lies on or near to a polyline, or the edge of a polygon, within a specified tolerance. Returns true when the difference between the latitude and longitude of the supplied point, and the closest point on the edge, is less than the tolerance. The tolerance defaults to 10-9 degrees.

‹ Draw Shapes Map Styles ›
Was this article helpful?
Have more questions? Submit a request