From 65e9a89591bc20bbd67b0e33fcbb7a298cce962f Mon Sep 17 00:00:00 2001 From: Garrett Johnson Date: Sat, 4 May 2019 07:15:46 -0600 Subject: [PATCH] Update API documentation. --- README.md | 2 +- docs/api/Mapnik.html | 19 +- docs/api/Mapnik/AggRenderer.html | 8 +- docs/api/Mapnik/Box2D.html | 14 +- docs/api/Mapnik/DatasourceCache.html | 8 +- docs/api/Mapnik/Exception.html | 4 +- docs/api/Mapnik/Image.html | 18 +- docs/api/Mapnik/Map.html | 250 ++++++++++++++++----------- docs/api/Mapnik/ProjTransform.html | 12 +- docs/api/Mapnik/Projection.html | 16 +- docs/api/SAMI_VERSION | 2 +- docs/api/css/sami.css | 31 +++- docs/api/js/bootstrap.min.js | 0 docs/api/renderer.index | 2 +- 14 files changed, 229 insertions(+), 157 deletions(-) mode change 100755 => 100644 docs/api/js/bootstrap.min.js diff --git a/README.md b/README.md index 82e7f1a..3e75d21 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ available objects and methods. Dev Container ------------- -The included Dockerfile builds an image with all the dependencies need for extension development and testing, including testing for memory leaks. +The included Dockerfile builds an image with all the dependencies needed for extension development and testing, including testing for memory leaks. docker build -t php7-mapnik-dev . docker run -it --mount type=bind,source=$(pwd),target=/opt/php7-mapnik php7-mapnik-dev:latest diff --git a/docs/api/Mapnik.html b/docs/api/Mapnik.html index 9174c6c..48cedb6 100644 --- a/docs/api/Mapnik.html +++ b/docs/api/Mapnik.html @@ -66,8 +66,7 @@
@@ -86,7 +85,7 @@

Classes

- Class AggRenderer +
@@ -95,7 +94,7 @@

Classes

- Class Box2D +
@@ -104,7 +103,7 @@

Classes

- Class DatasourceCache +
@@ -113,7 +112,7 @@

Classes

- Class Image +
@@ -122,7 +121,7 @@

Classes

- Class Map +
@@ -131,7 +130,7 @@

Classes

- Class ProjTransform + Re-project Box2D objects.
@@ -140,7 +139,7 @@

Classes

- Class Projection + Represents a spatial reference system. Used in conjunction with ProjTransform to project bounding boxes.
@@ -155,7 +154,7 @@

Exceptions

- Class Exception +
diff --git a/docs/api/Mapnik/AggRenderer.html b/docs/api/Mapnik/AggRenderer.html index 0140dec..508a072 100644 --- a/docs/api/Mapnik/AggRenderer.html +++ b/docs/api/Mapnik/AggRenderer.html @@ -66,9 +66,7 @@
@@ -132,7 +130,7 @@

-

AggRenderer constructor.

+

AggRenderer constructor.

Parameters

@@ -168,7 +166,7 @@

-

Render/paint image from Map configuration.

+

Render/paint image from Map configuration.

diff --git a/docs/api/Mapnik/Box2D.html b/docs/api/Mapnik/Box2D.html index a188ad2..ea8e76e 100644 --- a/docs/api/Mapnik/Box2D.html +++ b/docs/api/Mapnik/Box2D.html @@ -66,9 +66,7 @@
@@ -162,7 +160,7 @@

-

Box2D constructor.

+

Box2D constructor.

Parameters

@@ -208,7 +206,7 @@

-

Get east boundary of envelope.

+

Get east boundary of envelope.

Return Value

@@ -238,7 +236,7 @@

-

Get north boundary of envelope.

+

Get north boundary of envelope.

Return Value

@@ -268,7 +266,7 @@

-

Get west boundary of envelope.

+

Get west boundary of envelope.

Return Value

@@ -298,7 +296,7 @@

-

Get south boundary of envelope.

+

Get south boundary of envelope.

Return Value

diff --git a/docs/api/Mapnik/DatasourceCache.html b/docs/api/Mapnik/DatasourceCache.html index cf5ee86..157b5ab 100644 --- a/docs/api/Mapnik/DatasourceCache.html +++ b/docs/api/Mapnik/DatasourceCache.html @@ -66,9 +66,7 @@
@@ -132,7 +130,7 @@

-

Register datasource input plugins.

+

Register datasource input plugins.

Parameters

@@ -163,7 +161,7 @@

-

Get array of registered input plugins.

+

Get array of registered input plugins.

Return Value

diff --git a/docs/api/Mapnik/Exception.html b/docs/api/Mapnik/Exception.html index 984b9a7..2562d60 100644 --- a/docs/api/Mapnik/Exception.html +++ b/docs/api/Mapnik/Exception.html @@ -66,9 +66,7 @@
diff --git a/docs/api/Mapnik/Image.html b/docs/api/Mapnik/Image.html index fd0b83b..941803e 100644 --- a/docs/api/Mapnik/Image.html +++ b/docs/api/Mapnik/Image.html @@ -66,9 +66,7 @@
@@ -142,7 +140,7 @@

-

Image constructor.

+

Image constructor.

Parameters

@@ -178,7 +176,7 @@

-

Save image to a file.

+

Save image to a file.

Parameters

@@ -202,7 +200,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/Image-IO + https://github.com/mapnik/mapnik/wiki/Image-IO + Mapnik image formats documentation
@@ -223,7 +223,7 @@

-

Save image to a string.

+

Save image to a string.

Parameters

@@ -251,7 +251,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/Image-IO + https://github.com/mapnik/mapnik/wiki/Image-IO + Mapnik image formats documentation
diff --git a/docs/api/Mapnik/Map.html b/docs/api/Mapnik/Map.html index 79bd323..033d191 100644 --- a/docs/api/Mapnik/Map.html +++ b/docs/api/Mapnik/Map.html @@ -66,9 +66,7 @@
@@ -177,7 +175,7 @@

Methods

- loadXmlString(string $xml) + loadXmlString(string $xml, bool $strict = null, string $basePath = null)

Load map XML from string.

@@ -187,7 +185,7 @@

Methods

- loadXmlFile(string $file, bool $strict, string $basePath) + loadXmlFile(string $file, bool $strict = null, string $basePath = null)

Load XML map file.

@@ -540,7 +538,7 @@

-

Map constructor.

+

Map constructor.

Parameters

@@ -571,9 +569,9 @@

Parameters

-
at line 94
+
at line 96
- loadXmlString(string $xml) + loadXmlString(string $xml, bool $strict = null, string $basePath = null)

@@ -581,7 +579,7 @@

-

Load map XML from string.

+

Load map XML from string.

Parameters

@@ -589,7 +587,17 @@

Parameters

string $xml - Mapnik XML + + + + bool + $strict + + + + string + $basePath + @@ -600,7 +608,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/XMLConfigReference + https://github.com/mapnik/mapnik/wiki/XMLConfigReference + Mapnik XML config reference
@@ -611,9 +621,9 @@

See also

-
at line 104
+
at line 106
- loadXmlFile(string $file, bool $strict, string $basePath) + loadXmlFile(string $file, bool $strict = null, string $basePath = null)

@@ -621,7 +631,7 @@

-

Load XML map file.

+

Load XML map file.

Parameters

@@ -650,7 +660,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/XMLConfigReference + https://github.com/mapnik/mapnik/wiki/XMLConfigReference + Mapnik XML config reference
@@ -661,7 +673,7 @@

See also

-
at line 111
+
at line 113
zoom(float $zoom) @@ -671,7 +683,7 @@

-

Zoom in or out by a given factor. Positive number zooms in, negative number zooms out.

+

Zoom in or out by a given factor. Positive number zooms in, negative number zooms out.

Parameters

@@ -692,7 +704,7 @@

Parameters

-
at line 116
+
at line 118
zoomAll() @@ -702,7 +714,7 @@

-

Set the geographical extent of the map to the combined extents of all active layers.

+

Set the geographical extent of the map to the combined extents of all active layers.

@@ -713,7 +725,7 @@

-
at line 124
+
at line 126
pan(int $x, int $y) @@ -723,7 +735,7 @@

-

Set the Map center to x,y location in the coordinates of the pixmap or map surface.

+

Set the Map center to x,y location in the coordinates of the pixmap or map surface.

Parameters

@@ -749,7 +761,7 @@

Parameters

-
at line 133
+
at line 135
panAndZoom(int $x, int $y, float $zoom) @@ -759,7 +771,7 @@

-

Set Map center to x,y location and zoom in or out.

+

Set Map center to x,y location and zoom in or out.

Parameters

@@ -790,7 +802,7 @@

Parameters

-
at line 141
+
at line 143
zoomToBox(Box2D $box) @@ -800,7 +812,7 @@

-

Set the geographical extent of the map to Mapnik Box2D envelope.

+

Set the geographical extent of the map to Mapnik Box2D envelope.

Parameters

@@ -819,7 +831,9 @@

See also

- +
\Mapnik\Box2D + Box2D + Bounding box object
@@ -830,7 +844,7 @@

See also

-
at line 148
+
at line 150
registerFonts(string $path) @@ -840,7 +854,7 @@

-

Set path to search for fonts used in map.

+

Set path to search for fonts used in map.

Parameters

@@ -861,7 +875,7 @@

Parameters

-
at line 155
+
at line 157
string getBasePath() @@ -871,7 +885,7 @@

-

Get base path used for loading map assets.

+

Get base path used for loading map assets.

Return Value

@@ -891,7 +905,7 @@

Return Value

-
at line 162
+
at line 164
setBasePath(string $path) @@ -901,7 +915,7 @@

-

Set base path used for loading map assets.

+

Set base path used for loading map assets.

Parameters

@@ -922,7 +936,7 @@

Parameters

-
at line 169
+
at line 171
int getWidth() @@ -932,7 +946,7 @@

-

Get canvas width.

+

Get canvas width.

Return Value

@@ -952,7 +966,7 @@

Return Value

-
at line 176
+
at line 178
setWidth(int $width) @@ -962,7 +976,7 @@

-

Set canvas width.

+

Set canvas width.

Parameters

@@ -983,7 +997,7 @@

Parameters

-
at line 183
+
at line 185
int getHeight() @@ -993,7 +1007,7 @@

-

Get canvas height.

+

Get canvas height.

Return Value

@@ -1013,7 +1027,7 @@

Return Value

-
at line 190
+
at line 192
setHeight(int $height) @@ -1023,7 +1037,7 @@

-

Set canvas height.

+

Set canvas height.

Parameters

@@ -1044,7 +1058,7 @@

Parameters

-
at line 198
+
at line 200
resize(int $width, int $height) @@ -1054,7 +1068,7 @@

-

Resize the canvas to given height and width.

+

Resize the canvas to given height and width.

Parameters

@@ -1080,7 +1094,7 @@

Parameters

-
at line 206
+
at line 208
string getSrs() @@ -1090,7 +1104,7 @@

-

Get spatial reference system.

+

Get spatial reference system.

Return Value

@@ -1108,7 +1122,9 @@

See also

- +
http://proj4.org + http://proj4.org + proj.4 documentation
@@ -1119,7 +1135,7 @@

See also

-
at line 215
+
at line 217
setSrs(string $srs) @@ -1129,7 +1145,7 @@

-

Set spatial reference system.

+

Set spatial reference system.

Parameters

@@ -1148,11 +1164,15 @@

See also

- + - +
http://proj4.org + http://proj4.org + proj.4 documentation
http://spatialreference.org + http://spatialreference.org + Spatial reference system repository
@@ -1163,7 +1183,7 @@

See also

-
at line 222
+
at line 224
string getBackgroundImage() @@ -1173,7 +1193,7 @@

-

Get path to background image.

+

Get path to background image.

Return Value

@@ -1193,7 +1213,7 @@

Return Value

-
at line 229
+
at line 231
setBackgroundImage(string $file) @@ -1203,7 +1223,7 @@

-

Set path to background image.

+

Set path to background image.

Parameters

@@ -1224,7 +1244,7 @@

Parameters

-
at line 236
+
at line 238
float getBackgroundImageOpacity() @@ -1234,7 +1254,7 @@

-

Get background image opacity. 0 is transparent, 1 is opaque.

+

Get background image opacity. 0 is transparent, 1 is opaque.

Return Value

@@ -1254,7 +1274,7 @@

Return Value

-
at line 243
+
at line 245
setBackgroundImageOpacity(float $opacity) @@ -1264,7 +1284,7 @@

-

Set background image opacity. 0 is transparent, 1 is opaque.

+

Set background image opacity. 0 is transparent, 1 is opaque.

Parameters

@@ -1285,7 +1305,7 @@

Parameters

-
at line 251
+
at line 253
Box2D getMaximumExtent() @@ -1295,7 +1315,7 @@

-

Get maximum extent of projected map.

+

Get maximum extent of projected map.

Return Value

@@ -1313,7 +1333,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/BoundsClipping + https://github.com/mapnik/mapnik/wiki/BoundsClipping + Mapnik bounds clipping documentation
@@ -1324,7 +1346,7 @@

See also

-
at line 259
+
at line 261
setMaximumExtent(Box2D $box) @@ -1334,7 +1356,7 @@

-

Set maximum extent of projected map.

+

Set maximum extent of projected map.

Parameters

@@ -1353,7 +1375,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/BoundsClipping + https://github.com/mapnik/mapnik/wiki/BoundsClipping + Mapnik bounds clipping documentation
@@ -1364,7 +1388,7 @@

See also

-
at line 264
+
at line 266
resetMaximumExtent() @@ -1374,7 +1398,7 @@

-

Reset maximum extent.

+

Reset maximum extent.

@@ -1385,7 +1409,7 @@

-
at line 271
+
at line 273
Box2D getCurrentExtent() @@ -1395,7 +1419,7 @@

-

Get current extent of projected map.

+

Get current extent of projected map.

Return Value

@@ -1415,7 +1439,7 @@

Return Value

-
at line 278
+
at line 280
int getBufferSize() @@ -1425,7 +1449,7 @@

-

Get map bounds buffer size.

+

Get map bounds buffer size.

Return Value

@@ -1445,7 +1469,7 @@

Return Value

-
at line 285
+
at line 287
setBufferSize(int $bufferSize) @@ -1455,7 +1479,7 @@

-

Set map bounds buffer. Used by placement detector to help avoid cutting labels.

+

Set map bounds buffer. Used by placement detector to help avoid cutting labels.

Parameters

@@ -1476,7 +1500,7 @@

Parameters

-
at line 292
+
at line 294
Box2D getBufferedExtent() @@ -1486,7 +1510,7 @@

-

Get extent of map with buffer applied.

+

Get extent of map with buffer applied.

Return Value

@@ -1506,7 +1530,7 @@

Return Value

-
at line 300
+
at line 302
float getScale() @@ -1516,7 +1540,7 @@

-

Get map scale.

+

Get map scale.

Return Value

@@ -1534,7 +1558,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/ScaleAndPpi + https://github.com/mapnik/mapnik/wiki/ScaleAndPpi + Mapnik scale and scale denominators documentation
@@ -1545,7 +1571,7 @@

See also

-
at line 308
+
at line 310
float getScaleDenominator() @@ -1555,7 +1581,7 @@

-

Get scale denominator.

+

Get scale denominator.

Return Value

@@ -1573,7 +1599,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/ScaleAndPpi + https://github.com/mapnik/mapnik/wiki/ScaleAndPpi + Mapnik scale and scale denominators documentation
@@ -1584,7 +1612,7 @@

See also

-
at line 315
+
at line 317
int countLayers() @@ -1594,7 +1622,7 @@

-

Count number of map layers.

+

Count number of map layers.

Return Value

@@ -1614,7 +1642,7 @@

Return Value

-
at line 322
+
at line 324
removeStyle(string $styleName) @@ -1624,7 +1652,7 @@

-

Remove a style.

+

Remove a style.

Parameters

@@ -1645,7 +1673,7 @@

Parameters

-
at line 327
+
at line 329
removeAll() @@ -1655,7 +1683,7 @@

-

Remove all styles and layers.

+

Remove all styles and layers.

@@ -1666,7 +1694,7 @@

-
at line 335
+
at line 337
int getAspectFixMode() @@ -1676,7 +1704,7 @@

-

Get aspect fix mode.

+

Get aspect fix mode.

Return Value

@@ -1694,7 +1722,9 @@

See also

- +
https://github.com/mapnik/mapnik/wiki/Aspect-Fix-Mode + https://github.com/mapnik/mapnik/wiki/Aspect-Fix-Mode + Mapnik aspect fix mode documentation
@@ -1705,7 +1735,7 @@

See also

-
at line 352
+
at line 354
setAspectFixMode(int $aspectFixMode) @@ -1715,7 +1745,7 @@

-

Set aspect fix mode. See Map constants for valid values.

+

Set aspect fix mode. See Map constants for valid values.

Parameters

@@ -1734,43 +1764,63 @@

See also

- + - + - + - + - + - + - + - + - + - +
https://github.com/mapnik/mapnik/wiki/Aspect-Fix-Mode + https://github.com/mapnik/mapnik/wiki/Aspect-Fix-Mode + Mapnik aspect fix mode documentation
\Mapnik\Map::GROW_BBOX + Map::GROW_BBOX +
\Mapnik\Map::GROW_CANVAS + Map::GROW_CANVAS +
\Mapnik\Map::SHRINK_BBOX + Map::SHRINK_BBOX +
\Mapnik\Map::SHRINK_CANVAS + Map::SHRINK_CANVAS +
\Mapnik\Map::ADJUST_BBOX_WIDTH + Map::ADJUST_BBOX_WIDTH +
\Mapnik\Map::ADJUST_BBOX_HEIGHT + Map::ADJUST_BBOX_HEIGHT +
\Mapnik\Map::ADJUST_CANVAS_WIDTH + Map::ADJUST_CANVAS_WIDTH +
\Mapnik\Map::ADJUST_CANVAS_HEIGHT + Map::ADJUST_CANVAS_HEIGHT +
\Mapnik\Map::RESPECT + Map::RESPECT +
diff --git a/docs/api/Mapnik/ProjTransform.html b/docs/api/Mapnik/ProjTransform.html index a35de75..2d818ec 100644 --- a/docs/api/Mapnik/ProjTransform.html +++ b/docs/api/Mapnik/ProjTransform.html @@ -66,9 +66,7 @@
@@ -88,7 +86,7 @@

-

Re-project Box2D objects.

+

Re-project Box2D objects.

@@ -144,7 +142,7 @@

-

ProjTransform constructor.

+

ProjTransform constructor.

Parameters

@@ -180,7 +178,7 @@

-

Transform box from source to destination projection.

+

Transform box from source to destination projection.

Parameters

@@ -220,7 +218,7 @@

-

Transform box from destination to source projection.

+

Transform box from destination to source projection.

Parameters

diff --git a/docs/api/Mapnik/Projection.html b/docs/api/Mapnik/Projection.html index e9b2284..fa238c2 100644 --- a/docs/api/Mapnik/Projection.html +++ b/docs/api/Mapnik/Projection.html @@ -66,9 +66,7 @@
@@ -88,7 +86,7 @@

-

Represents a spatial reference system. Used in conjunction with ProjTransform to project bounding boxes.

+

Represents a spatial reference system. Used in conjunction with ProjTransform to project bounding boxes.

@@ -124,7 +122,7 @@

-

Projection constructor.

+

Projection constructor.

Parameters

@@ -143,11 +141,15 @@

See also

- + - +
http://proj4.org + http://proj4.org + proj.4 documentation
http://spatialreference.org + http://spatialreference.org + Spatial reference system repository
diff --git a/docs/api/SAMI_VERSION b/docs/api/SAMI_VERSION index f5885d4..fc28f8e 100644 --- a/docs/api/SAMI_VERSION +++ b/docs/api/SAMI_VERSION @@ -1 +1 @@ -4.0.0-DEV \ No newline at end of file +4.0.14-DEV \ No newline at end of file diff --git a/docs/api/css/sami.css b/docs/api/css/sami.css index c94b3bb..4c089c3 100644 --- a/docs/api/css/sami.css +++ b/docs/api/css/sami.css @@ -40,7 +40,10 @@ html, body, #content { } .namespace-breadcrumbs .breadcrumb > li + li:before { - content: "\\" + content: ""; +} +.namespace-breadcrumbs .breadcrumb > .backslash { + color: #ccc; } /* Site columns */ @@ -239,6 +242,32 @@ a abbr { cursor: pointer; } +.method-description table, .description table { + border: solid 1px #ccc; + padding: 1em; + margin: 1em; +} + +.method-description td, .method-description th, +.description td, .description th { + padding: 0.75em 1.25em; +} + +.method-description tbody tr:nth-child(even), +.description tbody tr:nth-child(even) { + background: #edf3fe; +} + +.method-description tbody tr:nth-child(odd), +.description tbody tr:nth-child(odd) { + background: #fff; +} + +.method-description thead tr, +.description thead tr { + background: #edf3fe; +} + /** General Sami styling **/ .underlined > .row { diff --git a/docs/api/js/bootstrap.min.js b/docs/api/js/bootstrap.min.js old mode 100755 new mode 100644 diff --git a/docs/api/renderer.index b/docs/api/renderer.index index 74582af..1b08d53 100644 --- a/docs/api/renderer.index +++ b/docs/api/renderer.index @@ -1 +1 @@ -C:19:"Sami\Renderer\Index":645:{a:3:{i:0;a:8:{s:18:"Mapnik\AggRenderer";s:40:"9a72acc2340fe5cf6f5db3478a2451229686dd8f";s:12:"Mapnik\Box2D";s:40:"88ac85b577c1c23b6059182dde4587898b143a08";s:22:"Mapnik\DatasourceCache";s:40:"62a3439d747728ea65f0d8220770f4ac4f9f3148";s:16:"Mapnik\Exception";s:40:"b2eb335c289ffa91343d705538867d3fb657d947";s:12:"Mapnik\Image";s:40:"5f82b9ea7ccbe65b5cb22006c344bc6164123052";s:10:"Mapnik\Map";s:40:"77d373efee5d80126597bdf074f97a1d140a022e";s:20:"Mapnik\ProjTransform";s:40:"da24f79a32c102663b284d1a34f7e1ca224148d2";s:17:"Mapnik\Projection";s:40:"d831b736bacae86cead1555aaf5108df16cb2c4d";}i:1;a:1:{i:0;s:6:"master";}i:2;a:1:{i:0;s:6:"Mapnik";}}} \ No newline at end of file +C:19:"Sami\Renderer\Index":645:{a:3:{i:0;a:8:{s:18:"Mapnik\AggRenderer";s:40:"9a72acc2340fe5cf6f5db3478a2451229686dd8f";s:12:"Mapnik\Box2D";s:40:"88ac85b577c1c23b6059182dde4587898b143a08";s:22:"Mapnik\DatasourceCache";s:40:"62a3439d747728ea65f0d8220770f4ac4f9f3148";s:16:"Mapnik\Exception";s:40:"b2eb335c289ffa91343d705538867d3fb657d947";s:12:"Mapnik\Image";s:40:"5f82b9ea7ccbe65b5cb22006c344bc6164123052";s:10:"Mapnik\Map";s:40:"6e6c141a6eba92ef943f651f61eba170f4d3d914";s:20:"Mapnik\ProjTransform";s:40:"da24f79a32c102663b284d1a34f7e1ca224148d2";s:17:"Mapnik\Projection";s:40:"d831b736bacae86cead1555aaf5108df16cb2c4d";}i:1;a:1:{i:0;s:6:"master";}i:2;a:1:{i:0;s:6:"Mapnik";}}} \ No newline at end of file