Skip to main content

Interface: PlanEvents

Defined in: src/sdk/flightplan/FlightPlan.ts:57

Events generated by changes in the flight plan.

Methods

onActiveLegChanged()?

optional onActiveLegChanged(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

ParameterTypeDescription
indexnumberThe global index of the leg.
segmentIndexnumberThe index of the flight plan segment.
legIndexnumber-
previousSegmentIndexnumberThe index of the previously active segment.
previousLegIndexnumberThe index of the previously active leg in the previously active segment.
typeActiveLegTypeThe 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()?

optional onBatchAsyncClosed(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

ParameterTypeDescription
batchReadonly<FlightPlanModBatch>The batch that was closed.

Returns

void


onBatchClosed()?

optional onBatchClosed(batch): void

Defined in: src/sdk/flightplan/FlightPlan.ts:190

A callback which is executed when a flight plan modification batch is closed.

Parameters

ParameterTypeDescription
batchReadonly<FlightPlanModBatch>The batch that was closed.

Returns

void


onBatchOpened()?

optional onBatchOpened(batch): void

Defined in: src/sdk/flightplan/FlightPlan.ts:184

A callback which is executed when a flight plan modification batch is opened.

Parameters

ParameterTypeDescription
batchReadonly<FlightPlanModBatch>The batch that was opened.

Returns

void


onCalculated()?

optional onCalculated(index?, batch?): void

Defined in: src/sdk/flightplan/FlightPlan.ts:178

A callback which is executed when a flight plan vectorization completes.

Parameters

ParameterTypeDescription
index?numberThe 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()?

optional onCalculatePended(index?, batch?): void

Defined in: src/sdk/flightplan/FlightPlan.ts:170

A callback which is executed when a flight plan vectorization begins.

Parameters

ParameterTypeDescription
index?numberThe 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()?

optional onDirectDataChanged(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

ParameterTypeDescription
directToDataDirectToDataThe 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()?

optional onLegChanged(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

ParameterTypeDescription
segmentIndexnumberThe index of the segment containing the changed flight plan leg.
segmentLegIndexnumberThe index of the changed flight plan leg in its containing segment.
typeLegEventTypeThe type of change.
legLegDefinitionThe 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()?

optional onLegUserDataDelete(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

ParameterTypeDescription
segmentIndexnumberThe index of the segment containing the user data's flight plan leg.
segmentLegIndexnumberThe index of the user data's flight plan leg in its containing segment.
legLegDefinitionThe user data's flight plan leg.
keystringThe 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()?

optional onLegUserDataSet(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

ParameterTypeDescription
segmentIndexnumberThe index of the segment containing the user data's flight plan leg.
segmentLegIndexnumberThe index of the user data's flight plan leg in its containing segment.
legLegDefinitionThe user data's flight plan leg.
keystringThe key of the user data.
dataanyThe 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()?

optional onOriginDestChanged(type, airport?, batch?): void

Defined in: src/sdk/flightplan/FlightPlan.ts:106

A callback which is executed when the origin or destination changes.

Parameters

ParameterTypeDescription
typeOriginDestChangeTypeThe origin/destination change type.
airport?stringThe 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()?

optional onProcedureDetailsChanged(details, batch?): void

Defined in: src/sdk/flightplan/FlightPlan.ts:114

A callback which is executed when the procedure details change.

Parameters

ParameterTypeDescription
detailsProcedureDetailsThe 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()?

optional onSegmentChanged(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

ParameterTypeDescription
indexnumberThe index of the changed flight plan segment.
typeSegmentEventTypeThe type of change.
segment?FlightPlanSegmentThe 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()?

optional onUserDataDelete(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

ParameterTypeDescription
keystringThe 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()?

optional onUserDataSet(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

ParameterTypeDescription
keystringThe key of the user data.
dataanyThe 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