Packagecom.google.maps
Classpublic class Copyright

This class contains information about which copyright message applies to a region of the map given by a rectangle, at a given range of zoom levels. You need this object only if you implement custom map types or tile layers.



Public Methods
 MethodDefined by
  
Copyright(id:String, bounds:LatLngBounds, minZoom:Number, text:String, opt_maxZoom:Number, opt_isSupplemental:Boolean = false)
Constructs a Copyright instance covering a geographical extent and range of zoom levels and specifies the id and text displayed for this instance.
Copyright
  
Retrieves the spatial extent of the copyright.
Copyright
  
getId():String
Retrieves the copyright id.
Copyright
  
getMaxZoom():Number
Retrieves the maximum zoom level that applies to the copyright.
Copyright
  
getMinZoom():Number
Retrieves the minimum zoom level that applies to the copyright.
Copyright
  
getText():String
Retrieves the copyright text.
Copyright
  
isSupplemental():Boolean
Returns true if this copyright is supplemental to copyright information from coarser zoom levels.
Copyright
Constructor detail
Copyright()constructor
public function Copyright(id:String, bounds:LatLngBounds, minZoom:Number, text:String, opt_maxZoom:Number, opt_isSupplemental:Boolean = false)

Constructs a Copyright instance covering a geographical extent and range of zoom levels and specifies the id and text displayed for this instance.

Parameters
id:String — Unique id.
 
bounds:LatLngBounds — Geographical extent to which this Copyright applies.
 
minZoom:Number — Minimum zoom at which to display.
 
text:String — Copyright text.
 
opt_maxZoom:Number — Maximum zoom at which to display.
 
opt_isSupplemental:Boolean (default = false) — Indicates whether this copyright supplements copyrights from coarser zoom levels. You might specify a general copyright over an extended region at a coarse zoom level, then add further copyright text within part of this region at a finer zoom level by setting this flag true. Alternatively, you may simply leave this false and specify the entire text at the finer zoom level.

Example
Create two Copyright instances. Company A's data is used throughout all zoom levels over a region spanning 10 degrees of latitude and 40 degrees of longitude. Company B's data supplements this over a much smaller region at zoom levels 14 and higher.
   var regionCopyright:Copyright = new Copyright(
       'my_tileset_0',
       new LatLngBounds(new LatLng(10, 20), new LatLng(20, 60)),
       'Company A',
       0);
   var cityCopyright:Copyright = new Copyright(
       'my_tileset_1',
       new LatLngBounds(new LatLng(12, 20), new LatLng(13, 21)),
       'Company B',
       14,
       true);

Method detail
getBounds()method
public function getBounds():LatLngBounds

Retrieves the spatial extent of the copyright.

Returns
LatLngBounds — Copyright LatLng bounds.

Example
   var regionCopyright:Copyright = new Copyright(
       'my_tileset_0',
       new LatLngBounds(new LatLng(10, 20), new LatLng(20, 60)),
       'Company A',
       0);
   trace(regionCopyright.getBounds());  // outputs "((10, 20), (20, 60))"

getId()method 
public function getId():String

Retrieves the copyright id.

Returns
String — Copyright id.
getMaxZoom()method 
public function getMaxZoom():Number

Retrieves the maximum zoom level that applies to the copyright.

Returns
Number — Maximum zoom level.
getMinZoom()method 
public function getMinZoom():Number

Retrieves the minimum zoom level that applies to the copyright.

Returns
Number — Minimum zoom level.
getText()method 
public function getText():String

Retrieves the copyright text.

Returns
String — Copyright text.
isSupplemental()method 
public function isSupplemental():Boolean

Returns true if this copyright is supplemental to copyright information from coarser zoom levels. If it is supplemental then it will be added to the coarser zoom level copyright information. If it is not supplemental then this copyright information is fully self-contained.

Returns
Boolean — Boolean indicating whether the copyright should be merged with copyrights above it.