Class NauticalChartsAPI

Extends Object.

Defined in: NauticalChartsAPI.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	NauticalChartsAPI() The API object, used to access Chart and Panel metadata and tile layers.

Field Summary
Field Attributes	Field Name and Description
	charts Array of Chart objects
	version API version

Method Summary
Method Attributes	Method Name and Description
	getChartByNumber(string) Fetch the Chart objected identified by chart number (eg.
	getCharts() Fetch an array of all Chart objects.
	getChartsByBounds(GLatLngBounds) Find all charts that overlap bounds.
	getChartsByBoundsNESW(float, float, float, float) Find all charts that overlap bounds, as specified by n,e,s,w.
	getChartsByLatLng(GLatLng) Find all charts that contain the point identified by latlng.
	getOpacity() Get the opacity of newly created TileLayerOverlays will be.
	getPanelByFileName(string) Fetch the Panel objected identified by file name (eg.
	getPanelByNumber(int) Fetch the Panel objected identified by NGA catalog number (eg.
	getPanelsByBounds(GLatLngBounds) Find all panels that overlap the specified bounds.
	getPanelsByBoundsNESW(float, float, float, float) Find all panels that overlap the specified bounds.
	getPanelsByLatLng(GLatLng) Find all panels that contain the point identified by latlng.
	isLoaded() Test if the API object has loaded and is initialized.
	setOpacity(float) Set the opacity of newly created TileLayerOverlays will be.

Class Detail

NauticalChartsAPI()

The API object, used to access Chart and Panel metadata and tile layers.

Field Detail

{array} charts

Array of Chart objects

{string} version

API version

Method Detail

{Chart} getChartByNumber(string)

Fetch the Chart objected identified by chart number (eg. 18740)

Parameters:
string: no A chart number, like 1116A or something.

Returns:: Chart The chart object, or null if none found.

{array} getCharts()

Fetch an array of all Chart objects.

Returns:: array of Chart objects.

{array} getChartsByBounds(GLatLngBounds)

Find all charts that overlap bounds.

Parameters:
GLatLngBounds: bounds A Google LatLngBounds object.

Returns:: array of Chart objects having a panel that overlaps bounds.

See:: Panel; GLatLngBounds

{array} getChartsByBoundsNESW(float, float, float, float)

Find all charts that overlap bounds, as specified by n,e,s,w.

Parameters:
float: n North-most coordinate
float: e East-most coordinate
float: s South-most coordinate
float: w West-most coordinate

Returns:: array of Chart objects having a panel that overlaps bounds.

See:: NauticalChartsAPI#getChartsByBounds

{array} getChartsByLatLng(GLatLng)

Find all charts that contain the point identified by latlng.

Parameters:
GLatLng: latlng A Google latlng object.

Returns:: array of Chart objects having a panel that contains latlng.

See:: Panel

{float} getOpacity()

Get the opacity of newly created TileLayerOverlays will be.

Returns:: float The opacity [0,1] of future created GTileLayerOverlay.

See:: GTileLayerOverlay

{Panel} getPanelByFileName(string)

Fetch the Panel objected identified by file name (eg. 18740_1, 18740_1.KAP)

Parameters:
string: no A KAP file name, like '18740_1.KAP', or '18740_1'

Returns:: Panel The panel object, or null if none found.

{Panel} getPanelByNumber(int)

Fetch the Panel objected identified by NGA catalog number (eg. 1893)

Parameters:
int: no A panel number, like those assigned by the NGA.

Returns:: Panel The panel object, or null if none found.

{array} getPanelsByBounds(GLatLngBounds)

Find all panels that overlap the specified bounds.

Parameters:
GLatLngBounds: A Google lat/lon bounds object.

Returns:: array of Panel objects that overlap bounds.

{array} getPanelsByBoundsNESW(float, float, float, float)

Find all panels that overlap the specified bounds.

Parameters:
float: n North-most coordinate
float: e East-most coordinate
float: s South-most coordinate
float: w West-most coordinate

Returns:: array of Panel objects that overlap bounds.

See:: Chart#getPanelsByBounds

{array} getPanelsByLatLng(GLatLng)

Find all panels that contain the point identified by latlng.

Parameters:
GLatLng: latlng A Google latlng object.

Returns:: array of Panel objects that contain latlng.

{bool} isLoaded()

Test if the API object has loaded and is initialized.

Returns:: bool true if loaded, false otherwise

{bool} setOpacity(float)

Set the opacity of newly created TileLayerOverlays will be.

Parameters:
float: o The opacity [0,1] of future created GTileLayerOverlay.

Returns:: bool True if opacity is in range, false otherwise.

See:: GTileLayerOverlay

Classes

Class NauticalChartsAPI