Get Started Contact sales

    GoogleNavigation Framework Reference

    • GMSPath is an immutable class representing an ordered sequence of geographical coordinates, ideal for drawing lines or defining areas on a map.

    • It provides methods for creating paths, accessing individual coordinates, and encoding/decoding paths using the Google Maps Polyline Algorithm.

    • GMSPath allows for calculating path length and segment lengths using different metrics (e.g., geodesic or rhumb).

    • You can create a new path by offsetting each coordinate by specified latitude and longitude deltas.

    • A mutable version, GMSMutablePath , allows for modifying the coordinates of a path.

    GMSPath

      @interface 
 GMSPath 
 : 
 NSObject 
 < 
 NSCopying 
 , 
 NSMutableCopying 
 >

    GMSPath encapsulates an immutable array of CLLocationCooordinate2D . All the coordinates of a GMSPath must be valid. The mutable counterpart is GMSMutablePath .

    • Convenience constructor for an empty path.

      Declaration

      Objective-C

        + 
 ( 
 nonnull 
 instancetype 
 ) 
 path 
 ;

    • Initializes a newly allocated path with the contents of another GMSPath .

      Declaration

      Swift

        init 
 ( 
 path 
 : 
 GMSPath 
 )

      Objective-C

        - 
 ( 
 nonnull 
 id 
 ) 
 initWithPath 
 :( 
 nonnull 
 GMSPath 
 * 
 ) 
 path 
 ;

    • Get size of path.

      Declaration

      Swift

        func 
 count 
 () 
 -> 
 UInt

      Objective-C

        - 
 ( 
 NSUInteger 
 ) 
 count 
 ;

    • Returns kCLLocationCoordinate2DInvalid if index >= count.

      Declaration

      Swift

        func 
 coordinate 
 ( 
 at 
 index 
 : 
 UInt 
 ) 
 -> 
 CLLocationCoordinate2D

      Objective-C

        - 
 ( 
 CLLocationCoordinate2D 
 ) 
 coordinateAtIndex 
 :( 
 NSUInteger 
 ) 
 index 
 ;

    • Initializes a newly allocated path from -encodedPath . This format is described at: https://developers.google.com/maps/documentation/utilities/polylinealgorithm

      Declaration

      Swift

        convenience 
 init 
 ?( 
 fromEncodedPath 
 encodedPath 
 : 
 String 
 )

      Objective-C

        + 
 ( 
 nullable 
 instancetype 
 ) 
 pathFromEncodedPath 
 :( 
 nonnull 
 NSString 
 * 
 ) 
 encodedPath 
 ;

    • Returns an encoded string of the path in the format described above.

      Declaration

      Swift

        func 
 encodedPath 
 () 
 -> 
 String

      Objective-C

        - 
 ( 
 nonnull 
 NSString 
 * 
 ) 
 encodedPath 
 ;

    • Returns a new path obtained by adding deltaLatitude and deltaLongitude to each coordinate of the current path. Does not modify the current path.

      Declaration

      Swift

        func 
 pathOffset 
 ( 
 byLatitude 
 deltaLatitude 
 : 
 CLLocationDegrees 
 , 
 longitude 
 deltaLongitude 
 : 
 CLLocationDegrees 
 ) 
 -> 
 Self

      Objective-C

        - 
 ( 
 nonnull 
 instancetype 
 ) 
 pathOffsetByLatitude 
 :( 
 CLLocationDegrees 
 ) 
 deltaLatitude 
 longitude 
 :( 
 CLLocationDegrees 
 ) 
 deltaLongitude 
 ;

    GMSPathLength

    • Returns the fractional number of segments along the path that correspond to length , interpreted according to kind . See GMSLengthKind .

      Declaration

      Swift

        func 
 segments 
 ( 
 forLength 
 length 
 : 
 CLLocationDistance 
 , 
 kind 
 : 
  GMSLengthKind 
 
 ) 
 -> 
 Double

      Objective-C

        - 
 ( 
 double 
 ) 
 segmentsForLength 
 :( 
 CLLocationDistance 
 ) 
 length 
 kind 
 :( 
  GMSLengthKind 
 
 ) 
 kind 
 ;

    • Returns the length of the path, according to kind . See GMSLengthKind .

      Declaration

      Swift

        func 
 length 
 ( 
 of 
 kind 
 : 
  GMSLengthKind 
 
 ) 
 -> 
 CLLocationDistance

      Objective-C

        - 
 ( 
 CLLocationDistance 
 ) 
 lengthOfKind 
 :( 
  GMSLengthKind 
 
 ) 
 kind 
 ;
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: