Viewport Class Reference


                    
                    
                    options

Configuration options for adjusting the viewport’s behavior.

Declaration

Swift

public var options: ViewportOptions { get set }


                    
                    
                    status

The current ViewportStatus.

status cannot be set directly. Use transition(to:transition:completion:) and idle() to transition to a state or to idle.

Defaults to idle.

Declaration

Swift

public var status: ViewportStatus { get }


                    
                    
                    addStatusObserver(_:)

Subscribes a ViewportStatusObserver to status changes.

Viewport keeps a strong reference to registered observers. Adding the same observer again while it is already subscribed has no effect.

Note

Observers are notified of status changes asynchronously on the main queue. This means that by the time the notification is delivered, the status may have already changed again. This behavior is necessary to allow observers to trigger further transitions while avoiding out-of-order delivery of status changed notifications.

Declaration

Swift

public func addStatusObserver(_ observer: ViewportStatusObserver)

Parameters


                                  observer

An object that will be notified when the status changes.


                    
                    
                    removeStatusObserver(_:)

Unsubscribes a ViewportStatusObserver from status changes. This causes viewport to release its strong reference to the observer. Removing an observer that is not subscribed has no effect.

Declaration

Swift

public func removeStatusObserver(_ observer: ViewportStatusObserver)

Parameters


                                  observer

An object that should no longer be notified when the status changes.


                    
                    
                    idle()

Sets status to idle synchronously.

This cancels any active ViewportState or ViewportTransition.

Declaration

Swift

public func idle()


                    
                    
                    transition(to:transition:completion:)

Executes a transition to the requested state.

If the transition fails, status is set to idle.

Transitioning to state x when the status is .state(x) invokes completion synchronously with true and does not modify status.

Transitioning to state x when the status is .transition(_, x) invokes completion synchronously with false and does not modify status.

Viewport keeps a strong reference to active transitions and states. To reuse states and transitions, keep strong references to them in the consuming project.

Declaration

Swift

public func transition(to toState: ViewportState,
                       transition: ViewportTransition? = nil,
                       completion: ((_ success: Bool) -> Void)? = nil)

Parameters

`toState`	The target `ViewportState` to transition to.
`transition`	The `ViewportTransition` that is used to transition to the target state. If `nil`, `defaultTransition` is used. Defaults to `nil`.
`completion`	A closure that is invoked when the transition ends. Defaults to `nil`.
`success`	Whether the transition ran to completion. Transitions may end early if they fail or are interrupted (e.g. by another call to `transition(to:transition:completion:)` or `idle()`)


                    
                    
                    defaultTransition

transition(to:transition:completion:) uses this transition unless some non-nil value is passed to its transition argument.

Defaults to DefaultViewportTransition with default options.

Declaration

Swift

public var defaultTransition: ViewportTransition { get set }


                    
                    
                    makeFollowPuckViewportState(options:)

Creates a new instance of FollowPuckViewportState with the specified options.

Declaration

Swift

public func makeFollowPuckViewportState(options: FollowPuckViewportStateOptions = .init()) -> FollowPuckViewportState

Parameters


                                  options

configuration options used when creating FollowPuckViewportState. Defaults to FollowPuckViewportStateOptions/init(padding:zoom:bearing:pitch:animationDuration:) with the default value specified for all parameters.

Return Value

The newly-created FollowPuckViewportState.


                    
                    
                    makeOverviewViewportState(options:)

Creates a new instance of OverviewViewportState with the specified options.

Declaration

Swift

public func makeOverviewViewportState(options: OverviewViewportStateOptions) -> OverviewViewportState

Parameters


                                  options

configuration options used when creating OverviewViewportState.

Return Value

The newly-created OverviewViewportState.


                    
                    
                    makeDefaultViewportTransition(options:)

Creates a new instance of DefaultViewportTransition.

Declaration

Swift

public func makeDefaultViewportTransition(options: DefaultViewportTransitionOptions = .init()) -> DefaultViewportTransition

Parameters


                                  options

configuration options used when creating DefaultViewportTransition. Defaults to init(maxDuration:) with the default value specified for all parameters

Return Value

The newly-created DefaultViewportTransition.


                    
                    
                    makeImmediateViewportTransition()

Creates a new instance of ImmediateViewportTransition.

Declaration

Swift

public func makeImmediateViewportTransition() -> ImmediateViewportTransition

Return Value

The newly-created ImmediateViewportTransition.