Class Panel

Extends Object.

Defined in: NauticalChartsAPI.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Panel(Chart) Create a new Panel object

Method Summary
Method Attributes	Method Name and Description
	getAPI() Get the parent API object.
	getBounds() Fetch the bounds of this panel.
	getChart() Get the parent Chart object.
	getEncodedLevels() Fetch the string representation of the polygon's level-of-detail
	getEncodedPolygon() Fetch the string representation of the polygon that identifies this panel.
	getFileName() Fetch the panel's KAP file name (base name) used by NOAA for RNC storage.
	getNumber() Fetch the panel number, as assigned by the NGA.
	getPolygon() Create a new GPolygon object using the internal encoded representation of the bounds (an encodedPolygon, with encodedLevels)
	getScale() Fetch the scale of the current chart panel (1:40000 would return 40000).
	getTileLayer() Initialize and fetch the GTileLayer object that represents this panel.
	getTileLayerOverlay() Initialize and fetch the GTileLayerOverlay object for this panel.
	hasLatLng(GLatLng) Determine if this panel contains the point specified by latlng.
	matchesFileName(string) Test if the user's file name matches the panel's file name.
	overlapsBounds(GLatLngBounds) Determine if this panel overlaps the bounds specified by bounds.
	overlapsBoundsNESW(float, float, float, float) Determine if this panel overlaps the bounds specified by bounds.

Class Detail

Panel(Chart)

Create a new Panel object

Parameters:
Chart: chart The parent Chart object.

Returns:: Panel A new Panel object.

See:: Chart

Method Detail

{NauticalChartsAPI} getAPI()

Get the parent API object. Used internally for the most part.

Returns:: NauticalChartsAPI

{GLatLngBounds} getBounds()

Fetch the bounds of this panel. The bounds is simply the polygon's bounds.

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

{Chart} getChart()

Get the parent Chart object. Used internally for the most part.

Returns:: Chart

{string} getEncodedLevels()

Fetch the string representation of the polygon's level-of-detail

Returns:: string Some ASCII encoding of a polyline's level-of-detail.

{string} getEncodedPolygon()

Fetch the string representation of the polygon that identifies this panel.

Returns:: string Some ASCII encoding of a polyline.

{string} getFileName()

Fetch the panel's KAP file name (base name) used by NOAA for RNC storage.

Returns:: string The file's base name (eg. 18740_1.KAP)

{int} getNumber()

Fetch the panel number, as assigned by the NGA.

Returns:: int The NGA panel number.

{GPolygon} getPolygon()

Create a new GPolygon object using the internal encoded representation of the bounds (an encodedPolygon, with encodedLevels)

Returns:: GPolygon A new Google GPolygon object.

{int} getScale()

Fetch the scale of the current chart panel (1:40000 would return 40000).

Returns:: int The map scale.

{PanelTileLayer} getTileLayer()

Initialize and fetch the GTileLayer object that represents this panel.

Returns:: PanelTileLayer A PanelTileLayer that can be added to a Google map.

See:: GTileLayer

{GTileLayerOverlay} getTileLayerOverlay()

Initialize and fetch the GTileLayerOverlay object for this panel.

Returns:: GTileLayerOverlay A Google tile layer overlay

See:: Panel#getTileLayer

{bool} hasLatLng(GLatLng)

Determine if this panel contains the point specified by latlng.

Parameters:
GLatLng: latlng A Google lat/lon object.

Returns:: bool true if panel contains point, false otherwise.

{bool} matchesFileName(string)

Test if the user's file name matches the panel's file name. A user may provide a file name like 18740_1, 18740_1.KAP, or 18740_1.kap . This method will compare the core components. Case insensitive.

Parameters:
string: fn A file name to compare Panel's fileName to.

Returns:: bool true if core components match, false otherwise.

{bool} overlapsBounds(GLatLngBounds)

Determine if this panel overlaps the bounds specified by bounds.

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

Returns:: bool true if panel overlaps bounds, false otherwise.

{bool} overlapsBoundsNESW(float, float, float, float)

Determine if this panel overlaps the bounds specified by bounds.

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

Returns:: bool true if panel overlaps bounds, false otherwise.

See:: Panel#overlapsBounds

Classes

Class Panel