mirror of
				https://github.com/public-transport/db-vendo-client.git
				synced 2025-10-31 08:06:33 +02:00 
			
		
		
		
	docs for new polyline format 📝
This commit is contained in:
		
							parent
							
								
									431574b756
								
							
						
					
					
						commit
						8c896fe8c1
					
				
					 3 changed files with 65 additions and 3 deletions
				
			
		|  | @ -118,4 +118,66 @@ The response looked like this: | ||||||
| } | } | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| If you pass `polyline: true`, the leg will have a `polyline` field, containing an encoded shape. You can use e.g. [`@mapbox/polyline`](https://www.npmjs.com/package/@mapbox/polyline) to decode it. | ### `polyline` option | ||||||
|  | 
 | ||||||
|  | If you pass `polyline: true`, the leg will have a `polyline` field, containing a [GeoJSON](http://geojson.org) [`FeatureCollection`](https://tools.ietf.org/html/rfc7946#section-3.3) of [`Point`s](https://tools.ietf.org/html/rfc7946#appendix-A.1). Every `Point` next to a station will have `properties` containing the station's metadata. | ||||||
|  | 
 | ||||||
|  | We'll look at an example for *U6* from *Alt-Mariendorf* to *Alt-Tegel*, taken from the [VBB profile](../p/vbb): | ||||||
|  | 
 | ||||||
|  | ```js | ||||||
|  | { | ||||||
|  | 	type: 'FeatureCollection', | ||||||
|  | 	features: [ | ||||||
|  | 		{ | ||||||
|  | 			type: 'Feature', | ||||||
|  | 			properties: { | ||||||
|  | 				type: 'station', | ||||||
|  | 				id: '900000070301', | ||||||
|  | 				name: 'U Alt-Mariendorf', | ||||||
|  | 				/* … */ | ||||||
|  | 			}, | ||||||
|  | 			geometry: { | ||||||
|  | 				type: 'Point', | ||||||
|  | 				coordinates: [13.3875, 52.43993] // longitude, latitude | ||||||
|  | 			} | ||||||
|  | 		}, | ||||||
|  | 		/* … */ | ||||||
|  | 		{ | ||||||
|  | 			type: 'Feature', | ||||||
|  | 			properties: { | ||||||
|  | 				type: 'station', | ||||||
|  | 				id: '900000017101', | ||||||
|  | 				name: 'U Mehringdamm', | ||||||
|  | 				/* … */ | ||||||
|  | 			}, | ||||||
|  | 			geometry: { | ||||||
|  | 				type: 'Point', | ||||||
|  | 				coordinates: [13.38892, 52.49448] // longitude, latitude | ||||||
|  | 			} | ||||||
|  | 		}, | ||||||
|  | 		/* … */ | ||||||
|  | 		{ | ||||||
|  | 			// intermediate point, without associated station | ||||||
|  | 			type: 'Feature', | ||||||
|  | 			properties: {}, | ||||||
|  | 			geometry: { | ||||||
|  | 				type: 'Point', | ||||||
|  | 				coordinates: [13.28599, 52.58742] // longitude, latitude | ||||||
|  | 			} | ||||||
|  | 		}, | ||||||
|  | 		{ | ||||||
|  | 			type: 'Feature', | ||||||
|  | 			properties: { | ||||||
|  | 				type: 'station', | ||||||
|  | 				id: '900000089301', | ||||||
|  | 				name: 'U Alt-Tegel', | ||||||
|  | 				/* … */ | ||||||
|  | 			}, | ||||||
|  | 			geometry: { | ||||||
|  | 				type: 'Point', | ||||||
|  | 				coordinates: [13.28406, 52.58915] // longitude, latitude | ||||||
|  | 			} | ||||||
|  | 		} | ||||||
|  | 	] | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | @ -262,4 +262,4 @@ departure of last journey 2017-12-17T19:07:00.000+01:00 | ||||||
| departure of first (later) journey 2017-12-17T19:19:00.000+01:00 | departure of first (later) journey 2017-12-17T19:19:00.000+01:00 | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| If you pass `polylines: true`, each journey leg will have a `polyline` field, containing an encoded shape. You can use e.g. [`@mapbox/polyline`](https://www.npmjs.com/package/@mapbox/polyline) to decode it. | If you pass `polylines: true`, each journey leg will have a `polyline` field. Refer to [the section in the `journeyLeg()` docs](journey-leg.md#polyline-option) for details. | ||||||
|  |  | ||||||
|  | @ -163,4 +163,4 @@ The response may look like this: | ||||||
| }, /* … */ ] | }, /* … */ ] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| If you pass `polylines: true`, each result will have a `polyline` field, containing an encoded shape. You can use e.g. [`@mapbox/polyline`](https://www.npmjs.com/package/@mapbox/polyline) to decode it. | If you pass `polylines: true`, each journey leg will have a `polyline` field, as documented in [the corresponding section in the `journeyLeg()` docs](journey-leg.md#polyline-option), with the exception that station info is missing. | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		
		Reference in a new issue