TomTom SDK for iOS AnnotationsActions

AnnotationsActions

public protocol AnnotationsActions

A protocol that defines map annotation actions.

Important

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

  • Adds a new circle on the map using the CircleOptions.

    Throws

    An AnnotationServiceError.

    Declaration

    Swift

    func addCircle(options: CircleOptions) throws -> Circle

    Parameters

    options

    The circle options.

    Return Value

    A Circle instance.

  • Adds a new line on the map using the LineOptions.

    Throws

    An AnnotationServiceError.

    Declaration

    Swift

    func addLine(options: LineOptions) throws -> Line

    Parameters

    options

    The line options.

    Return Value

    A Line instance.

  • Adds a new marker on the map using the MarkerOptions.

    Throws

    An AnnotationServiceError.

    Declaration

    Swift

    func addMarker(options: MarkerOptions) throws -> Marker

    Parameters

    options

    The marker options.

    Return Value

    A Marker instance.

  • Adds a new polygon on the map using the PolygonOptions.

    Throws

    An AnnotationServiceError.

    Declaration

    Swift

    func addPolygon(options: PolygonOptions) throws -> Polygon

    Parameters

    options

    The polygon options.

    Return Value

    A Polygon instance.

  • Adds a new polygon overlay (nested polygons) on the map using the PolygonOverlayOptions.

    Throws

    An AnnotationServiceError.

    Important

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

    Declaration

    Swift

    func addPolygonOverlay(options: PolygonOverlayOptions) throws -> PolygonOverlay

    Parameters

    options

    The polygon options.

    Return Value

    A PolygonOverlay instance.

  • Deselects an annotation. You can provide view for selected annotation in MapDataSource.

    Declaration

    Swift

    func deselect(annotation: Annotation)

  • Toggle fading effect for markers.

    Declaration

    Swift

    var isMarkersFadingEnabled: Bool { get set }

  • Toggle shrinking effect for markers.

    Declaration

    Swift

    var isMarkersShrinkingEnabled: Bool { get set }

  • Removes a given annotation from the map.

    Declaration

    Swift

    func remove(annotation: Annotation)

    Parameters

    annotation

    The annotation that will be removed.

  • Removes all annotations from the map.

    Declaration

    Swift

    func removeAnnotations()

  • Removes annotation having a particular tag from the map.

    Declaration

    Swift

    func removeAnnotations(tag: String)

    Parameters

    tag

    Describing the annotation group.

  • Selects an annotation. You can provide view for selected annotation in MapDataSource.

    Declaration

    Swift

    func select(annotation: Annotation)

  • Sets the parameters of markers’ fading with distance effect.

    Declaration

    Swift

    func setMarkerDistanceFadingRange(range: ClosedRange<Measurement<UnitLength>>)

    Parameters

    range

    Minimum range distance when fading starts. It should be less than or equal to the maximum. Maximum range distance when a marker is fully transparent. It should be greater than or equal to the minimum.

  • Sets the parameters of markers’ shrinking with distance effect.

    Declaration

    Swift

    func setMarkerDistanceShrinkingRange(range: ClosedRange<Measurement<UnitLength>>)

    Parameters

    range

    Minimum range distance when fading starts. It should be less than or equal to the maximum. Maximum range distance when a marker is fully transparent. It should be greater than or equal to the minimum.

  • Zooms to a view containing all markers on the map. Creates coordinate bounds and passes it to FitToCoordinatesOptions to update camera with a one-second animation duration.

    Declaration

    Swift

    func zoomToMarkers()

  • Zooms to a view containing all markers on the map with padding in px. Creates coordinate bounds and passes them to FitToCoordinatesOptions to update the camera with a one-second animation duration.

    Declaration

    Swift

    func zoomToMarkers(marginPx: UInt)

    Parameters

    marginPx

    The margin in pixels.

  • Zooms to a view containing all markers on the map with padding in px. Creates coordinate bounds and passes them to FitToCoordinatesOptions to update the camera with a one-second animation duration.

    Declaration

    Swift

    func zoomToMarkers(marginPx: UInt, tag: String)

  • Zooms to a view containing all markers on the map.

    Declaration

    Swift

    func zoomToMarkers(tag: String)

    Parameters

    tag

    Describing the annotation group.