Google Maps

(part of package 'googlemaps') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

KmlLayerURL

Type: dataprovider

---

apiKey

Type: dataprovider

---

directionsSettings

Type: routeSettings

---

fullscreenControl

Type: boolean Default Value: true

---

gestureHandling

Type: string Default Value: "auto"

---

mapEvents

Type: string[]

---

mapType

Type: string Default Value: "ROADMAP"

---

mapTypeControl

Type: boolean Default Value: true

---

markerEvents

Type: string[]

---

markers

Type: marker[] Default Value: []

---

responsiveHeight

GMaps height to be set in a responsive form. When responsiveHeight is set to 0, the component will use 100% height of the parent container

Type: int Default Value: 300

---

streetViewControl

Type: boolean Default Value: true

---

styleClass

Type: styleclass

---

useGoogleMapCluster

Type: boolean Default Value: false

---

useGoogleMapDirections

Type: boolean Default Value: false

---

visible

Type: visible

---

zoomControl

Type: boolean Default Value: true

---

zoomLevel

Type: dataprovider

---

Events

onMapEvent(event,latLng)

Parameters:

• {JSEvent} event

• {latLng} latLng

---

onMarkerEvent(event,markerIndex,latLng)

Parameters:

• {JSEvent} event

• {int} markerIndex

• {latLng} latLng

---

onMarkerGeocoded(marker,latLng)

Parameters:

• {marker} marker

• {latLng} latLng

---

onRouteChanged(routeDetails)

Parameters:

• {routeResult} routeDetails

---

API

addMarker(marker,index)

Adds the given marker

Parameters:

• {marker} marker

• {int} [index] Optional starting point where to add the marker (useful to add waypoints in routes in a specific order)

---

addMarkers(markers,index)

Adds the given markers

Parameters:

• {marker[]} markers Markers

• {int} [index] Optional starting point where to add the markers (useful to add waypoints in routes in a specific order)

---

centerAtAddress(address)

Center google maps at the given address

Example:

myElement.centerAtAddress(address);

Parameters:

• {string} address

Returns: boolean

---

centerAtLatLng(lat,lng)

Center google maps at LatLng

Example:

myElement.centerAtLatLng(lat, lng);

Parameters:

• {int} lat

• {int} lng

Returns: boolean

---

createMarker(markerId,addressOrLatLng,title)

Creates a new, empty marker with the given marker ID and position

Parameters:

• {object} markerId MarkerId

• {object} addressOrLatLng AddressOrLatLng

• {string} [title]

Returns: marker

---

fitBounds(latLngBounds)

Sets the viewport to contain the given bounds.

Parameters:

• {object} latLngBounds

---

getBounds()

Returns the lat/lng bounds of the current viewport. If more than one copy of the world is visible, the bounds range in longitude from -180 to 180 degrees inclusive. If the map is not yet initialized (i.e. the mapType is still null), or center and zoom have not been set then the result is null or undefined.

Returns: latLngBounds

---

getCenter()

Returns the position displayed at the center of the map

Returns: latLng

---

getMarker(index)

Returns the marker with the given index

Parameters:

• {int} index Index

Returns: marker

---

getMarkerById(markerId)

Returns the marker with the given markerId

Parameters:

• {object} markerId MarkerId

Returns: marker

---

getMarkers()

Returns all markers

Returns: marker[]

---

newMarkers(markers,index)

Add a new google marker to the map

Example:

myElement.newMarkers([{addressString: 'Fred. Roeskestraat 97, Amsterdam, NL'}]);

@deprecated please use addMarkers(markers, index) instead

Parameters:

• {marker[]} markers NewMarkers

• {int} [index] Optional starting point where to add the markers

---

refresh()

Refresh google maps

Example:

myElement.refresh();

Returns: boolean

---

removeAllMarkers()

Remove all google markers

Example:

myElement.removeAllMarkers();

Returns: boolean

---

removeMarker(index)

Remove google marker at given index

Example:

myElement.removeMarker(index);

Parameters:

• {int} index Index

Returns: boolean

---

setOptions(options)

Set Google Maps options. See here: https://developers.google.com/maps/documentation/javascript/reference/map#MapOptions the list of available options.

Parameters:

• {object} options Options

---

Types

latLng

scripting type: CustomType<googlemaps-svy-G-Maps.latLng>

• lat

  • Type: double

  • Default Value: 0

• lng

  • Type: double

  • Default Value: 0

latLngBounds

scripting type: CustomType<googlemaps-svy-G-Maps.latLngBounds>

• ne

  • Type: latLng

• sw

  • Type: latLng

leg

scripting type: CustomType<googlemaps-svy-G-Maps.leg>

• distance

  • Type: string

• distance_meters

  • Type: int

• duration

  • Type: string

• duration_seconds

  • Type: int

• end_address

  • Type: string

• end_markerId

  • Type: object

• start_address

  • Type: string

• start_markerId

  • Type: object

marker

scripting type: CustomType<googlemaps-svy-G-Maps.marker>

• addressDataprovider

  • Type: dataprovider

• addressString

  • Type: string

• animation

  • Type: string

  • Default Value: null

• clickable

  • Type: boolean

  • Default Value: true

• crossOnDrag

  • Type: boolean

  • Default Value: true

• cursor

  • Type: string

• draggable

  • Type: boolean

  • Default Value: false

• drawRadius

  • Type: boolean

  • Default Value: false

• iconLabel

  • Type: string

• iconMedia

  • Type: media

• iconUrl

  • Type: string

• infoWindowString

  • Type: tagstring

• latitude

  • Type: double

• longitude

  • Type: double

• markerId

  • Type: object

• opacity

  • Type: double

  • Default Value: 1

• position

  • Type: latLng

• radiusColor

  • Type: color

  • Default Value: "#AA0000"

• radiusMeters

  • Type: int

  • Default Value: 2000

• title

  • Type: string

• tooltip

  • Type: string

• userObject

  • Type: object

• visible

  • Type: boolean

  • Default Value: true

• zIndex

  • Type: int

routeResult

scripting type: CustomType<googlemaps-svy-G-Maps.routeResult>

• legs

  • Type: leg[]

• total_distance

  • Type: int

• total_duration

  • Type: int

routeSettings

scripting type: CustomType<googlemaps-svy-G-Maps.routeSettings>

• avoidFerries

  • Type: boolean

  • Default Value: false

• avoidHighways

  • Type: boolean

  • Default Value: false

• avoidTolls

  • Type: boolean

  • Default Value: false

• optimize

  • Type: boolean

  • Default Value: true

• travelMode

  • Type: string

  • Default Value: "driving"

---