MSFS Avionics

https://microsoft.github.io/msfs-avionics-mirror/2024
Admin
Documentation and API reference for Microsoft Flight Simulator 2024 TypeScript/JavaScript avionics...
Tokens:4,317,419
Snippets:33,979
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AuralAlertSystemWarningAdapter

Registers this adapter's alerts with AuralAlertSystem and starts automatically managing alert states.

```APIDOC
## start()

### Description
Registers this adapter's alerts with AuralAlertSystem and starts automatically managing alert states.

### Returns
void
```

--------------------------------

### G3000 VCockpit Configuration Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/instrument-setup

Example of `panel.cfg` entries for a G3000 setup with two PFDs, one MFD, and two GTCs. Ensure correct HTML file paths and indexing for each instrument type.

```cfg
[VCockpit01]  
size_mm=1280,800  
pixel_size=1280,800  
texture=PFD_L  
background_color=42,42,40  
htmlgauge00=NavSystems/WTG3000v2/PFD/WTG3000_PFD.html?Index=1, 0,0,1280,800  
  
[VCockpit02]  
size_mm=1280,800  
pixel_size=1280,800  
texture=PFD_R  
background_color=42,42,40  
htmlgauge00=NavSystems/WTG3000v2/PFD/WTG3000_PFD.html?Index=2, 0,0,1280,800  
  
[VCockpit03]  
size_mm=1280,800  
pixel_size=1280,800  
texture=MFD  
background_color=42,42,40  
htmlgauge00=NavSystems/WTG3000v2/MFD/WTG3000_MFD.html, 0,0,1280,800  
  
[VCockpit04]  
size_mm=1280,768  
pixel_size=1280,768  
texture=GTC_L  
background_color=42,42,40  
htmlgauge00=NavSystems/WTG3000v2/GTC/WTG3000_GTC.html?Index=1, 0,0,1280,768  
  
[VCockpit05]  
size_mm=1280,768  
pixel_size=1280,768  
texture=GTC_R  
background_color=42,42,40  
htmlgauge00=NavSystems/WTG3000v2/GTC/WTG3000_GTC.html?Index=2, 0,0,1280,768  
```

--------------------------------

### start()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AdaptiveNearestSubscription

Starts the nearest facility search. This method is an implementation of the `NearestSubscription.start` method.

```APIDOC
## start()

### Description
Starts this search.

### Returns
`Promise`<`void`>

### Implementation of
`NearestSubscription`.`start`
```

--------------------------------

### G3X Touch VCockpit Entries Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3xtouch/instrument-setup

Example of VCockpit entries for two G3X Touch instruments using the v2 HTML gauge. Ensure each instrument is indexed sequentially starting from 1.

```cfg
[VCockpit01]
size_mm=1280,768
pixel_size=1280,768
texture=G3X_1
htmlgauge00=NavSystems/G3XTouchv2/G3XTouch.html?Index=1, 0,0,1280,768

[VCockpit02]
size_mm=1280,768
pixel_size=1280,768
texture=G3X_2
htmlgauge00=NavSystems/G3XTouchv2/G3XTouch.html?Index=2, 0,0,1280,768

```

--------------------------------

### Install MSFS SDK Framework

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/getting-started/setting-up-your-environment

Install the base MSFS avionics framework and types as development dependencies. Additional platform-specific packages can also be installed.

```bash
> npm install @microsoft/msfs-sdk @microsoft/msfs-types --save-dev  

```

--------------------------------

### startPublish()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/WeightBalanceSimvarPublisher

Starts the publishing process for the WeightBalanceSimvarPublisher.

```APIDOC
## startPublish()

### Description
Starts the publishing process for the WeightBalanceSimvarPublisher.

### Method
`startPublish(): void`

### Parameters
None

### Request Example
```json
{
  "example": "Not applicable for this method"
}
```

### Response
#### Success Response (void)
Returns void.

#### Response Example
```json
{
  "example": "void"
}
```

### Inherited from
`SimVarPublisher`.`startPublish`
```

--------------------------------

### Setup G3000CASDisplay2 Component

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/features/cas

Example of how to set up the G3000CASDisplay2 component to render CAS messages. It requires the event bus, CAS active message subject, and configuration for message limits and PFD indices.

```typescript
import { G3000CASDisplay2 } from '@microsoft/msfs-wtg3000-common';

<G3000CASDisplay2
  bus={bus} /* The event bus */
  messages={casSystem.casActiveMessageSubject} /* Pass in the array of messages to be displayed from CasSystem. */
  maxMessageCount={10} /* Display up to 10 total messages at a time. */
  maxUnscrollableWarningCount={6} /* Display up to 6 unscrollable warning messages at a time. */
  pfdIndices={[1, 2]} /* Sets up the display to be scrolled by the GTCs controlling both PFD-1 and PFD-2. */
/>
```

--------------------------------

### Install and Initialize TypeScript

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/getting-started/setting-up-your-environment

Install the TypeScript compiler and initialize a TypeScript project. This creates a tsconfig.json file for compilation settings.

```bash
> npm install typescript --save-dev  
> npx tsc --init  

```

--------------------------------

### getTurnDirectionStartAngularOffset

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the turn direction based on the start angular offset.

```APIDOC
## getTurnDirectionStartAngularOffset(angle)

### Description
Gets the direction of this turn, assuming the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, takes a given value.

### Parameters
#### Path Parameters
- **angle** (number) - Required - The angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, in radians.

### Returns
`VectorTurnDirection` - The direction of this turn, assuming the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, takes the specified value.

### Throws
Error if this turn is not valid.
```

--------------------------------

### start()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/CasSystemLegacyAdapter

Registers all alerts and begins monitoring for the CasSystemLegacyAdapter.

```APIDOC
## Methods

### start()

> **start**(): `void`

Register all the alerts and begin monitoring.

#### Returns

- `void`
```

--------------------------------

### onBootStart

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-mfd-lower/classes/Epic2LowerMfdInstrument

Responds to when the instrument begins to boot. This method is protected.

```APIDOC
## onBootStart()

### Description
Responds to when the instrument begins to boot

### Method
protected

### Returns
`void`
```

--------------------------------

### getTurnStart

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the start point of this turn. The result is written to the provided output object.

```APIDOC
## getTurnStart()

### Description
Gets the start point of this turn.

### Method
`getTurnStart<T>(out: T): T`

### Parameters
#### Path Parameters
- **out** (T) - Required - The GeoPoint or 3D vector to which to write the result.

### Returns
- **T** - The start point of this turn.

### Throws
Error if this turn is not valid.
```

--------------------------------

### getSelectedAnchorSide

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the selected side of this turn's anchor point on which the turn starts.

```APIDOC
## getSelectedAnchorSide()

### Description
Gets the selected side of this turn's anchor point on which the turn starts.

### Returns
`-1` | `1`
The selected side of this turn's anchor point on which the turn starts. A value of `-1` indicates that the turn starts prior to the anchor point, as measured along the FROM circle. A value of `1` indicates that the turn starts after the anchor point, as measured along the FROM circle.
```

--------------------------------

### SetupView.onOpen()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3x/classes/SetupView

Responds to when the SetupView is opened. This method receives information about the view's size mode and dimensions.

```APIDOC
## onOpen(sizeMode: UiViewSizeMode, dimensions: ReadonlyFloat64Array)

### Description
Responds to when this view is opened.

### Parameters
#### Path Parameters
- **sizeMode** (UiViewSizeMode) - Required - The new size mode of this view's container.
- **dimensions** (ReadonlyFloat64Array) - Required - The new dimensions of this view's container, as `[width, height]` in pixels.

### Returns
`void`
```

--------------------------------

### getAlongArcSignedDistance

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathUtils

Gets the signed distance along an arc from a defined start point to a query point.

```APIDOC
## Method: getAlongArcSignedDistance()

> `static` **getAlongArcSignedDistance**(`circle`, `start`, `end`, `pos`, `tolerance`): `number`

Defined in: src/sdk/flightplan/flightpath/FlightPathUtils.ts:428

Gets the signed distance along an arc from a defined start point to a query point. The start, query, and end points will be projected onto the arc's parent circle if they do not already lie on it. A negative distance indicates that the query point lies somewhere before the start of the arc but after the point on the arc's parent circle that is diametrically opposed to the midpoint of the arc.

### Parameters

Parameter| Type| Default value| Description  
---|---|---|---
`circle`| `ReadonlyGeoCircle`| `undefined`| The arc's parent circle.  
`start`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The start point of the arc.  
`end`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The end point of the arc.  
`pos`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The query point.  
`tolerance`| `number`| `GeoCircle.ANGULAR_TOLERANCE`| The error tolerance, in great-arc radians, when checking if `start` and `query` are equal. Defaults to `GeoCircle.ANGULAR_TOLERANCE` if not specified.  

#### Returns

`number`

The signed distance along the arc from the start point to the query point, in great-arc radians.
```

--------------------------------

### init()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-mfd/classes/ToldComputer

Initializes this computer. This method sets up the computer with a specified module and an optional initial paused state.

```APIDOC
## init(module, paused)

### Description
Initializes this computer.

### Parameters
#### Parameters
- **module** (ToldModule) - The module to use with this computer. Defaults to `undefined`.
- **paused** (boolean) - Whether to initialize this computer as paused. Defaults to `false`.

### Returns
`void`

### Throws
Error if this computer has been destroyed.
```

--------------------------------

### Load and Start Plugins in Instrument

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/plugins/adding-plugin-support

Load plugin scripts using `addScripts` and then start the plugin system with `startSystem`. Both methods are asynchronous and must be called in order.

```typescript
import { AvionicsPlugin, PluginSystem } from '@microsoft/msfs-sdk';  
  
class MyInstrument extends BaseInstrument {  
  // Don't worry about the type parameters for now; we'll get to those later.  
  private pluginSystem?: PluginSystem<AvionicsPlugin<void>, void>;  
  
  // ...  
  
  public connectedCallback(): void {  
    super.connectedCallback();  
  
    this.initPlugins();  
  }  
  
  public async initPlugins(): Promise<void> {  
    this.pluginSystem = new PluginSystem<AvionicsPlugin<void>, void>();  
  
    await this.pluginSystem.addScripts(this.xmlConfig, this.templateID, (target: string) => false);  
    await this.pluginSystem.startSystem();  
  }  
  
  // ...  
}
```

--------------------------------

### EIS panel.xml Configuration Examples

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3xtouch/engine-display

These examples show different ways to configure the EIS display in panel.xml, including defining both default and combined modes, only default mode, or neither.

```xml
<Eis size="narrow">
  <Default>
    <!-- Content to display in default mode goes here -->
  </Default>
  <Combined>
    <!-- Content to display in combined mode goes here -->
  </Combined>
</Eis>
```

```xml
<Eis size="narrow">
  <Default>
    <!-- Content to display in both default and combined modes goes here -->
  </Default>
</Eis>
```

```xml
<Eis size="narrow">
  <!-- Content to display in both default and combined modes goes here -->
</Eis>
```

--------------------------------

### startSystem

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/PluginSystem

Initializes and starts the plugin system, providing it with an avionics-specific plugin binder.

```APIDOC
## startSystem<B>(binder: B): Promise<void>

### Description
Starts the plugin system with the included avionics specific plugin binder.

### Parameters
- **binder** (B) - Required - The plugin binder to pass to the individual plugins.

### Returns
`Promise<void>`
```

--------------------------------

### getAlongArcNormalizedDistance

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathUtils

Gets the normalized distance along an arc from a defined start point to a query point.

```APIDOC
## Method: getAlongArcNormalizedDistance()

> `static` **getAlongArcNormalizedDistance**(`circle`, `start`, `end`, `pos`, `tolerance`): `number`

Defined in: src/sdk/flightplan/flightpath/FlightPathUtils.ts:460

Gets the normalized distance along an arc from a defined start point to a query point. The start, query, and end points will be projected onto the arc's parent circle if they do not already lie on it. The distance is normalized such that 1 equals the arc length from the start point to the end point. A negative distance indicates that the query point lies somewhere before the start of the arc but after the point on the arc's parent circle that is diametrically opposed to the midpoint of the arc.

### Parameters

Parameter| Type| Default value| Description  
---|---|---|---
`circle`| `ReadonlyGeoCircle`| `undefined`| The arc's parent circle.  
`start`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The start point of the arc.  
`end`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The end point of the arc.  
`pos`| `Readonly`<`Omit`<`Float64Array`<`ArrayBufferLike`>, `"set"` | `"sort"` | `"copyWithin"`>> | `LatLonInterface`| `undefined`| The query point.  
`tolerance`| `number`| `GeoCircle.ANGULAR_TOLERANCE`| The error tolerance, in great-arc radians, when checking if `start` and `query` are equal. Defaults to `GeoCircle.ANGULAR_TOLERANCE` if not specified.  

#### Returns

`number`

The normalized distance along the arc from the start point to the query point.
```

--------------------------------

### Source Tag Configuration Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3xtouch/panel-xml-tag-documentation

Example configuration for a single external flight plan source, specifying its index, flight plan ID, and LNAV index.

```xml
<Source index="1" fpl-id="MyFPL" flight-path-calc-id="MyCalc" lnav-index="1" use-sim-obs="false" vnav-index="1" ap-guidance-index="0" cdi-id="MyCDI" />
```

--------------------------------

### Method: onOpen

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3x/classes/StartupView

Responds to the event when the StartupView is opened.

```APIDOC
## Method: onOpen

### Description
Responds to when this view is opened.

### Returns
`void`
```

--------------------------------

### AdaptiveNearestSubscription Methods

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AdaptiveNearestSubscription

Details on the methods available for the AdaptiveNearestSubscription class, such as awaiting its start and getting items.

```APIDOC
## Methods

### awaitStart()
> **awaitStart**(): `Promise`<`void`>

Waits until this search has started.

#### Returns

`Promise`<`void`>

#### Implementation of

`NearestSubscription`.`awaitStart`

### get()
> **get**(`index`): `NearestSubscriptionFacilityType`

Gets an item from the array.

#### Parameters

Parameter| Type| Description
---|---|---
`index`| `number`| The index of the item to get.

#### Returns

`NearestSubscriptionFacilityType`
```

--------------------------------

### onBootStart()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-mfd-upper/classes/Epic2UpperMfdInstrument

Responds to when the instrument begins to boot. Inherited from Epic2FsInstrument.

```APIDOC
## onBootStart()

### Description
Responds to when the instrument begins to boot

### Method
protected onBootStart(): void

### Returns
`void`

### Inherited from
`Epic2FsInstrument`.`onBootStart`
```

--------------------------------

### doInit

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-shared/classes/Epic2FsInstrument

Initializes the instrument. This is a protected method called during the instrument's setup process.

```APIDOC
## doInit()

### Description
Init instrument.

### Method
protected

### Returns
`void`
```

--------------------------------

### Example Initialization Plugin

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/features/initialization

A plugin that returns a custom initialization process. This serves as the entry point for the initialization logic.

```typescript
import { ConsumerSubject, EventBus, registerPlugin, Subject, Subscribable } from '@microsoft/msfs-sdk';  
  
import { Fms } from '@microsoft/msfs-garminsdk';  
  
import {  
  FlightPlanStore, FuelTotalizerControlEvents, G3000FilePaths, GtcViewKeys, InitializationProcess, InitializationTask,  
  WeightFuelEvents, WeightFuelUserSettings  
} from '@microsoft/msfs-wtg3000-common';  
  
import { AbstractG3000MfdPlugin } from '@microsoft/msfs-wtg3000-mfd';  
  
class ExampleInitializationPlugin extends AbstractG3000MfdPlugin {  
  public getInitializationProcess(): InitializationProcess {  
    return new ExampleInitializationProcess(this.binder.bus, this.binder.fms, this.binder.flightPlanStore);  
  }  
}  
  
registerPlugin(ExampleInitializationPlugin);  
  
/**  
 * An example initialization process that defines two tasks: Flight Plan and Weight and Fuel.  
 */  
class ExampleInitializationProcess implements InitializationProcess {  
  
  public readonly id = 'example';  
  
  public readonly tasks: readonly InitializationTask[];  
  
  public readonly resetMessage = 'Resetting Init Clears:\nActive Flight Plan, Weight Data';  
  
  private readonly weightFuelSettingManager = WeightFuelUserSettings.getManager(this.bus);  
  
  public constructor(private readonly bus: EventBus, private readonly fms: Fms, flightPlanStore: FlightPlanStore) {  
    this.tasks = [  
      new ExampleFlightPlanInitializationTask(fms, flightPlanStore),  
      new ExampleWeightFuelInitializationTask(bus)  
    ];  
  }  
  
  public async onReset(): Promise<void> {  
    // On reset:  
    // - Clear all flight plans.  
    // - Reset fuel on board and cargo weight settings to their default (un-initialized) values,  
    //   and reset the fuel totalizer's fuel remaining value to zero.  
  
    await this.fms.resetAllFlightPlans();  
  
    this.weightFuelSettingManager.getSetting('weightFuelInitialFob').value = -1;  
    this.weightFuelSettingManager.getSetting('weightFuelCargo').value = 0;  
    this.bus.getPublisher<FuelTotalizerControlEvents>().pub('fuel_totalizer_set_remaining', 0, true, false);  
  }  
}  
  
/**  
 * An example flight plan initialization task. This task requires the user to create an active flight plan with at  
 * least two legs (single-leg flight plans are not considered valid flight plans in the G3000).  
 */  
class ExampleFlightPlanInitializationTask implements InitializationTask {  
  
  public readonly uid = 'flight-plan';  
  
  public readonly label = 'Flight Plan';  
  
  public readonly iconSrc = `${G3000FilePaths.ASSETS_PATH}/Images/GTC/icon_small_fplan.png`;  
  
  public readonly gtcPageKey = GtcViewKeys.FlightPlan;  
  
  private readonly _isCompleted = Subject.create(false);  
  public readonly isCompleted = this._isCompleted as Subscribable<boolean>;  
  
  public constructor(private readonly fms: Fms, flightPlanStore: FlightPlanStore) {  
    this.updateCompleted();  
    flightPlanStore.flightPlanLegsChanged.on(this.updateCompleted.bind(this));  
  }  
  
  private updateCompleted(): void {  
    this._isCompleted.set(this.fms.hasPrimaryFlightPlan() && this.fms.getPrimaryFlightPlan().length > 1);  
  }  
}  
  
/**  
 * An example weight and fuel initialization task. This task requires the user to initialize weight and fuel data  
 * such that a valid aircraft weight can be computed.  
 */  
class ExampleWeightFuelInitializationTask implements InitializationTask {  
  
  public readonly uid = 'weight-fuel';  
  
  public readonly label = 'Weight and\nFuel';  
  
  public readonly iconSrc = `${G3000FilePaths.ASSETS_PATH}/Images/GTC/icon_weight_fuel.png`;  
  
  public readonly gtcPageKey = GtcViewKeys.WeightAndFuel;  
  
  private readonly aircraftWeight = ConsumerSubject.create(null, -1);  
  
  public readonly isCompleted = this.aircraftWeight.map(weight => weight >= 0) as Subscribable<boolean>;  
  
  public constructor(bus: EventBus) {  
    this.aircraftWeight.setConsumer(bus.getSubscriber<WeightFuelEvents>().on('weightfuel_aircraft_weight'));  
  }  
}
```

--------------------------------

### awaitInit()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/GPSSatComputer

Waits for this computer to complete its initialization process.

```APIDOC
## awaitInit()

### Description

Waits for this computer to complete initialization.

### Method

`GET`

### Returns

`Promise<void>` - A Promise which is fulfilled when this computer has completed initialization.
```

--------------------------------

### getStartAngularOffsetForTurnRadius

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the angular offset from the start of this turn to this turn's anchor point for a specified turn radius.

```APIDOC
## getStartAngularOffsetForTurnRadius(radius)

### Description
Gets the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle in radians, assuming this turn takes a given turn radius.

### Parameters
#### Path Parameters
- **radius** (number) - Required - The turn radius, in great-arc radians. The radius will be clamped to be greater than or equal to the minimum possible turn radius and less than or equal to the maximum possible turn radius. Values greater than `pi / 2` are acceptable (as long as they are not greater than the maximum possible turn radius) and represent a reversal of the normal direction for this turn.

### Returns
`number` - The angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle in radians, assuming this turn takes the specified turn radius.

### Throws
Error if this turn is not valid.
```

--------------------------------

### getStartAngularOffsetForMaxTurnRadius

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the angular offset from the start of this turn to this turn's anchor point, assuming the maximum possible turn radius.

```APIDOC
## getStartAngularOffsetForMaxTurnRadius()

### Description
Gets the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle in radians, assuming this turn takes the maximum possible turn radius.

### Returns
`number` - The angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle in radians, assuming this turn takes the maximum possible turn radius.

### Throws
Error if this turn is not valid.
```

--------------------------------

### setupDevPlan

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-shared/classes/DevPlan

Sets up a development flight plan for testing purposes using the provided FMS instance.

```APIDOC
## setupDevPlan(fms)

### Description
Temporary code to set up a dev flight plan for testing.

### Method
`static`

### Parameters
#### Path Parameters
- **fms** (`Epic2Fms`) - Required - The FMS instance to use.

### Returns
`Promise<void>`
A Promise that resolves when the dev plan setup is complete.
```

--------------------------------

### vnav_target_altitude

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-garminsdk/interfaces/BaseGarminVNavEvents

Gets the target altitude in feet for the currently active VNAV constraint. This is the altitude the VNAV system is guiding the aircraft towards.

```APIDOC
## vnav_target_altitude

### Description
The target altitude, in feet, of the currently active VNAV constraint. This is the altitude the VNAV system is guiding the aircraft towards.

### Type
`number`

### Inherited from
`BaseVNavEvents`.`vnav_target_altitude`
```

--------------------------------

### startTest()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-garminsdk/classes/AbstractTerrainSystem

Begins a self-test of this system.

```APIDOC
## startTest()

### Description
Begins a self-test of this system.

### Method
startTest

### Parameters
None

### Returns
`void`
```

--------------------------------

### Full MyInstrument Component Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/getting-started/creating-your-first-component

This shows the complete structure of a basic MSFS instrument, including imports, component rendering, and registration.

```typescript
/// <reference types="@microsoft/msfs-types/pages/vcockpit/core/vcockpit" />

import { FSComponent } from '@microsoft/msfs-sdk';
import { MyComponent } from './MyComponent';

class MyInstrument extends BaseInstrument {
  get templateID(): string {
    return 'MyInstrument';
  }

  public connectedCallback(): void {
    super.connectedCallback();

    FSComponent.render(<MyComponent />, document.getElementById('InstrumentContent'));
  }
}

registerInstrument('my-instrument', MyInstrument);

```

--------------------------------

### MFDSystemSetupPage Methods

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg1000/classes/MFDSystemSetupPage

Provides documentation for the public methods available on the MFDSystemSetupPage class, including accept, blur, close, and destroy.

```APIDOC
## Methods

### accept()

> **accept**(`result?`, `closeView?`): `void`

Confirms the view result and closes the view.

#### Parameters

Parameter| Type| Default value| Description
---|---|---|---
`result?`| `any`| `undefined`| Provide the view result if not already set.
`closeView?`| `boolean`| `true`| Indicates if the view should be closed after confirming the result.

#### Returns

`void`

* * *

### blur()

> **blur**(): `void`

Method to unfocus this control group.

#### Returns

`void`

* * *

### close()

> **close**(`quickclose`): `void`

Closes the view.

#### Parameters

Parameter| Type| Default value| Description
---|---|---|---
`quickclose`| `boolean`| `false`| bool stating whether to quickclose the child.

#### Returns

`void`

* * *

### destroy()

> **destroy**(): `void`

Destroys this component.
```

--------------------------------

### getTurnDirection

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/NavMath

Get the turn direction for a given course change. This function determines whether a turn from a start course to an end course is left or right.

```APIDOC
## getTurnDirection()

### Description
Get the turn direction for a given course change.

### Method
`static`

### Parameters
#### Path Parameters
- **startCourse** (number) - Required - The start course.
- **endCourse** (number) - Required - The end course.

### Returns
`"left"` | `"right"`
The turn direction for the course change.
```

--------------------------------

### getStartAngularOffset

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the angular offset from the start of this turn to this turn's anchoring intersection point, as measured along this turn's FROM circle in radians.

```APIDOC
## getStartAngularOffset()

### Description
Gets the angular offset from the start of this turn to this turn's anchoring intersection point, as measured along this turn's FROM circle in radians.

### Returns
`number`
The angular offset from the start of this turn to this turn's anchoring intersection point, as measured along this turn's FROM circle in radians.

### Throws
Error if this turn is not valid.
```

--------------------------------

### ontouchstart

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FsBaseInstrument

Optional callback for touch start events. Inherited from BaseInstrument.

```APIDOC
## ontouchstart

### Description
Optional callback for touch start events.

### Signature
`ontouchstart?: (this: FsBaseInstrument, ev: Event) => any | null`

### Inherited From
`BaseInstrument.ontouchstart`
```

--------------------------------

### Example Scratchpad Options Interface

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/framework-systems/fmc/configuring-a-scratchpad

This example shows a typical configuration for the FmcScratchpadOptions interface, as used in the WT21 system. It demonstrates setting various options like render row, cell width, delete text, and surrounding text.

```typescript
private static SCRATCHPAD_OPTIONS: Partial<FmcScratchpadOptions> = {
  renderRow: 13,
  cellWidth: 24,
  clearScratchpadOnError: true,
  deleteText: 'DELETE',
  errorTextCentered: true,
  surroundingText: ['__LSB[blue]', '__RSB[blue]'],
};
```

--------------------------------

### Programmatic Checklist Definition

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/framework-systems/checklist/checklist-api

Declare checklist definitions programmatically using the MSFS SDK. This example shows how to define a set of actionable items for engine start procedures.

```typescript
import { ChecklistItemType, ChecklistItemTypeDefMap, ChecklistSetDef } from '@microsoft/msfs-sdk';  
  
const checklistDef: ChecklistSetDef<ChecklistItemTypeDefMap, void, void, void> = {  
  groups: [  
    {  
      name: 'Normal Procedures',  
      lists: [  
        {  
          name: 'Before Engine Start',  
          items: [  
            {  
              type: ChecklistItemType.Actionable,  
              labelText: '1. Preflight inspection',  
              actionText: 'Completed'  
            },  
            {  
              type: ChecklistItemType.Actionable,  
              labelText: '2. Parking brake',  
              actionText: 'On'  
            },  
            {  
              type: ChecklistItemType.Actionable,  
              labelText: '3. Battery switch',  
              actionText: 'On'  
            },  
            {  
              type: ChecklistItemType.Actionable,  
              labelText: '4. Alternator switch',  
              actionText: 'On'  
            }  
          ],  
          metadata: undefined  
        }  
      ],  
      metadata: undefined  
    }  
  ],  
  metadata: undefined  
};  


```

--------------------------------

### StartupViewProps Interface Documentation

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3x/interfaces/StartupViewProps

This documentation details the properties available for the StartupViewProps interface. It outlines each property, its type, whether it's optional, and its description, including inherited properties.

```APIDOC
## Interface: StartupViewProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/StartupView/StartupView.tsx:19
Component props for StartupView.

## Extends
  * `UiViewProps`

## Properties

### children?
> `optional` **children** : `DisplayChildren`[]
Defined in: src/sdk/components/FSComponent.ts:125
The children of the display component.
#### Inherited from
`UiViewProps`.`children`
* * *

### containerRef
> **containerRef** : `NodeReference`<`HTMLElement`>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:18
A reference to the root element of the view's container.
#### Inherited from
`UiViewProps`.`containerRef`
* * *

### ref?
> `optional` **ref** : `NodeReference`<`any`>
Defined in: src/sdk/components/FSComponent.ts:128
A reference to the display component.
#### Inherited from
`UiViewProps`.`ref`
* * *

### rows?
> `optional` **rows** : readonly (`StartupViewRowFactory` | `StartupViewPrebuiltRow`)[]
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/StartupView/StartupView.tsx:25
An array of database rows to render in the view. Each row is defined by either a function which returns an object describing the row to render, or a pre-built row key. The rows will be rendered from top to bottom in the order in which they appear in the array. If not defined, a default set of rows will be rendered.
* * *

### uiService
> **uiService** : `UiService`
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:15
The UI service instance.
#### Inherited from
`UiViewProps`.`uiService`
```

--------------------------------

### init()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-garminsdk/classes/MultipleSoftKeyEnumController

Initializes the controller, creating and binding softkey menu items to the controller's state.

```APIDOC
## init()

### Description
Initializes this controller. This will create softkey menu items and bind them to this controller's state.

### Returns
`readonly SoftKeyMenuItem[]` - The softkey menu items bound to this controller's state. The order of the items is the same as the order of the softkey definitions passed to this controller's constructor.

### Throws
Error if this controller has been destroyed.
```

--------------------------------

### init()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg1000/classes/SoftKeyBooleanUserSettingController

Initializes the controller, creating and binding a softkey menu item to the user setting.

```APIDOC
## init()

### Description
Initializes this controller. This will create a softkey menu item and bind it to this controller's setting.

### Returns
`void`
```

--------------------------------

### getTurnRadiusForStartAngularOffset

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/FlightPathCircleToCircleTurn

Gets the radius of this turn, in great-arc radians, assuming the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, takes a given value.

```APIDOC
## getTurnRadiusForStartAngularOffset(angle)

### Description
Gets the radius of this turn, in great-arc radians, assuming the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, takes a given value.

### Method
`getTurnRadiusForStartAngularOffset(angle: number): number`

### Parameters
#### Path Parameters
- **angle** (number) - Required - The angular offset from the start of the turn to the anchor point, as measured along the FROM circle, in radians. The angular offset will be clamped to be greater than or equal to zero and less than or equal to the angular offset of the maximum-radius turn.

### Returns
- **number** - The radius of this turn, in great-arc radians, assuming the angular offset from the start of this turn to this turn's anchor point, as measured along this turn's FROM circle, takes the specified value.

### Throws
Error if this turn is not valid.
```

--------------------------------

### Option Inheritance Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/panel-xml-basics

Demonstrates how to use the 'inherit' attribute to define a base PfdLayout and inherit its properties in instrument-specific layouts.

```XML
<PfdLayout id="base-pfd-layout" use-banners="true" softkeys="true" />  
  
<Instrument>  
  <Name>WTG3000_PFD_1</Name>  
  
  <PfdLayout inherit="base-pfd-layout" instrument-side="right" />  
</Instrument>  
  
<Instrument>  
  <Name>WTG3000_PFD_2</Name>  
  
  <PfdLayout inherit="base-pfd-layout" instrument-side="left" />  
</Instrument>
```

--------------------------------

### start

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/NearestVorSubscription

Starts the NearestVorSubscription.

```APIDOC
## start

### Description
Starts the NearestVorSubscription.

### Method
start

### Returns
`Promise<void>`
```

--------------------------------

### Constructor

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg1000/classes/SelectApproachStore

Initializes a new instance of the SelectApproachStore class.

```APIDOC
## Constructor

> **new SelectApproachStore**(`facLoader`): `SelectApproachStore`

Constructor.

### Parameters

Parameter| Type| Description  
---|---|---
`facLoader`| `FacilityLoader`| The facility loader.  

### Returns

`SelectApproachStore`
```

--------------------------------

### started

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AbstractNearestSubscription

Checks if the nearest facility subscription has been started.

```APIDOC
## started

### Get Signature

> **get** **started**(): `boolean`

### Description
Whether or not this subscription has been started.

### Returns
`boolean` - True if started, false otherwise.

### Implementation of
`NearestSubscription`.`started`
```

--------------------------------

### SetupView Constructor

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3x/classes/SetupView

Creates an instance of a SetupView component. This is the primary way to initialize a new SetupView.

```APIDOC
## new SetupView(props: UiViewProps)

### Description
Creates an instance of a DisplayComponent.

### Parameters
#### Path Parameters
- **props** (UiViewProps) - Required - The propertis of the component.

### Returns
`SetupView`
```

--------------------------------

### Basic panel.xml File Structure

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/panel-xml-basics

This is an example of a simple panel.xml file, demonstrating the root element and multiple instrument declarations.

```xml
<PlaneHTMLConfig>
  
  <Instrument>
    <Name>WTG3000_PFD_1</Name>
  </Instrument>
  
  <Instrument>
    <Name>WTG3000_PFD_2</Name>
  </Instrument>
  
  <Instrument>
    <Name>WTG3000_MFD</Name>
  </Instrument>
  
  <Instrument>
    <Name>WTG3000_GTC_1</Name>
  </Instrument>
  
  <Instrument>
    <Name>WTG3000_GTC_2</Name>
  </Instrument>
  
</PlaneHTMLConfig>
```

--------------------------------

### ontouchstart

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Optional event handler for touch start events. Inherited from FsBaseInstrument.

```APIDOC
## ontouchstart

### Description
Optional event handler for touch start events.

### Signature
`optional ontouchstart : (this, ev) => any | null`

### Inherited from
`FsBaseInstrument.ontouchstart`
```

--------------------------------

### start

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/NearestUsrSubscription

Starts the NearestUsrSubscription. This method initiates the subscription process.

```APIDOC
## start

### Description
Starts the NearestUsrSubscription.

### Method
start

### Returns
`Promise<void>`
```

--------------------------------

### get instrumentIndex

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Gets the index of the instrument. This is inherited from FsBaseInstrument.

```APIDOC
## get instrumentIndex

### Description
Gets the numerical index of this instrument within its group.

### Method
```APIDOC
get
```

### Returns
`number`
```

--------------------------------

### init Method

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-shared/classes/DefaultRadioAltimeterDataProvider

Initializes this instrument.

```APIDOC
## Method: init

> **init**(): `void`

Initializes this instrument.

#### Returns
`void`

#### Implementation of
`Instrument.init`
```

--------------------------------

### onFlightStart

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3x/classes/G3XTouch

Called when the flight starts. Inherited from FsBaseInstrument.

```APIDOC
## onFlightStart(): void

### Description
Called when the flight starts.

### Returns
`void`
```

--------------------------------

### LNav Configuration Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/uns/panel-xml-tag-documentation

Sets the FMA (Annunciator) publish option for LNav.

```xml
<LNav index="1">
    <PublishFmaToLvar>True</PublishFmaToLvar>
  </LNav>
```

--------------------------------

### init

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-epic2-shared/classes/DefaultAirGroundDataProvider

Initializes the instrument, preparing it for operation.

```APIDOC
## init()

> **init**(): `void`

Initializes this instrument.

#### Returns

`void`
```

--------------------------------

### get flightPlanManager

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Gets the FlightPlanManager instance. This is inherited from FsBaseInstrument.

```APIDOC
## get flightPlanManager

### Description
Gets the FlightPlanManager instance used for managing flight plans.

### Method
```APIDOC
get
```

### Returns
`FlightPlanManager`
```

--------------------------------

### start

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/JetFadec

Turns this FADEC on and begins updating at the specified frequency.

```APIDOC
## start(frequency)

### Description
Turns this FADEC on. If this FADEC is already running, then it will be turned off before turning on again with the specified frequency.

### Parameters
#### Parameters
- **frequency** (number) - The frequency, in hertz, at which this FADEC will update.

### Returns
`void`
```

--------------------------------

### get facilityLoader

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Gets the FacilityLoader instance. This is inherited from FsBaseInstrument.

```APIDOC
## get facilityLoader

### Description
Gets the FacilityLoader instance used for loading facility data.

### Method
```APIDOC
get
```

### Returns
`FacilityLoader`
```

--------------------------------

### init()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wt21-fmc/classes/DirectToPageController

Initializes the DirectToPageController. This method should be called to set up the controller before use.

```APIDOC
## init()

### Description
Initializes the Controller

### Returns
`void`
```

--------------------------------

### get() Method

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/BasicNavAngleSubject

Gets the current navigation angle value.

```APIDOC
## Methods
### get()
> **get**(): `NumberUnitInterface`<`"navangle"`, `NavAngleUnit`>
Defined in: src/sdk/geo/NavAngle.ts:226
Gets this item's state.
#### Returns
`NumberUnitInterface`<`"navangle"`, `NavAngleUnit`>
This item's state.
#### Implementation of
`MutableSubscribable`.`get`
#### Overrides
`AbstractSubscribable`.`get`
```

--------------------------------

### get

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AbstractNearestSubscription

Gets an item from the array. This method is inherited from AbstractSubscribableArray.

```APIDOC
## get(index)

### Description
Gets an item from the array.

### Method
`get(index)`

### Parameters
#### Path Parameters
- **index** (number) - The index of the item to get.

### Returns
`T`
An item.

### Implementation of
`NearestSubscription.get`

### Inherited from
`AbstractSubscribableArray.get`
```

--------------------------------

### Constructor

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-pfd/classes/SvtSettingsSoftKeyMenu

Creates an instance of the SVT settings softkey menu.

```APIDOC
## Constructor

> **new SvtSettingsSoftKeyMenu**(`menuSystem`, `svtSettingManager`): `SvtSettingsSoftKeyMenu`

### Description
Creates an instance of the SVT settings softkey menu.

### Parameters
#### Parameters
- **menuSystem** (`SoftKeyMenuSystem`) - The softkey menu system.
- **svtSettingManager** (`UserSettingManager`<`SynVisUserSettingTypes`>) - A manager for synthetic vision user settings.

### Returns
`SvtSettingsSoftKeyMenu` - The created instance of the SVT settings softkey menu.

### Overrides
`SoftKeyMenu`.`constructor`
```

--------------------------------

### Display Pane Lifecycle Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3000/display-panes

Demonstrates using onResume and onResize to update font size based on pane size, and onUpdate to display the current time. This example adjusts font size for wider panes in full mode.

```typescript
import { DisplayPaneSizeMode, DisplayPaneView } from '@microsoft/msfs-wtg3000-common';  
  
export class TimePaneView extends DisplayPaneView {  
  private readonly style = ObjectSubject.create({  
    'font-size': '16px'  
  });  
  
  // ...  
  
  public onResume(size: DisplayPaneSizeMode): void {  
    this.updateFontSize(size);  
  }  
  
  public onResize(size: DisplayPaneSizeMode): void {  
    this.updateFontSize(size);  
  }  
  
  private updateFontSize(size: DisplayPaneSizeMode): void {  
    // Updates font size to take advantage of wider panes in full mode.  
    if (size === DisplayPaneSizeMode.Full) {  
      this.style.set('font-size', '24px');  
    } else {  
      this.style.set('font-size', '16px');  
    }  
  }  
  
  public onUpdate(time: number): void {  
    // Updates the displayed time string.  
    this.time.set(new Date(time).toUTCString())  
  }  
  
  public render(): VNode {  
    return (  
      <div style={this.style}>{this.time}</div>  
    );  
  }  
}
```

--------------------------------

### StartupLogo Methods

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg1000/classes/StartupLogo

Provides details on the methods available for the StartupLogo component.

```APIDOC
## Methods

### destroy()

> **destroy**(): `void`

Destroys this component.

### onAfterRender()

> **onAfterRender**(): `void`

A callback that is called after the component is rendered.

### onBeforeRender()

> **onBeforeRender**(): `void`

A callback that is called before the component is rendered.

### render()

> **render**(): `VNode`

Renders the component.

#### Returns
- `VNode` - A JSX element to be rendered.
```

--------------------------------

### start

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-sdk/classes/AbstractNearestSubscription

Starts this search. This method initiates the nearest search process.

```APIDOC
## start()

### Description
Starts this search.

### Method
`start()`

### Returns
`Promise<void>`

### Implementation of
`NearestSubscription.start`
```

--------------------------------

### Option Inheritance Example

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/avionics/g3xtouch/panel-xml-basics

Demonstrates how to define a base AirspeedIndicator and inherit its properties in multiple instruments.

```xml
<G3X>
  <AirspeedIndicator id="base-airspeed">
    <Scale min="30" max="999" window="60" major-tick-interval="10" minor-tick-factor="2">
  </AirspeedIndicator>
</G3X>

<Instrument>
  <Name>G3XTouch_1</Name>

  <AirspeedIndicator inherit="base-airspeed" />
    <VSpeedBugs>
      <Bug name="r" label="R" />
    </VSpeedBugs>
  </AirspeedIndicator>
</Instrument>

<Instrument>
  <Name>G3XTouch_2</Name>

  <AirspeedIndicator inherit="base-airspeed" />
    <VSpeedBugs>
      <Bug name="ref" label="REF" />
    </VSpeedBugs>
  </AirspeedIndicator>
</Instrument>
```

--------------------------------

### get instrumentIdentifier

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Gets the unique identifier for the instrument. This is inherited from FsBaseInstrument.

```APIDOC
## get instrumentIdentifier

### Description
Gets the unique identifier string for this instrument.

### Method
```APIDOC
get
```

### Returns
`string`
```

--------------------------------

### init()

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wt21-fmc/classes/PosInitPage

Initializes the page. Use this for setting up subscriptions and such. This method is inherited from WT21FmcPage.

```APIDOC
## init()

### Description
Initializes the page. Use this for setting up subscriptions and such.

### Method
void

### Returns
`void`
```

--------------------------------

### get initialized

Source: https://microsoft.github.io/msfs-avionics-mirror/2024/docs/api/%40microsoft/msfs-wtg3000-common/classes/WTG3000BaseInstrument

Gets the initialization state of the instrument. This is inherited from FsBaseInstrument.

```APIDOC
## get initialized

### Description
Gets a boolean indicating whether the instrument has been initialized.

### Method
```APIDOC
get
```

### Returns
`boolean`
```
Tokens:
Raw