Skip to main content


class %DeepSee.Component.mapView extends %ZEN.Component.component, %ZEN.Component.dataView

A specialized Zen component that displays a google map.
Use the height and width attributes to control the size of the map container.

Property Inventory

Method Inventory


parameter INCLUDEFILES = "script:"_..%GetUrlAPIKey();
Inherited description: CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.
parameter NAMESPACE =;
Inherited description: This is the XML namespace used for library components.


property infoProperties as list of %DeepSee.Component.SVG.scoreCardColumn (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Define a set of property value to be displayed within the default "info box" when the user clicks on a map marker. This only uses a relevant subset of the properties in the scoreCardColumn class. Currently only the label, dataValue, style, format, and align properties are used.
Property methods: infoPropertiesBuildValueArray(), infoPropertiesCollectionToDisplay(), infoPropertiesCollectionToOdbc(), infoPropertiesDisplayToCollection(), infoPropertiesGet(), infoPropertiesGetObject(), infoPropertiesGetObjectId(), infoPropertiesGetSwizzled(), infoPropertiesIsValid(), infoPropertiesOdbcToCollection(), infoPropertiesSet(), infoPropertiesSetObject(), infoPropertiesSetObjectId()
property latitude as %ZEN.Datatype.float [ InitialExpression = 42.36 ];
Initial latitude (as a decimal number).
Property methods: latitudeDisplayToLogical(), latitudeGet(), latitudeIsValid(), latitudeLogicalToDisplay(), latitudeLogicalToOdbc(), latitudeNormalize(), latitudeSet()
property latitudeProperty as %ZEN.Datatype.string [ InitialExpression = "Latitude" ];
Name of property in data source that provides the latitude value for a marker.
Property methods: latitudePropertyDisplayToLogical(), latitudePropertyGet(), latitudePropertyIsValid(), latitudePropertyLogicalToDisplay(), latitudePropertyLogicalToOdbc(), latitudePropertyNormalize(), latitudePropertySet()
property longitude as %ZEN.Datatype.float [ InitialExpression = 288.92 ];
Initial longitude (as a decimal number).
Property methods: longitudeDisplayToLogical(), longitudeGet(), longitudeIsValid(), longitudeLogicalToDisplay(), longitudeLogicalToOdbc(), longitudeNormalize(), longitudeSet()
property longitudeProperty as %ZEN.Datatype.string [ InitialExpression = "Longitude" ];
Name of property in data source that provides the longitude value for a marker.
Property methods: longitudePropertyDisplayToLogical(), longitudePropertyGet(), longitudePropertyIsValid(), longitudePropertyLogicalToDisplay(), longitudePropertyLogicalToOdbc(), longitudePropertyNormalize(), longitudePropertySet()
property mapType as %ZEN.Datatype.string (VALUELIST = ",ROADMAP,SATELLITE,HYBRID,TERRAIN") [ InitialExpression = "ROADMAP" ];
Initial map display.
Property methods: mapTypeDisplayToLogical(), mapTypeGet(), mapTypeIsValid(), mapTypeLogicalToDisplay(), mapTypeLogicalToOdbc(), mapTypeNormalize(), mapTypeSet()
property markersDraggable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then the markers on this map are draggable.
Property methods: markersDraggableDisplayToLogical(), markersDraggableGet(), markersDraggableIsValid(), markersDraggableLogicalToDisplay(), markersDraggableLogicalToOdbc(), markersDraggableLogicalToXSD(), markersDraggableNormalize(), markersDraggableSet(), markersDraggableXSDToLogical()
property onclickmarker as %ZEN.Datatype.eventHandler;
onclickmarker event handler: If defined, this event is fired when the user clicks on a marker within the map.
Property methods: onclickmarkerDisplayToLogical(), onclickmarkerGet(), onclickmarkerIsValid(), onclickmarkerLogicalToDisplay(), onclickmarkerLogicalToOdbc(), onclickmarkerNormalize(), onclickmarkerSet()
property zoom as %ZEN.Datatype.integer [ InitialExpression = 12 ];
Initial zoom level (0 shows entire globe).
Property methods: zoomDisplayToLogical(), zoomGet(), zoomIsValid(), zoomLogicalToDisplay(), zoomLogicalToOdbc(), zoomNormalize(), zoomSet()


clientmethod addMarker(id, latitude, longitude, title) [ Language = javascript ]
Add a marker to the map at given coordinates.
id is a user-defined identifier associated with the marker.
Returns the marker object.
clientmethod adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
clientmethod adjustMapBounds() [ Language = javascript ]
Adjust the map to show all the current markers
clientmethod getDataSet() [ Language = javascript ]
Return the dataSet object associated with this view.
clientmethod getMapObject() [ Language = javascript ]
Return the google map API object used by the map view.
clientmethod getMapTypeId(type) [ Language = javascript ]
Given the name of a map type, convert to a map type id.
clientmethod initMap(mapDiv) [ Language = javascript ]
Initialize the map
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
clientmethod panToAddress(address) [ Language = javascript ]
Invoke the google geocoder api to lookup an address string and move the map to view it. Applications that call this are responsible for adhering to the google geocoder api terms of use.
clientmethod removeMarker(marker) [ Language = javascript ]
Remove a marker from the map. marker is the marker to remove.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render control.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab