Interface: PlanEvents
Events generated by changes in the flight plan.
Methods
onActiveLegChanged
▸ onActiveLegChanged(index, segmentIndex, legIndex, previousSegmentIndex, previousLegIndex, type, batch?): void
A callback which is executed when an active leg is changed.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:89
onBatchAsyncClosed
▸ onBatchAsyncClosed(batch): void
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
| Name | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was closed. |
Returns
void
Defined in
src/sdk/flightplan/FlightPlan.ts:197
onBatchClosed
▸ onBatchClosed(batch): void
A callback which is executed when a flight plan modification batch is closed.
Parameters
| Name | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was closed. |
Returns
void
Defined in
src/sdk/flightplan/FlightPlan.ts:190
onBatchOpened
▸ onBatchOpened(batch): void
A callback which is executed when a flight plan modification batch is opened.
Parameters
| Name | Type | Description |
|---|---|---|
batch | Readonly<FlightPlanModBatch> | The batch that was opened. |
Returns
void
Defined in
src/sdk/flightplan/FlightPlan.ts:184
onCalculatePended
▸ onCalculatePended(index?, batch?): void
A callback which is executed when a flight plan vectorization begins.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:170
onCalculated
▸ onCalculated(index?, batch?): void
A callback which is executed when a flight plan vectorization completes.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:178
onDirectDataChanged
▸ onDirectDataChanged(directToData, batch?): void
A callback which is executed when direct to data is changed in the plan.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:162
onLegChanged
▸ onLegChanged(segmentIndex, segmentLegIndex, type, leg, batch?): void
A callback which is executed when a flight plan leg is added, removed, or its vertical data is changed.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:67
onLegUserDataDelete
▸ onLegUserDataDelete(segmentIndex, segmentLegIndex, leg, key, batch?): void
A callback which is executed when a flight plan leg key-value user data pair is deleted.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:154
onLegUserDataSet
▸ onLegUserDataSet(segmentIndex, segmentLegIndex, leg, key, data, batch?): void
A callback which is executed when a flight plan leg key-value user data pair is set.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:143
onOriginDestChanged
▸ onOriginDestChanged(type, airport?, batch?): void
A callback which is executed when the origin or destination changes.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:106
onProcedureDetailsChanged
▸ onProcedureDetailsChanged(details, batch?): void
A callback which is executed when the procedure details change.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:114
onSegmentChanged
▸ onSegmentChanged(index, type, segment?, batch?): void
A callback which is executed when a flight plan segment is added, removed, or changed.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:77
onUserDataDelete
▸ onUserDataDelete(key, batch?): void
A callback which is executed when a global key-value user data pair is deleted.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:131
onUserDataSet
▸ onUserDataSet(key, data, batch?): void
A callback which is executed when a global key-value user data pair is set.
Parameters
| Name | 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
Defined in
src/sdk/flightplan/FlightPlan.ts:123