Class Index | File Index

Classes


Class PanelTileLayer


Extends GTileLayer.

Defined in: NauticalChartsAPI.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
PanelTileLayer(Panel, int, int, mixed)
Create a new PanelTileLayer, used by Google Maps as a TileLayerOverlay
Method Summary
Method Attributes Method Name and Description
 
Get the parent API object.
 
Get the parent Chart object.
 
Get the file name of the panel we intend to display.
 
Fetch the desired opacity for the tiles.
 
Get the parent Panel object.
 
getTileUrl(GPoint, int)
Fetch the target tile url for a GPoint t, and zoom level z.
 
Detect if the tile image file type is png.
 
Fetch the max resolution at which we should display this tile layer.
 
Fetch the min resolution at which we should display this tile layer.
 
setOpacity(float)
Assign the opacity of future created GTileLayer objects.
 
setPanel(Panel)
Set the parent Panel object.
Class Detail
PanelTileLayer(Panel, int, int, mixed)
Create a new PanelTileLayer, used by Google Maps as a TileLayerOverlay
Parameters:
Panel
a A parent Panel, or copyright.
int
b Minimum zoom level
int
c Maximum zoom level
mixed
d Not sure.
Returns:
PanelTileLayer A new PanelTileLayer object.
See:
GTileLayer
Method Detail
{NauticalChartsAPI} getAPI()
Get the parent API object. Used internally for the most part.
Returns:
NauticalChartsAPI

{Chart} getChart()
Get the parent Chart object. Used internally for the most part.
Returns:
Chart

{string} getFileName()
Get the file name of the panel we intend to display.
Returns:
string A panel file name (eg. 18740_1, or 18740_1.KAP)

{float} getOpacity()
Fetch the desired opacity for the tiles.
Returns:
float

{Panel} getPanel()
Get the parent Panel object. Used internally for the most part.
Returns:
Panel

{string} getTileUrl(GPoint, int)
Fetch the target tile url for a GPoint t, and zoom level z.
Parameters:
GPoint
t The tile coordinate object
int
z The zoom level of the Google map
Returns:
string A url of the tile requested.

{bool} isPng()
Detect if the tile image file type is png.
Returns:
bool

{int} maxResolution()
Fetch the max resolution at which we should display this tile layer.
Returns:
int

{int} minResolution()
Fetch the min resolution at which we should display this tile layer.
Returns:
int

{bool} setOpacity(float)
Assign the opacity of future created GTileLayer objects.
Parameters:
float
o Opacity in the range [0,1].
Returns:
bool true if o is in range, false otherwise.

{bool} setPanel(Panel)
Set the parent Panel object. Used internally for the most part.
Parameters:
Panel
panel The panel we intend to display
Returns:
bool true if panel is an instance of Panel, false otherwise.

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Oct 20 2010 17:23:19 GMT-1000 (HST)