Class Chart

Extends Object.

Defined in: NauticalChartsAPI.js.

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

Field Summary
Field Attributes	Field Name and Description
	panels Array of Panel objects.

Method Summary
Method Attributes	Method Name and Description
	getAPI() Get the parent API object.
	getBounds() Return a bounding box of all panels contained by this chart.
	getNTMDate() Fetch the date the NTM edition was published.
	getNTMEdition() Fetch the NTM (notice to mariners) edition, a number.
	getNumber() Fetch the chart number of this object (eg.
	getPanelByFileName(string) Fetch the panel identified by the file name (eg.
	getPanelByNumber(int) Fetch the Panel objected identified by NGA catalog number (eg.
	getPanels() Fetch an array of all panel objects contained by this chart.
	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.
	getRasterEdition() Fetch the raster edition, a number.
	getSourceDate() Fetch the date the source edition was published.
	getSourceEdition() Fetch the source edition, a number.
	getTitle() Fetch the chart title of this object (eg.
	hasLatLng(GLatLng) Test to see if this chart has data for a specified GLatLng location.
	overlapsBounds(GLatLngBounds) Test to see if any of this chart's panels overlap the specified bounds.
	overlapsBoundsNESW(float, float, float, float) Test to see if any of this chart's panels overlap the specified bounds.

Class Detail

Chart(NauticalChartsAPI)

Create a new Chart object. A chart holds title, edition and panel info.

Parameters:
NauticalChartsAPI: api The parent API object to associate with.

Returns:: Chart A new object.

See:: NauticalChartsAPI

Field Detail

{array} panels

Array of Panel objects.

Method Detail

{NauticalChartsAPI} getAPI()

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

Returns:: NauticalChartsAPI

{GLatLngBounds} getBounds()

Return a bounding box of all panels contained by this chart.

Returns:: GLatLngBounds A bounding box.

See:: GLatLngBounds

{string} getNTMDate()

Fetch the date the NTM edition was published.

Returns:: string NTM Date (YYYY-MM-DD)

{number} getNTMEdition()

Fetch the NTM (notice to mariners) edition, a number.

Returns:: NTM Edition

{string} getNumber()

Fetch the chart number of this object (eg. 18740)

Returns:: string A chart number.

{Panel} getPanelByFileName(string)

Fetch the panel identified by the file name (eg. 18740_1, or 18740_1.KAP)

Parameters:
string: fn A file name. This method safely compares panel file names.

Returns:: Panel The object identified by the file name fn, or null if none.

{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} getPanels()

Fetch an array of all panel objects contained by this chart.

Returns:: array of Panel objects.

{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.

{number} getRasterEdition()

Fetch the raster edition, a number.

Returns:: Raster Edition

{string} getSourceDate()

Fetch the date the source edition was published.

Returns:: Source Date (YYYY-MM-DD)

{number} getSourceEdition()

Fetch the source edition, a number.

Returns:: number Source Edition

{string} getTitle()

Fetch the chart title of this object (eg. "San Diego to Santa Rosa Island")

Returns:: string The title(s) of this chart.

{bool} hasLatLng(GLatLng)

Test to see if this chart has data for a specified GLatLng location.

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

Returns:: bool true if any Panel contains the latlng, false if none do.

See:: GLatLng

{bool} overlapsBounds(GLatLngBounds)

Test to see if any of this chart's panels overlap the specified bounds.

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

Returns:: bool true if any Panel overlaps the bounds, false if none.

See:: GLatLngBounds

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

Test to see if any of this chart's panels 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:: bool true if any panel overlaps the bounds, false if none do.

See:: Chart#overlapsBounds

Classes

Class Chart