docs(api): document encoded polylines on Android

tidev · Oct 12, 2020 · 077abbd · 077abbd
1 parent d655255
commit 077abbd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/apidoc/Polyline.yml b/apidoc/Polyline.yml
@@ -22,9 +22,9 @@ properties:
     since: "5.1.0"
 
   - name: points
-    summary: Array of map points making up the polyline. Can also be an array of longitude (index 0), latitude (index 1) touples.
+    summary: Array of map points making up the polyline. Can also be an array of longitude (index 0), latitude (index 1) touples. On Android platform you can use an encoded polyline as string.
     availability: creation
-    type: Array<MapPointType>
+    type: [Array<MapPointType>, String]
     optional: false
 
   - name: strokeColor

diff --git a/apidoc/Route.yml b/apidoc/Route.yml
@@ -10,14 +10,19 @@ description: |
     ### iOS Platform Notes
 
     The `addRoute` method no longer accepts a dictionary as a parameter. Pass a <Modules.Map.Route> object instead.
+    
+    ### Android Platform Notes
+    The parameter `points` accepts additional the route in format `encoded polyline`.  
+    https://developers.google.com/maps/documentation/utilities/polylinealgorithm 
+    
 extends: Titanium.Proxy
 since: { android: "3.1.0", iphone: "3.2.0", ipad: "3.2.0", macos: "9.2.0" }
 platforms: [android, iphone, ipad, macos]
 properties:
   - name: points
     summary: Array of map points making up the route.
     availability: creation
-    type: Array<MapPointType>
+    type: [String, Array<MapPointType>]
     optional: false
 
   - name: color