Skip to content

Commit 94332cb

Browse files
committed
update documentation
1 parent 251e55e commit 94332cb

File tree

2 files changed

+82
-3
lines changed

2 files changed

+82
-3
lines changed

docs/classes/DantSu/OpenStreetMapStaticAPI/OpenStreetMap.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ DantSu\OpenStreetMapStaticAPI\OpenStreetMap is a PHP library created for easily
2222
- [addMarkers](#-addmarkers)
2323
- [addDraw](#-adddraw)
2424
- [fitToDraws](#-fittodraws)
25+
- [fitToMarkers](#-fittomarkers)
26+
- [fitToMarkersAndDraws](#-fittomarkersanddraws)
27+
- [fitToPoints](#-fittopoints)
2528
- [getMapData](#-getmapdata)
2629
- [getImage](#-getimage)
2730

@@ -211,6 +214,82 @@ Fit map to draws.
211214

212215

213216

217+
---
218+
### ->fitToMarkers
219+
220+
Fit map to markers.
221+
222+
223+
224+
225+
226+
227+
228+
229+
#### Parameters:
230+
231+
| Parameter | Type | Description |
232+
|-----------|------|-------------|
233+
| `padding` | **int** | Padding in pixel |
234+
235+
236+
#### Return Value:
237+
238+
**$this** : Fluent interface
239+
240+
241+
242+
---
243+
### ->fitToMarkersAndDraws
244+
245+
Fit map to draws and markers.
246+
247+
248+
249+
250+
251+
252+
253+
254+
#### Parameters:
255+
256+
| Parameter | Type | Description |
257+
|-----------|------|-------------|
258+
| `padding` | **int** | Padding in pixel |
259+
260+
261+
#### Return Value:
262+
263+
**$this** : Fluent interface
264+
265+
266+
267+
---
268+
### ->fitToPoints
269+
270+
Fit map to an array of points.
271+
272+
273+
274+
275+
276+
277+
278+
279+
#### Parameters:
280+
281+
| Parameter | Type | Description |
282+
|-----------|------|-------------|
283+
| `points` | **\DantSu\OpenStreetMapStaticAPI\LatLng[]** | LatLng points |
284+
| `padding` | **int** | Padding in pixel |
285+
286+
287+
#### Return Value:
288+
289+
**$this** : Fluent interface
290+
291+
292+
214293
---
215294
### ->getMapData
216295

src/OpenStreetMap.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public function fitToDraws(int $padding = 0)
135135
}
136136

137137
/**
138-
* Fit map to draws.
138+
* Fit map to markers.
139139
*
140140
* @param int $padding Padding in pixel
141141
* @return $this Fluent interface
@@ -150,7 +150,7 @@ public function fitToMarkers(int $padding = 0)
150150
}
151151

152152
/**
153-
* Fit map to draws.
153+
* Fit map to draws and markers.
154154
*
155155
* @param int $padding Padding in pixel
156156
* @return $this Fluent interface
@@ -168,7 +168,7 @@ public function fitToMarkersAndDraws(int $padding = 0)
168168
}
169169

170170
/**
171-
* Fit map to points.
171+
* Fit map to an array of points.
172172
*
173173
* @param LatLng[] $points LatLng points
174174
* @param int $padding Padding in pixel

0 commit comments

Comments
 (0)