@maplibre/native-ffi
    Preparing search index...

    Variable CameraTransitionOutcomeConst

    CameraTransitionOutcome: { cancelled: 1; closed: 2; completed: 0; replaced: 3 } = ...

    How a camera change ended.

    A change that ends in more than one way reports CameraTransitionOutcome.cancelled if any of it was cancelled, and otherwise CameraTransitionOutcome.replaced if any of it was replaced.

    See mln_camera_transition_outcome in the C API reference.

    Type Declaration

    • Readonlycancelled: 1

      MapHandle.cancelCameraTransitions(), MapHandle.cancelCameraTransitionsWithId(), a gesture's GesturePhase.begin or GesturePhase.cancel, MapHandle.setFreeCameraOptions(), or a resize that moved the camera back inside its bounds stopped the change. A command that fails before it moves the camera also reports this.

    • Readonlyclosed: 2

      The map closed before the change ended.

    • Readonlycompleted: 0

      The camera finished the change.

    • Readonlyreplaced: 3

      A later camera change set every field that a part of the change was still animating, so that part stopped. Its other parts keep animating, and the change reports this outcome when they end, unless one was cancelled.

      A later change that sets only some of those fields leaves the change animating the rest. A fly's center and zoom count as one field, and so do an anchored change's center and the fields that the anchor holds in place.

    Settings
    Member Visibility