Interface: FlightPlanDataArray
A subscribable array of flight plan data items describing how to display details of a flight plan in a list format.
Hierarchy
SubscribableArray<FlightPlanDataItem>↳
FlightPlanDataArray
Implemented by
Properties
cumulativeDataFields
• Readonly cumulativeDataFields: readonly Subscribable<null | FlightPlanDataField<FlightPlanDataFieldType>>[]
The data fields representing cumulative total values over this array's entire flight plan.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/FlightPlanDataArray.ts:17
fromLegIndex
• Readonly fromLegIndex: Subscribable<number>
The index of the data item associated with the FROM flight plan leg, or -1 if there is no such leg.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/FlightPlanDataArray.ts:11
length
• Readonly length: number
The length of this array.
Inherited from
SubscribableArray.length
Defined in
src/sdk/sub/SubscribableArray.ts:27
toLegIndex
• Readonly toLegIndex: Subscribable<number>
The index of the data item associated with the TO flight plan leg, or -1 if there is no such leg.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/FlightPlanDataArray.ts:14
Methods
get
▸ get(index): FlightPlanDataItem
Retrieves an element from this array.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the element. |
Returns
the element at the specified index.
Throws
Error if index is out of bounds.
Inherited from
SubscribableArray.get
Defined in
src/sdk/sub/SubscribableArray.ts:35
getArray
▸ getArray(): readonly FlightPlanDataItem[]
Gets a read-only version of this array.
Returns
readonly FlightPlanDataItem[]
a read-only version of this array.
Inherited from
SubscribableArray.getArray
Defined in
src/sdk/sub/SubscribableArray.ts:48
sub
▸ sub(handler, initialNotify?, paused?): Subscription
Subscribes to changes in this array's state.
Parameters
| Name | Type | Description |
|---|---|---|
handler | SubscribableArrayHandler<FlightPlanDataItem> | A function which is called when this array's state changes. |
initialNotify? | boolean | Whether to immediately invoke the callback function with this array's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false. |
Returns
Subscription
The new subscription.
Inherited from
SubscribableArray.sub
Defined in
src/sdk/sub/SubscribableArray.ts:58
tryGet
▸ tryGet(index): undefined | FlightPlanDataItem
Attempts to retrieve an element from this array.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the element. |
Returns
undefined | FlightPlanDataItem
the element at the specified index, or undefined if index is out of bounds.
Inherited from
SubscribableArray.tryGet
Defined in
src/sdk/sub/SubscribableArray.ts:42
unsub
▸ unsub(handler): void
Unsubscribes a callback function from this array.
Parameters
| Name | Type | Description |
|---|---|---|
handler | SubscribableArrayHandler<FlightPlanDataItem> | The function to unsubscribe. |
Returns
void
Deprecated
This method has been deprecated in favor of using the Subscription object returned by .sub()
to manage subscriptions.
Inherited from
SubscribableArray.unsub
Defined in
src/sdk/sub/SubscribableArray.ts:66