Class: ChartsClient

Defined in: src/sdk/charts/ChartsClient.ts:35

A class used for retrieving chart data from the sim.

Constructors

Constructor

new ChartsClient(): ChartsClient

Returns

ChartsClient

Methods

getChartPages()

static getChartPages(chartGuid): Promise<SimChartPages>

Defined in: src/sdk/charts/ChartsClient.ts:103

Gets chart page information for a chart with a given GUID.

Parameters

Parameter	Type	Description
chartGuid	string	The GUID of the chart for which to obtain page information.

Returns

Promise<SimChartPages>

A Promise which is fulfilled with the requested chart page information when it has been retrieved.

---

getIndexForAirport()

static getIndexForAirport<T>(airportIcao, provider): Promise<SimChartIndex<T>>

Defined in: src/sdk/charts/ChartsClient.ts:69

Gets an index of charts for an airport from a chart provider.

Type Parameters

Type Parameter
T extends string

Parameters

Parameter	Type	Description
airportIcao	IcaoValue	The ICAO of the airport for which to obtain a chart index.
provider	string	The provider from which to retrieve the chart index.

Returns

Promise<SimChartIndex<T>>

A Promise which is fulfilled with the requested chart index when it has been retrieved.

---

initializeChartView()

static initializeChartView(view): Promise<void>

Defined in: src/sdk/charts/ChartsClient.ts:134

Initializes a chart view with the charts view listener

Parameters

Parameter	Type	Description
view	ChartView	the view to initialize

Returns

Promise<void>