Map JS API v1.4
Map JS API Reference v1.4- BaseGeometry class
- BasePolygon class
- Circle class
- Data class
- GeometryCollection class
- LineString class
- LinearRing class
- MultiLineString class
- MultiPoint class
- MultiPolygon class
- Point class
- Polygon class
- DirectionsRenderer class
- DirectionsService class
- InfoWindow class
- LatLng class
- LatLngBounds class
- MVCArray class
- MVCObject class
- Map class
- Marker class
- OverlayView class
- Point class
- Polygon class
- Polyline class
- Rectangle class
- Size class
- StoresOverlay class
- Feature class
- CircleOptions Interface
- Coordinates Interface
- Geometry Interface
- DirectionLeg Interface
- DirectionRequest Interface
- DirectionResult Interface
- DirectionRoute Interface
- DirectionsBounds Interface
- DirectionsOverviewPolyline Interface
- DirectionsRendererOptions Interface
- DirectionsWayPoint Interface
- Distance Interface
- Duration Interface
- FeatureData Interface
- FlyToOptions Interface
- GeoJSONFeature Interface
- GeoJSONFeatureCollection Interface
- GeoJSONGeometry Interface
- GeoJSONGeometryCollection Interface
- GeoJSONLineString Interface
- GeoJSONMultiLineString Interface
- GeoJSONMultiPoint Interface
- GeoJSONMultiPolygon Interface
- GeoJSONPoint Interface
- GeoJSONPolygon Interface
- GeoJSONPosition Interface
- GeoJSONRawGeometry Interface
- GeometryArray Interface
- GeometryClasses Interface
- GeometryCollectionElement Interface
- GeometryData Interface
- GeometryOptions Interface
- GeometryType Interface
- GestureHandlingMode Interface
- Icon Interface
- IconSequence Interface
- InfoWindowOptions Interface
- LatLngBoundsLiteral Interface
- LatLngLiteral Interface
- MapEventListener Interface
- MapOptions Interface
- MapPanes Interface
- MapStyleSpec Interface
- MapStyler Interface
- MarkerLabel Interface
- MarkerLabelOptions Interface
- MarkerOptions Interface
- Padding Interface
- PointLiteral Interface
- PolygonFillOptions Interface
- PolygonOptions Interface
- PolylineOptions Interface
- RectangleOptions Interface
- SizeLiteral Interface
- Style Interface
- StyleFunction Interface
- StyleOptions Interface
- StyleRule Interface
- SymbolIcon Interface
- TypedStyleRule Interface
- DirectionStatus Enum
- TravelMode Enum
- UnitSystem Enum
- woosmap.map.event Namespace
- woosmap.map.geometry Namespace
BaseGeometry class
woosmap.map.BaseGeometry
woosmap.map.MVCObject
.
Constructor |
BaseGeometry(options) Parameters:
|
Methods | |
getDraggable() Parameters:
None
Return Type:
boolean Returns whether the geometry is draggable or not. | |
getEditable() Parameters:
None
Return Type:
boolean Returns whether the geometry is editable or not. | |
getVisible() Parameters:
None
Return Type:
boolean Returns whether the geometry is visible or not. | |
setDraggable(draggable) Parameters:
Return Type:
void Sets the geometry draggable. | |
setEditable(editable) Parameters:
Return Type:
void Sets the geometry editable. | |
setMap(map) Parameters:
Return Type:
void Sets the map object to display on.
if | |
setVisible(visible) Parameters:
Return Type:
void Sets the visibility of the geometry. |
BasePolygon class
woosmap.map.BasePolygon
BaseGeometry
.
Constructor |
BasePolygon(options) Parameters:
|
Circle class
woosmap.map.Circle
BasePolygon
.
Constructor |
Methods | |
getRadius() Parameters:
None
Return Type:
number Returns the radius for the circle geometry. | |
setCenter(center) Parameters:
Return Type:
void Sets the center for the circle. | |
setRadius(radius) Parameters:
Return Type:
void Sets the radius for the circle. | |
setOptions(options) Parameters:
Return Type:
void Sets the options for the circle. |
Data class
woosmap.map.Data
woosmap.map.MVCObject
.
A layer for displaying geospatial data. Points can be displayed.
Constructor |
Data() Parameters:
None
Creates an empty collection. |
Methods | |
add(feature) Parameters:
Return Type:
void Adds the feature passed as parameter. | |
remove(feature) Parameters:
Return Type:
void Remove the feature passed as parameter. | |
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(callback) Parameters:
Return Type:
void Exports the features in the collection to a GeoJSON object. | |
contains(feature) Parameters:
Return Type:
boolean Checks whether the given feature is in the collection. | |
forEach(callback) Parameters:
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(id) Parameters:
Return Type:
(Feature | null) Returns the feature matching the id. | |
getMap() Parameters:
None
Return Type:
(Map | null) Returns the map on which the features are displayed. | |
setMap(map) Parameters:
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(style) Parameters:
Return Type:
void Sets the style for all features in the collection. Styles specified on a per-feature basis via | |
getStyle() Parameters:
None
Return Type:
StyleFunction Gets the style for all features in the collection. | |
overrideStyle(feature, style) Parameters:
Return Type:
void Changes the style of a feature.
These changes are applied on top of the style specified by | |
revertStyle(feature?) Parameters:
Return Type:
void Removes the effect of previous | |
loadGeoJson(url, options?, callback?) Parameters:
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 | |
This event is triggered when a feature was removed. | |
This event is triggered when a feature was added. | |
This event is triggered when a feature is clicked. | |
This event is triggered when a feature is right-clicked. | |
This event is triggered when a feature is double clicked. | |
| |
| |
This event is triggered when the mouse moves out of a feature. | |
This event is triggered when a feature was hovered | |
This event is triggered when a feature is hovered. |
GeometryCollection class
woosmap.map.Data.GeometryCollection
Constructor |
GeometryCollection(elements) Parameters:
Constructs a geometry collection from an array of geometries. |
Methods | |
getAt(n) Parameters:
Return Type:
GeometryCollectionElement Returns the n-th Geometry of the GeometryCollection. | |
getLength() Parameters:
None
Return Type:
number | |
getType() Parameters:
None
Return Type:
"GeometryCollection" Returns |
LineString class
woosmap.map.Data.LineString
Constructor |
LineString(points) Parameters:
|
Methods | |
getAt(n) Parameters:
Return Type:
LatLng Returns the n-th Point (as LatLng) of the LineString. | |
getArray() Parameters:
None
Return Type:
LatLng[] Returns the points of the linestring as an array of LatLng. | |
getLength() Parameters:
None
Return Type:
number Returns the count of points in the linestring. | |
getType() Parameters:
None
Return Type:
"LineString" |
LinearRing class
woosmap.map.Data.LinearRing
LineString
.
Constructor |
LinearRing(points) Parameters:
Constructs a linear ring. |
MultiLineString class
woosmap.map.Data.MultiLineString
Constructor |
MultiLineString(linestrings) Parameters:
Constructs a MultiLineString. A MultiLineString is a collection of LineString. |
Methods | |
getAt(n) Parameters:
Return Type:
LineString Returns the n-th LineString of the MultiLineString. | |
getType() Parameters:
None
Return Type:
"MultiLineString" Returns |
MultiPoint class
woosmap.map.Data.MultiPoint
Constructor |
MultiPoint(points) Parameters:
Constructs a Multipoint geometry. |
Methods | |
getLength() Parameters:
None
Return Type:
number Returns the length of the multipoint. | |
forEachLatLng(callback) Parameters:
Return Type:
void For each point calls the callback. | |
getType() Parameters:
None
Return Type:
"MultiPoint" Returns |
MultiPolygon class
woosmap.map.Data.MultiPolygon
Constructor |
MultiPolygon(elements) Parameters:
Constructs a MultiPolygon geometry. A MultiPolygon is a set of Polygons. |
Methods | |
getArray() Parameters:
None
Return Type:
Polygon[] Returns the array of Polygons that makes the MultiPolygon. | |
getLength() Parameters:
None
Return Type:
number Return the count of Polygon in the MultiPolygon. | |
getType() Parameters:
None
Return Type:
string Returns |
Point class
woosmap.map.Data.Point
Constructor |
Point(point) Parameters:
Constructs a Point geometry |
Methods | |
getType() Parameters:
None
Return Type:
"Point" Returns |
Polygon class
woosmap.map.Data.Polygon
Constructor |
Polygon(elements) Parameters:
Constructs a Polygon, using a set of linear ring. |
Methods | |
getArray() Parameters:
None
Return Type:
LinearRing[] Returns the array of LinearRing that composes the Polygon. | |
getLength() Parameters:
None
Return Type:
number Returns the count of LinearRings that composes the Polygon. | |
forEachLatLng(callback) Parameters:
Return Type:
void For each LinearRing call | |
getType() Parameters:
None
Return Type:
"Polygon" Returns |
DirectionsRenderer class
woosmap.map.DirectionsRenderer
woosmap.map.MVCObject
.
Constructor |
DirectionsRenderer(options) Parameters:
|
Methods | |
setMap(map) Parameters:
Return Type:
void Sets the map where to render the directions. | |
setDirections(directions) Parameters:
Return Type:
void Sets the directions result to render. | |
setRouteIndex(routeIndex) Parameters:
Return Type:
void Sets the route index in the DirectionResult object to render. By default the first route (0) will be rendered. |
Events | |
This event is triggered when the routeIndex changes. |
DirectionsService class
woosmap.map.DirectionsService
Constructor |
DirectionsService() Parameters:
None
|
Methods | |
route(request, callback) Parameters:
Return Type:
void Issue a directions search request. |
InfoWindow class
woosmap.map.InfoWindow
woosmap.map.MVCObject
.
Constructor |
InfoWindow(options) Parameters:
|
Methods | |
open(map, anchor) Parameters:
Return Type:
void Opens the info window. | |
close() Parameters:
None
Return Type:
void Closes this InfoWindow by removing it from the DOM structure. | |
setContent(content) Parameters:
Return Type:
void Sets the info window content | |
setPosition(positionOrMarker) Parameters:
Return Type:
void Sets the anchor | |
LatLng class
woosmap.map.LatLng
Constructor |
LatLng(lat, lng?) Parameters:
Creates a |
Properties | |
Type:
() => number Returns the latitude in degrees. | |
Type:
() => number Returns the longitude in degrees. |
Methods | |
toJSON() Parameters:
None
Return Type:
LatLngLiteral Converts to JSON representation. This function is intended to be used via | |
toString() Parameters:
None
Return Type:
string |
LatLngBounds class
woosmap.map.LatLngBounds
Constructor |
LatLngBounds(northEast?, southWest?) Parameters:
Creates a LatLngBounds object |
Methods | |
extend(latlng) Parameters:
Return Type:
void Extends the current bounds with point. | |
contains(latlng) Parameters:
Return Type:
boolean Checks if current bounds contain latlng. | |
intersects(other) Parameters:
Return Type:
boolean Checks if bounds are intersecting with other. | |
union(other) Parameters:
Return Type:
void Computes the union of this bounds and other. | |
isEmpty() Parameters:
None
Return Type:
boolean Checks if the current bounds are empty. |
MVCArray class
woosmap.map.MVCArray
woosmap.map.MVCObject
.
Constructor |
MVCArray(array?) Parameters:
|
Methods | |
clear() Parameters:
None
Return Type:
void Removes all elements from the array. | |
forEach(callback) Parameters:
Return Type:
void Iterate over each element, calling the provided callback. The callback is called for each element like: callback(element, index). | |
getArray() Parameters:
None
Return Type:
T[] | |
getAt(i) Parameters:
Return Type:
T Get the element at the specified index. | |
getLength() Parameters:
None
Return Type:
number Get the number of elements in this array. | |
insertAt(i, elem) Parameters:
Return Type:
void Inserts an element at the specified index. | |
pop() Parameters:
None
Return Type:
T Removes the last element of the array and returns that element. | |
push(elem) Parameters:
Return Type:
number Adds one element to the end of the array and returns the new length of the array. | |
removeAt(i) Parameters:
Return Type:
T Removes an element from the specified index. | |
setAt(i, elem) Parameters:
Return Type:
void Sets an element at the specified index. | |
indexOf(elem) Parameters:
Return Type:
number Returns the index of a given element. |
MVCObject class
woosmap.map.MVCObject
Constructor for MVCObject.
Constructor |
MVCObject() Parameters:
None
Constructor for MVCObject. |
Methods | |
bindTo(key, target, targetKey?, notify?) Parameters:
Return Type:
void Binds the property identified by ‘key’ to the specified target. | |
isPropertyBound(key) Parameters:
Return Type:
boolean Is this property a complex object - is it bound as either observer or target | |
get(key) Parameters:
Return Type:
mixed Returns the value of the property specified by | |
set(key, value, forceCallback?) Parameters:
Return Type:
void Sets | |
setOptions(keyValuePairs) Parameters:
Return Type:
void Set all the values of the properties contained in | |
unbind(key) Parameters:
Return Type:
void Un-bind the property identified by | |
unbindAll() Parameters:
None
Return Type:
void Unbind all bound properties on this object | |
addListener(eventName, handler) Parameters:
Return Type:
MapEventListener Adds a listener for eventName. |
Map class
woosmap.map.Map
woosmap.map.MVCObject
.
Constructor |
Map(mapDiv, options?) Parameters:
Creates a new map inside the given HTML container, which is typically a |
Properties | |
Type:
Data An instance of |
Methods | |
fitBounds(bounds, padding?) Parameters:
Return Type:
void Sets the viewport to contain the given bounds. | |
getBounds(padding?) Parameters:
Return Type:
LatLngBounds Returns the lat/lng bounds of the current viewport. Optionally takes a padding parameter. | |
getCenter() Parameters:
None
Return Type:
LatLng Returns the position displayed at the center of the map. | |
getDiv() Parameters:
None
Return Type:
HTMLElement | |
getHeading() Parameters:
None
Return Type:
number Returns the compass heading. The heading value is measured in degrees (clockwise) from cardinal direction North. | |
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() 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(x, y) Parameters:
Return Type:
void Changes the center of the map by the given distance in pixels | |
panTo(latLng, padding?) Parameters:
Return Type:
void Changes the center of the map to the given LatLng. | |
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(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
| |
setCenter(center, padding?) Parameters:
Return Type:
void Sets the map center | |
setHeading(heading) Parameters:
Return Type:
void Sets the compass heading for map measured in degrees from cardinal direction North. | |
setTilt(tilt) Parameters:
Return Type:
void | |
setZoom(zoom) Parameters:
Return Type:
void |
Events | |
This event is fired when the viewport bounds have changed. | |
This event is fired when the map center property changes. | |
This event is fired when the user clicks on the map. | |
This event is fired when the user double-clicks on the map. | |
This event is repeatedly fired while the user drags the map. | |
This event is fired when the user stops dragging the map. | |
This event is fired when the user starts dragging the map. | |
This event is fired when the map becomes idle after panning or zooming. | |
This event is fired whenever the user’s mouse moves over the map container. | |
This event is fired when the user’s mouse exits the map container. | |
This event is fired when the user’s mouse enters the map container. | |
This event is fired when the DOM contextmenu event is fired on the map container. | |
This event is fired when the map zoom property changes. |
Marker class
woosmap.map.Marker
woosmap.map.MVCObject
.
Constructor |
Properties | |
Type:
string | |
Type:
Map | |
Type:
LatLng |
Methods | |
setOpacity(opacity) Parameters:
Return Type:
void Sets the marker opacity. | |
getOpacity() Parameters:
None
Return Type:
number Gets the marker opacity. | |
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 | |
setPosition(position) Parameters:
Return Type:
void Sets the position of the marker | |
setDraggable(shouldBeDraggable) Parameters:
Return Type:
Marker Sets the | |
getDraggable() Parameters:
None
Return Type:
boolean Returns true if the marker can be dragged | |
setRotation(rotation) Parameters:
Return Type:
Marker Sets the | |
getRotation() Parameters:
None
Return Type:
number Returns the current rotation angle of the marker (in degrees). | |
setRotationAlignment(alignment) Parameters:
Return Type:
Marker Sets the | |
getRotationAlignment() Parameters:
None
Return Type:
string Returns the current | |
setPitchAlignment(alignment?) Parameters:
Return Type:
Marker Sets the | |
getPitchAlignment() Parameters:
None
Return Type:
string Returns the current |
Events | |
This event is fired when the marker was clicked. | |
This event is fired when the mouse enters the area of the marker. | |
This event is fired when the mouse leaves the area of the marker. | |
This event is fired when markers | |
This event is fired when markers | |
This event is fired when markers | |
This event is fired when markers | |
Fired when dragging starts | |
Fired while dragging | |
Fired when the marker is finished being dragged | |
This event is fired when markers | |
This event is fired when markers | |
This event is fired when markers |
OverlayView class
woosmap.map.OverlayView
Constructor |
OverlayView() Parameters:
None
|
Methods | |
Point class
woosmap.map.Point
Constructor |
Point(x, y) Parameters:
Creates a Point object |
Methods | |
equals(other) Parameters:
Return Type:
boolean Indicates whether some other object is “equal to” this one. |
Polygon class
woosmap.map.Polygon
BasePolygon
.
Constructor |
Methods | |
setPath(path) Parameters:
Return Type:
void Sets the polygon path. | |
setPaths(paths) Parameters:
Return Type:
void Sets the polygon paths. |
Polyline class
woosmap.map.Polyline
BaseGeometry
.
Constructor |
Methods | |
Rectangle class
woosmap.map.Rectangle
BasePolygon
.
Constructor |
Methods | |
Size class
woosmap.map.Size
Constructor |
Size(width, height) Parameters:
Creates a Size object |
Methods | |
equals(other) Parameters:
Return Type:
boolean Indicates whether some other object is “equal to” this one. |
StoresOverlay class
woosmap.map.StoresOverlay
woosmap.map.OverlayView
.
Constructor |
Methods | |
clearSelection() Parameters:
None
Return Type:
void Clears selected store if any | |
setSelection(feature) Parameters:
Return Type:
void Sets the selected store | |
setQuery(query?) Parameters:
Return Type:
void Sets the query used to fetch stores. To clear the query set it to undefined. | |
Events | |
This event is triggered when a store previously selected was unselected. | |
This event is triggered when a store is selected |
Feature class
woosmap.map.data.Feature
Constructor |
Feature(featureData) Parameters:
Constructs a new Data.Feature |
Methods | |
getGeometry() Parameters:
None
Return Type:
GeometryCollectionElement Returns the feature geometry. | |
setGeometry(geometry) Parameters:
Return Type:
void Set the feature geometry. | |
getId() Parameters:
None
Return Type:
string Returns the feature id. | |
getProperty(name) Parameters:
Return Type:
any Returns the feature property | |
removeProperty(name) Parameters:
Return Type:
void Removes property | |
setProperty(name, newValue) Parameters:
Return Type:
void Sets the value of the specified property. If newValue is undefined this is equivalent to calling removeProperty. | |
toGeoJson(callback) Parameters:
Return Type:
void Exports the feature to a GeoJSON object. |
Events | |
This event is triggered when geometry is set. | |
This event is triggered when a property is removed. | |
This event is triggered when a property is set. |
CircleOptions Interface
PolygonFillOptions
Properties | |
Type:
(LatLng | null) The center of the circle. | |
Type:
(number | null) The radius of the circle. |
Coordinates Interface
[number, number]
Geometry Interface
Methods | |
getType() Parameters:
None
Return Type:
T Returns the type of the geometry. |
DirectionLeg Interface
Properties | |
Type:
Distance | |
Type:
Duration | |
Type:
LatLngLiteral | |
Type:
LatLngLiteral |
DirectionRequest Interface
Properties | |
Type:
LatLng | |
Type:
LatLng | |
Type:
boolean | |
Type:
string | |
Type:
string | |
Type:
DirectionsWayPoint[] |
DirectionResult Interface
Properties | |
Type:
DirectionRoute[] |
DirectionRoute Interface
Properties | |
Type:
DirectionsBounds | |
Type:
DirectionLeg[] | |
Type:
LatLng[] The decoded overview path. | |
The encoded overview polyline. | |
Type:
string The description of the route. |
DirectionsBounds Interface
Properties | |
Type:
LatLngLiteral | |
Type:
LatLngLiteral |
DirectionsOverviewPolyline Interface
Properties | |
Type:
string Contains encoded polyline. |
DirectionsRendererOptions Interface
Properties | |
Type:
DirectionResult | |
Type:
boolean | |
Type:
Map | |
Type:
Object | |
Type:
boolean | |
Type:
number | |
Type:
boolean | |
Type:
boolean | |
Type:
boolean | |
Type:
boolean |
DirectionsWayPoint Interface
Properties | |
Type:
LatLng Waypoint location. | |
Type:
boolean If set to |
Distance Interface
Properties | |
Type:
string | |
Type:
number |
Duration Interface
Properties | |
Type:
string | |
Type:
number |
FeatureData Interface
Properties | |
Type:
GeometryClasses | |
Type:
any | |
Type:
Object |
FlyToOptions Interface
Properties | |
Type:
boolean Controls weather to animate or not. | |
Type:
LatLng If | |
Type:
number The target bearing in degrees. | |
Type:
LatLng The target center. | |
Type:
number The animation’s duration (in milliseconds). | |
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. | |
Type:
boolean If | |
Type:
Point The target center relative to real map container center at the end of animation. | |
Type:
Padding Padding to apply when centering the map. | |
Type:
number The target pitch (angle towards horizon) in degrees. | |
Type:
number The target zoom level. |
GeoJSONFeature Interface
Properties | |
Type:
GeoJSONGeometry | |
Type:
number | |
Type:
{} | |
Type:
"Feature" |
GeoJSONFeatureCollection Interface
Properties | |
Type:
GeoJSONFeature[] | |
Type:
"FeatureCollection" |
GeoJSONGeometry Interface
GeoJSONPoint | GeoJSONMultiPoint | GeoJSONLineString | GeoJSONMultiLineString | GeoJSONPolygon | GeoJSONMultiPolygon | GeoJSONGeometryCollection
GeoJSONGeometryCollection Interface
Properties | |
Type:
GeoJSONGeometry[] | |
Type:
"GeometryCollection" |
GeoJSONLineString Interface
GeoJSONRawGeometry<"LineString", GeoJSONPosition[]>
GeoJSONMultiLineString Interface
GeoJSONRawGeometry<"MultiLineString", GeoJSONPosition[][]>
GeoJSONMultiPoint Interface
GeoJSONRawGeometry<"MultiPoint", GeoJSONPosition[]>
GeoJSONMultiPolygon Interface
GeoJSONRawGeometry<"MultiPolygon", GeoJSONPosition[][][]>
GeoJSONPoint Interface
GeoJSONRawGeometry<"Point", GeoJSONPosition>
GeoJSONPolygon Interface
GeoJSONRawGeometry<"Polygon", GeoJSONPosition[][]>
GeoJSONPosition Interface
[number, number]
GeoJSONRawGeometry Interface
Properties | |
Type:
C | |
Type:
T |
GeometryArray Interface
GeometryCollectionElement[]
GeometryClasses Interface
GeometryCollectionElement Interface
Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon
GeometryData Interface
Properties | |
Type:
any | |
Type:
GeometryData[] | |
Type:
GeometryType |
GeometryOptions Interface
Properties | |
Type:
(boolean | null) | |
Type:
(boolean | null) | |
Type:
(boolean | null) | |
Type:
(boolean | null) | |
Type:
(Map | null) | |
Type:
(string | null) | |
Type:
(number | null) | |
Type:
string | |
Type:
(number | null) | |
Type:
(boolean | null) Whether the Geometry is visible or not. | |
Type:
(number | null) |
GeometryType Interface
"Point" | "MultiPoint" | "LineString" | "MultiLineString" | "LinearRing" | "Polygon" | "MultiPolygon" | "GeometryCollection"
GestureHandlingMode Interface
"none" | "greedy" | "cooperative" | "auto"
Icon Interface
Properties | |
Type:
Point | |
Type:
Point | |
Type:
Size | |
Type:
Size | |
Type:
string |
IconSequence Interface
Properties | |
Type:
(boolean | null) | |
Type:
(SymbolIcon | null) | |
Type:
(string | null) | |
Type:
(string | null) |
InfoWindowOptions Interface
Properties | |
Type:
(string 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. | |
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. | |
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. | |
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 | |
Type:
number | |
Type:
number | |
Type:
number | |
Type:
number |
LatLngLiteral Interface
Properties | |
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. | |
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() Parameters:
None
Return Type:
void Calling |
MapOptions Interface
MapOptions object used to define the properties that can be set on a Map.
Properties | |
Type:
LatLng The initial map center to start from. | |
Type:
string | |
Type:
boolean Disable the rendering of the buildings in 3D when the map is pitched. | |
Type:
boolean Disables the default maps controls interface, (default: false). | |
Type:
boolean Disable the tilt control for the users, (default: false). | |
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.
| |
Type:
(MapStyleSpec[] | null)
| |
Type:
number The initial map zoom level to start from. |
MapPanes Interface
Properties | |
Type:
Element This pane contains the info window. It is above all map overlays. (Pane 4). | |
Type:
Element | |
Type:
Element This pane is the lowest pane and is above the tiles. It does not receive DOM events. (Pane 0). | |
Type:
Element This pane contains polylines, polygons, ground overlays and tile layer overlays. It does not receive DOM events. (Pane 1). | |
Type:
Element This pane contains elements that receive DOM events. (Pane 3). |
MapStyleSpec Interface
Properties | |
Type:
string The group of elements, to which stylers will be applied. default value: “all” | |
Type:
string The group of feature, to which stylers will be applied. default value: “all” | |
Type:
MapStyler[] The rules to apply to the selected features. |
MapStyler Interface
Properties | |
Type:
string The color to use to style features.
Expected to be in hex form | |
Type:
number Applies a gamma correction on lightness. | |
Type:
string The color to extract the hue from. The lightness and saturation will be kept from the original color. | |
Type:
boolean Inverts the lightness. | |
Type:
number Changes the lightness. | |
Type:
number Changes the saturation | |
Type:
string Sets the visibility of the selected features.
Expected to be in hex form | |
Type:
number Changes the weight of drawn features (mostly lines, labels outline). |
MarkerLabel Interface
Properties | |
Type:
string The color of the label. Default to: black. | |
Type:
string The font size of the label in pixels. Default to: 14px. | |
Type:
number | |
Type:
string The text to be displayed in the label. |
MarkerLabelOptions Interface
Properties | |
Type:
(string | null) A custom className property to be applied to the label’s element. | |
Type:
(string | null) The color of the label text. (black by default). | |
Type:
(string | null) The font family for the label. | |
Type:
(string | null) The font size for the label. | |
Type:
(string | null) The font weight for the label. | |
Type:
string The text to be displayed in the label. |
MarkerOptions Interface
Properties | |
Type:
Point The offset from the marker’s position to the tip of an InfoWindow that has been opened with the marker as anchor. | |
Type:
boolean If true the marker receive the click events. Default value is true. | |
Type:
boolean | |
Type:
string The icon to display.
When icon is a string it is treated as Icon with the string as | |
Type:
string Adds a letter or number label inside a marker. | |
Type:
Map The Map where the marker should be displayed. | |
Type:
number The marker’s opacity (min: 0, max: 1) | |
Type:
LatLng The markers’s position. | |
Type:
(string | null) | |
Type:
boolean If true the marker will be visible. Default value is true |
Padding Interface
Properties | |
Type:
number | |
Type:
number | |
Type:
number | |
Type:
number |
PointLiteral Interface
Properties | |
Type:
number x coordinate * | |
Type:
number y coordinate * |
PolygonFillOptions Interface
GeometryOptions
Properties | |
Type:
(string | null) | |
Type:
(number | null) |
PolygonOptions Interface
PolygonFillOptions
Properties | |
Type:
(MVCArray<MVCArray<LatLng>> | null) The paths of the polygon. |
PolylineOptions Interface
GeometryOptions
Properties | |
Type:
(MVCArray<LatLng> | null) The path of the polyline. |
RectangleOptions Interface
PolygonFillOptions
Properties | |
Type:
(LatLngBounds | null) The bounds of the Rectangle. |
SizeLiteral Interface
Properties | |
Type:
number | |
Type:
number |
Style Interface
Properties | |
Type:
number | |
Type:
StyleRule | |
Type:
TypedStyleRule[] |
StyleFunction Interface
(feature: Feature) => StyleOptions
StyleOptions Interface
Properties | |
Type:
Animation | |
Type:
boolean | |
Type:
string | |
Type:
boolean | |
Type:
boolean | |
Type:
string | |
Type:
number | |
Type:
string | |
Type:
string | |
Type:
IconSequence[] | |
Type:
string | |
Type:
number | |
Type:
string | |
Type:
number | |
Type:
number | |
Type:
string | |
Type:
boolean | |
Type:
number |
StyleRule Interface
Properties | |
Type:
string | |
Type:
Icon | |
Type:
number | |
Type:
Icon | |
Type:
number |
SymbolIcon Interface
Properties | |
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. | |
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. | |
Type:
(number | null) The symbol’s fill opacity. Defaults to 0. | |
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. | |
Type:
string The symbol’s path, which is a built-in symbol path, or a custom path expressed using SVG path notation. | |
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. | |
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. | |
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. | |
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. | |
Type:
(number | null) The symbol’s stroke weight. Defaults to the scale of the symbol. |
TypedStyleRule Interface
Properties | |
Type:
string | |
Type:
Icon | |
Type:
Icon | |
Type:
string |
DirectionStatus Enum
Constants | |
TravelMode Enum
Constants | |
Requests a route for a bicycle. | |
Requests a route for a car. | |
Requests a route for a pedestrian. |
UnitSystem Enum
Constants | |
Requests distances to be computed using the imperial system. | |
Requests distances to be computed using the metric system. |
woosmap.map.event Namespace
Functions | |
addListener(instance, eventName, handler) Parameters:
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 | |
addListenerOnce(instance, eventName, handler) Parameters:
Return Type:
MapEventListener Like addListener, but the handler removes itself after handling the first event. | |
addDomListener(element, eventName, handler) Parameters:
Return Type:
void | |
removeListener(listener) Parameters:
Return Type:
void Removes the given listener, which should have been returned by addListener above.
Equivalent to calling | |
clearInstanceListeners(instance) Parameters:
Return Type:
void Removes all listeners for all events for the given instance. | |
clearListeners(instance, eventName) Parameters:
Return Type:
void Removes all listeners for the given event for the given instance. | |
trigger(instance, eventName, eventArgs?) Parameters:
Return Type:
void Triggers the given event. All arguments after eventName are passed as arguments to the listeners. |
woosmap.map.geometry Namespace
Functions | |
containsLocation(point, polygon) Parameters:
Return Type:
boolean Computes whether the given point lies inside the specified polygon. | |
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. |