TomTom SDK for iOS CompassButtonViewModel

CompassButtonViewModel

public class CompassButtonViewModel

View Model for CompassButton.

Important

This is a Public Preview API. It may be changed or removed at any time.

  • Defines the visibility policy of the compass button.

    See more

    Declaration

    Swift

    public enum VisibilityPolicy

  • Defines the visibility policy of the compass button.

    Declaration

    Swift

    public var visibilityPolicy: VisibilityPolicy { get set }

  • Reports whether the view is currently visible on the screen.

    Declaration

    Swift

    public private(set) var isVisible: Bool { get set }

  • Defines the custom icon that is displayed when the compass moves to a north up position and before it becomes transparent. The icon will not be changed immediately if the compass is rotated. If this property is not set, default icons are used.

    Declaration

    Swift

    public var northUpIcon: UIImage? { get set }

  • Defines the offset of the view. You can specify horizontal and vertical offset to shift view from an original position.

    Declaration

    Swift

    public var offset: UIOffset { get set }

  • Defines the custom icon that is displayed when the map is rotated. The icon will not be changed immediately if the compass is not rotated. If this property is not set, default icons are used.

    Declaration

    Swift

    public var icon: UIImage? { get set }