Interface: PlanEvents
Defined in: src/sdk/flightplan/FlightPlan.ts:57
Events generated by changes in the flight plan.
Methods
onActiveLegChanged()?
optionalonActiveLegChanged(index,segmentIndex,legIndex,previousSegmentIndex,previousLegIndex,type,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:89
A callback which is executed when an active leg is changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The global index of the leg. |
segmentIndex | number | The index of the flight plan segment. |
legIndex | number | - |
previousSegmentIndex | number | The index of the previously active segment. |
previousLegIndex | number | The index of the previously active leg in the previously active segment. |
type | ActiveLegType | The type of leg that was changed. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onBatchAsyncClosed()?
optionalonBatchAsyncClosed(batch):void
Defined in: src/sdk/flightplan/FlightPlan.ts:197
A callback which is executed when a flight plan modification batch has been closed and all pending asynchronous operations assigned to the batch have finished.
Parameters
| Parameter | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was closed. |
Returns
void
onBatchClosed()?
optionalonBatchClosed(batch):void
Defined in: src/sdk/flightplan/FlightPlan.ts:190
A callback which is executed when a flight plan modification batch is closed.
Parameters
| Parameter | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was closed. |
Returns
void
onBatchOpened()?
optionalonBatchOpened(batch):void
Defined in: src/sdk/flightplan/FlightPlan.ts:184
A callback which is executed when a flight plan modification batch is opened.
Parameters
| Parameter | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was opened. |
Returns
void
onCalculated()?
optionalonCalculated(index?,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:178
A callback which is executed when a flight plan vectorization completes.
Parameters
| Parameter | Type | Description |
|---|---|---|
index? | number | The global index of the flight plan leg that the path was generated from. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the calculation was assigned, in order of increasing nestedness. Not defined if the calculation was not assigned to any batches. |
Returns
void
onCalculatePended()?
optionalonCalculatePended(index?,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:170
A callback which is executed when a flight plan vectorization begins.
Parameters
| Parameter | Type | Description |
|---|---|---|
index? | number | The global index of the flight plan leg that the path is to be generated from. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the calculation was assigned, in order of increasing nestedness. Not defined if the calculation was not assigned to any batches. |
Returns
void
onDirectDataChanged()?
optionalonDirectDataChanged(directToData,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:162
A callback which is executed when direct to data is changed in the plan.
Parameters
| Parameter | Type | Description |
|---|---|---|
directToData | DirectToData | The direct to data. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onLegChanged()?
optionalonLegChanged(segmentIndex,segmentLegIndex,type,leg,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:67
A callback which is executed when a flight plan leg is added, removed, or its vertical data is changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment containing the changed flight plan leg. |
segmentLegIndex | number | The index of the changed flight plan leg in its containing segment. |
type | LegEventType | The type of change. |
leg | LegDefinition | The leg that was changed. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onLegUserDataDelete()?
optionalonLegUserDataDelete(segmentIndex,segmentLegIndex,leg,key,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:154
A callback which is executed when a flight plan leg key-value user data pair is deleted.
Parameters
| Parameter | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment containing the user data's flight plan leg. |
segmentLegIndex | number | The index of the user data's flight plan leg in its containing segment. |
leg | LegDefinition | The user data's flight plan leg. |
key | string | The key of the user data that was deleted. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onLegUserDataSet()?
optionalonLegUserDataSet(segmentIndex,segmentLegIndex,leg,key,data,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:143
A callback which is executed when a flight plan leg key-value user data pair is set.
Parameters
| Parameter | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment containing the user data's flight plan leg. |
segmentLegIndex | number | The index of the user data's flight plan leg in its containing segment. |
leg | LegDefinition | The user data's flight plan leg. |
key | string | The key of the user data. |
data | any | The data that was set. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onOriginDestChanged()?
optionalonOriginDestChanged(type,airport?,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:106
A callback which is executed when the origin or destination changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
type | OriginDestChangeType | The origin/destination change type. |
airport? | string | The airport that was changed. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onProcedureDetailsChanged()?
optionalonProcedureDetailsChanged(details,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:114
A callback which is executed when the procedure details change.
Parameters
| Parameter | Type | Description |
|---|---|---|
details | ProcedureDetails | The details that were changed. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onSegmentChanged()?
optionalonSegmentChanged(index,type,segment?,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:77
A callback which is executed when a flight plan segment is added, removed, or changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the changed flight plan segment. |
type | SegmentEventType | The type of change. |
segment? | FlightPlanSegment | The segment that was changed. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onUserDataDelete()?
optionalonUserDataDelete(key,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:131
A callback which is executed when a global key-value user data pair is deleted.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key of the user data that was deleted. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void
onUserDataSet()?
optionalonUserDataSet(key,data,batch?):void
Defined in: src/sdk/flightplan/FlightPlan.ts:123
A callback which is executed when a global key-value user data pair is set.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key of the user data. |
data | any | The user data that was set. |
batch? | readonly Readonly<FlightPlanModBatch>[] | The modification batch stack to which the change was assigned, in order of increasing nestedness. Not defined if the change was not assigned to any batches. |
Returns
void