Packagecom.google.maps.interfaces
Interfacepublic interface IMapType extends IWrappableEventDispatcher, flash.events.IEventDispatcher, IWrappable
ImplementorsMapType

IMapType is the interface implemented by map type objects. A map type is a set of tile layers, a map projection, a tile size, and assorted other settings, such as link colors and copyrights. Google provides a set of predefined map types. You can also use com.google.maps.MapType class to define a custom map type. Map types can be added to the map using the Map.addMapType() method.



Public Properties
 PropertyDefined by
 InheritedinterfaceChain : Array
List of interfaces for wrapping this object.
IWrappable
 Inheritedwrapper : Object
Instance of the cross-domain wrapper for this object.
IWrappable
Public Methods
 MethodDefined by
  
getAlt():String
Returns the text of the hint that is displayed when the user hovers over a control that allows selection of this map type.
IMapType
 Inherited
Retrieves the base event dispatcher object that allows access to event dispatching capability for cross-domain objects.
IWrappableEventDispatcher
  
getBoundsZoomLevel(bounds:LatLngBounds, viewSize:Point):Number
Returns the highest resolution zoom level required to show the given lat/lng bounds in a map of the given pixel size.
IMapType
  
getCopyrights(bounds:LatLngBounds, zoom:Number):Array
Returns an array of copyright notices for the given bounds and zoom level.
IMapType
  
getErrorMessage():String
Returns the text to be displayed if a tile fails to download.
IMapType
  
getLinkColor():Number
If a control displays a link above the map, returns the color we should use.
IMapType
  
getMaximumResolution(opt_point:LatLng = null):Number
Returns the zoom level of the maximum resolution supported by this map type.
IMapType
  
Returns the max resolution override.
IMapType
  
getMinimumResolution(opt_point:LatLng = null):Number
Returns the zoom level of the minimum resolution supported by this map type.
IMapType
  
getName(opt_short:Boolean = false):String
Retrieves the map type name.
IMapType
  
Retrieves the map type projection.
IMapType
  
getRadius():Number
Returns the radius of the planet for which this map type is defined.
IMapType
  
getSpanZoomLevel(center:LatLng, span:LatLng, viewSize:Point):Number
Returns the highest resolution zoom level required to show the given lat/lng span with the given center point.
IMapType
  
getTextColor():Number
If controls are textual, returns the appropriate color to display the text.
IMapType
  
getTileLayers():Array
Gets the list of tile layers for this map type.
IMapType
  
getTileSize():Number
Gets the tile size for this map type.
IMapType
  
getUrlArg():String
Returns a string that may be used as a URL parameter to identify this map type in permalinks to the current map view.
IMapType
  
setMaxResolutionOverride(maxResolution:Number):void
Sets the max resolution override, such that, if this number is greater than the max resolution that our map type reports to us, we will use this number instead.
IMapType
Method detail
getAlt()method
public function getAlt():String

Returns the text of the hint that is displayed when the user hovers over a control that allows selection of this map type. MapTypeControl is such a control.

Returns
String — Map type hint text.
getBoundsZoomLevel()method 
public function getBoundsZoomLevel(bounds:LatLngBounds, viewSize:Point):Number

Returns the highest resolution zoom level required to show the given lat/lng bounds in a map of the given pixel size.

Parameters
bounds:LatLngBounds — Bounds to show.
 
viewSize:Point — Size of viewport.

Returns
Number — Required zoom level for display.
getCopyrights()method 
public function getCopyrights(bounds:LatLngBounds, zoom:Number):Array

Returns an array of copyright notices for the given bounds and zoom level. Each element in this array is of type CopyrightNotice.

Parameters
bounds:LatLngBounds — Current viewport.
 
zoom:Number — Current zoom level.

Returns
Array — Array of copyright notices corresponding to this viewport.
getErrorMessage()method 
public function getErrorMessage():String

Returns the text to be displayed if a tile fails to download.

Returns
String — Error message.
getLinkColor()method 
public function getLinkColor():Number

If a control displays a link above the map, returns the color we should use. The "terms of use" link in the copyright control uses this color, for example.

Returns
Number — Link color.
getMaximumResolution()method 
public function getMaximumResolution(opt_point:LatLng = null):Number

Returns the zoom level of the maximum resolution supported by this map type. If opt_point is given, returns the maximum resolution at the given lat/lng. If opt_point is not given, returns the global maximum.

Parameters
opt_point:LatLng (default = null) — Point at which to evaluate resolution.

Returns
Number — Maximum resolution of this map type.
getMaxResolutionOverride()method 
public function getMaxResolutionOverride():Number

Returns the max resolution override.

Returns
Number — Max resolution override.
getMinimumResolution()method 
public function getMinimumResolution(opt_point:LatLng = null):Number

Returns the zoom level of the minimum resolution supported by this map type. If opt_point is given, returns the minimum resolution at the given lat/lng. If opt_point is not given, returns the global minimum.

Parameters
opt_point:LatLng (default = null) — Point at which to evaluate resolution (ignored).

Returns
Number — Minimum resolution of this map type.
getName()method 
public function getName(opt_short:Boolean = false):String

Retrieves the map type name.

Parameters
opt_short:Boolean (default = false) — Return the abbreviated name.

Returns
String — Map type name.
getProjection()method 
public function getProjection():IProjection

Retrieves the map type projection.

Returns
IProjection — Map type projection.
getRadius()method 
public function getRadius():Number

Returns the radius of the planet for which this map type is defined.

Returns
Number — Radius of the planet.
getSpanZoomLevel()method 
public function getSpanZoomLevel(center:LatLng, span:LatLng, viewSize:Point):Number

Returns the highest resolution zoom level required to show the given lat/lng span with the given center point.

Parameters
center:LatLng — Center of viewport.
 
span:LatLng — Span of viewport.
 
viewSize:Point — Size of viewport in pixels.

Returns
Number — Required zoom level for display.
getTextColor()method 
public function getTextColor():Number

If controls are textual, returns the appropriate color to display the text. The copyright control uses this color, for example.

Returns
Number — Text color.
getTileLayers()method 
public function getTileLayers():Array

Gets the list of tile layers for this map type.

Returns
Array — An array of elements of type ITileLayer, the list of tile layers.
getTileSize()method 
public function getTileSize():Number

Gets the tile size for this map type. The predefined map types' tiles are all 256 by 256 pixels in size: this function would, for these map types, return 256.

Returns
Number — Tile size.
getUrlArg()method 
public function getUrlArg():String

Returns a string that may be used as a URL parameter to identify this map type in permalinks to the current map view. This is currently only used by the maps application.

Returns
String — URL argument.
setMaxResolutionOverride()method 
public function setMaxResolutionOverride(maxResolution:Number):void

Sets the max resolution override, such that, if this number is greater than the max resolution that our map type reports to us, we will use this number instead. It represents the number of levels shown on the ZoomControl's scrollbar.

Parameters
maxResolution:Number — Value to set max resolution override to.