This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%ZEN.Mojo.Plugin.googleMaps3Helper

class %ZEN.Mojo.Plugin.googleMaps3Helper extends %ZEN.Mojo.Plugin.baseHelperPlugin

This plugin adds very basic support for the google maps API 3.0. 1.0.9 - JBE069 - GoogleMaps3: Adding support for $infowindow 1.0.8 - JBE066 - GoogleMaps: Add support for $refresh 1.0.7 - support retrieval of markers 1.0.6 - introducing library version in the classname 1.0.5 - added support configuring simple icons for markers 1.0.4 - decoupled documentation from plugin 1.0.3 - Ensure that marker gets rendered if showMarkerAtCenter is true - Added more information to plugin documentation 1.0.2 - add defensive code to ensure google maps service is loaded correctly

Property Inventory

Method Inventory

Parameters

parameter XMLNAME = googleMaps-3-Helper;
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

property pluginName as %String (XMLPROJECTION = "NONE") [ InitialExpression = "googleMaps-3-Helper" ];
The unique name of the Plugin. All features of this plugin will be registered using this identifier.
Property methods: pluginNameDisplayToLogical(), pluginNameGet(), pluginNameIsValid(), pluginNameLogicalToDisplay(), pluginNameLogicalToOdbc(), pluginNameNormalize(), pluginNameSet()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "1.0.9" ];
A version string of the base helper plugin. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

clientmethod centerMapAddress(address, map) [ Language = javascript ]
clientmethod closeInfoWindow(infoKey) [ Language = javascript ]
This method closes an info window specified by its key.
clientmethod createLayoutObjects(type, instance) [ Language = javascript ]
Create a layout object for a document item. These objects form the layout graph used to render the document. Each layout object contains the context and code needed to render itself.
clientmethod getFeatures() [ Language = javascript ]
This method returns an array containing objects which describe all layout elements the plugin supports. Each object in the list has to set the property 'identifier' in order to register this layout element for this plugin. In case multiple plugins register for the same feature the documentView component will indicate this conflict. Use the getPluginConflicts method in order to retrieve the conflicts. The first plugin which registers a features will be used for dispatching in case there is a conflict. If you want to change preference use the setPluginMapping method of the documentView
clientmethod getGMap() [ Language = javascript ]
Returns the google map object of the current level Returns null if the map object does not exist
clientmethod getMarkers() [ Language = javascript ]
Returns an array of google map marker objects of the current level Returns null if the map object does not exist
clientmethod initializeDirections() [ Language = javascript ]
clientmethod initializeMapCenterLatLng(lat, lng, instance, plugin) [ Language = javascript ]
clientmethod initializeMarker() [ Language = javascript ]
clientmethod onCheckLibraries() [ Language = javascript ]
This method is supposed to check that all required libraries have been loaded. Returns true for success, false otherwise.
clientmethod openInfoWindow(infoKey, markerKey) [ Language = javascript ]
This method opens an info window specified by its key. If the key of a marker is specified as well, the info window will open on that marker.
clientmethod refreshDirections() [ Language = javascript ]
clientmethod refreshMap() [ Language = javascript ]
Triggers the refresh event of the currently used map
clientmethod refreshMapCenterLatLng(lat, lng, instance, plugin) [ Language = javascript ]
clientmethod refreshMarker() [ Language = javascript ]
clientmethod resizeMap() [ Language = javascript ]
Triggers the resize event of the currently used map

Inherited Members

Inherited Properties

Inherited Methods

Feedback