Packagecom.google.maps
Classpublic class CopyrightCollection
Implementsflash.events.IEventDispatcher, ICopyrightCollection

CopyrightCollection manages copyright messages displayed on maps of custom map type. If you don't implement custom map types, then you don't need to use this class. A copyright collection contains information about which copyright to display for which region on the map at which zoom level. This is very important for map types that display heterogenous data such as the satellite map type.



Public Methods
 MethodDefined by
  
CopyrightCollection(opt_prefix:String = null)
Creates a copyright collection for the given map type/spec.
CopyrightCollection
  
addCopyright(copyright:Copyright):Boolean
Adds the given copyright to the collection, returning true if the copyright was new and was added or false if the copyright was a duplicate and ignored.
CopyrightCollection
  
Returns a CopyrightNotice instance for the given viewport.
CopyrightCollection
  
getCopyrights(bounds:LatLngBounds, zoom:Number):Array
Retrieves an array of elements of type String, which comprises the copyright text that we should display for the given viewport.
CopyrightCollection
  
Returns an array of elements of type Copyright, which are the copyrights pertaining to the specified location.
CopyrightCollection
Protected Methods
 MethodDefined by
  
clearWrapper():void
Remove all event listeners and clear the wrapper.
CopyrightCollection
Constructor detail
CopyrightCollection()constructor
public function CopyrightCollection(opt_prefix:String = null)

Creates a copyright collection for the given map type/spec.

Parameters
opt_prefix:String (default = null) — Prefix for copyrights (optional).
Method detail
addCopyright()method
public function addCopyright(copyright:Copyright):Boolean

Adds the given copyright to the collection, returning true if the copyright was new and was added or false if the copyright was a duplicate and ignored.

Parameters
copyright:Copyright — New copyright to add.

Returns
Boolean — Whether a new copyright was added.
clearWrapper()method 
protected function clearWrapper():void

Remove all event listeners and clear the wrapper.

getCopyrightNotice()method 
public function getCopyrightNotice(bounds:LatLngBounds, zoom:Number):CopyrightNotice

Returns a CopyrightNotice instance for the given viewport.

Parameters
bounds:LatLngBounds — Query bounds.
 
zoom:Number — Zoom level.

Returns
CopyrightNotice — Resulting copyright notice.
getCopyrights()method 
public function getCopyrights(bounds:LatLngBounds, zoom:Number):Array

Retrieves an array of elements of type String, which comprises the copyright text that we should display for the given viewport.

Parameters
bounds:LatLngBounds — Query bounds.
 
zoom:Number — Zoom level.

Returns
Array — Resulting array of copyright strings.
getCopyrightsAtLatLng()method 
public function getCopyrightsAtLatLng(latLng:LatLng):Array

Returns an array of elements of type Copyright, which are the copyrights pertaining to the specified location.

Parameters
latLng:LatLng — The point for which we want to get copyrights for.

Returns
Array — Resulting array of copyrights.