sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added python docstrings to mapnik Map class

Browse source
This commit is contained in:
Dane Springmeyer 2008-11-17 23:44:50 +00:00
parent 86dcb79808
commit 2c83877108
1 changed files with 242 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

277
bindings/python/mapnik_map.cpp
View file

@ -85,41 +85,246 @@ std::vector<Layer> const& (Map::*layers_const)() const = &Map::layers;
void export_map() void export_map()
{ {
using namespace boost::python; using namespace boost::python;
python_optional<mapnik::Color> (); python_optional<mapnik::Color> ();
class_<std::vector<Layer> >("Layers") class_<std::vector<Layer> >("Layers")
.def(vector_indexing_suite<std::vector<Layer> >()) .def(vector_indexing_suite<std::vector<Layer> >())
; ;
class_<Map>("Map","The map object.",init<int,int,optional<std::string const&> >()) class_<Map>("Map","The map object.",init<int,int,optional<std::string const&> >(
.add_property("width",&Map::getWidth, &Map::setWidth, "The width of the map.") "Create a Map with a width and height as integers and, optionally,\n"
.add_property("height",&Map::getHeight, &Map::setHeight, "The height of the map.") "an srs string either with a Proj.4 epsg code ('+init=epsg:<code>')\n"
.add_property("srs",make_function(&Map::srs,return_value_policy<copy_const_reference>()), "or with a Proj.4 literal ('+proj=<literal>').\n"
&Map::set_srs,"Spatial reference in proj4 format e.g. \"+proj=latlong +datum=WGS84\"") "If no srs is specified the map will default to '+proj=latlong +datum=WGS84'\n"
.add_property("buffer_size", &Map::buffer_size,&Map::set_buffer_size,"The size of buffer around map in pixels") "\n"
.add_property("background",make_function "Usage:\n"
(&Map::background,return_value_policy<copy_const_reference>()), ">>> from mapnik import Map\n"
&Map::set_background, "The background color of the map.") ">>> m = Map(600,400)\n"
.def("envelope",make_function(&Map::getCurrentExtent, ">>> m\n"
return_value_policy<copy_const_reference>()), "<mapnik._mapnik.Map object at 0x6a240>\n"
"The current extent of the map") ">>> m.srs\n"
.def("scale", &Map::scale) "'+proj=latlong +datum=WGS84'\n"
.def("zoom_all",&Map::zoom_all, ))
"Set the geographical extent of the map "
"to the combined extents of all active layers") .def_pickle(map_pickle_suite()
.def("zoom_to_box",&Map::zoomToBox, "Set the geographical extent of the map.") )
.def("pan",&Map::pan)
.def("zoom",&Map::zoom) .def("append_style",&Map::insert_style,
.def("zoom_all",&Map::zoom_all) "Insert a Mapnik Style onto the map by appending it.\n"
.def("pan_and_zoom",&Map::pan_and_zoom) "\n"
.def("append_style",&Map::insert_style) "Usage:\n"
.def("remove_style",&Map::remove_style) ">>> sty\n"
.def("query_point",&Map::query_point) "<mapnik._mapnik.Style object at 0x6a330>\n"
.def("query_map_point",&Map::query_map_point) ">>> m.append_style('Style Name', sty)\n"
.add_property("layers",make_function "True # style object added to map by name\n"
(layers_nonconst,return_value_policy<reference_existing_object>()), ">>> m.append_style('Style Name', sty)\n"
"Get the list of layers in this map.") "False # you can only append styles with unique names\n"
.def("find_style",&Map::find_style,return_value_policy<copy_const_reference>()) )
.def_pickle(map_pickle_suite())
; .def("envelope",
make_function(&Map::getCurrentExtent,
return_value_policy<copy_const_reference>()),
"Return the Map Envelope object\n"
"and print the string representation\n"
"of the current extent of the map.\n"
"\n"
"Usage:\n"
">>> m.envelope()\n"
"Envelope(-0.185833333333,-0.96,0.189166666667,-0.71)\n"
">>> dir(m.envelope())\n"
"...'center', 'contains', 'expand_to_include', 'forward',\n"
"...'height', 'intersect', 'intersects', 'inverse', 'maxx',\n"
"...'maxy', 'minx', 'miny', 'width'\n"
)
.def("find_style",
&Map::find_style,
return_value_policy<copy_const_reference>(),
"Query the Map for a style by name and return\n"
"a style object if found and the default map\n"
"style if not found.\n"
"\n"
"Usage:\n"
">>> m.find_style('Style Name')\n"
"<mapnik._mapnik.Style object at 0x654f0>\n"
)
.def("pan",&Map::pan,
"Set the Map center at a given x,y location\n"
"as integers in the coordinates of the pixmap or map surface.\n"
"\n"
"Usage:\n"
">>> m = Map(600,400)\n"
">>> m.envelope().center()\n"
"Coord(-0.5,-0.5) # default Map center\n"
">>> m.pan(-1,-1)\n"
">>> m.envelope().center()\n"
"Coord(0.00166666666667,-0.835)\n"
)
.def("pan_and_zoom",&Map::pan_and_zoom,
"Set the Map center at a given x,y location\n"
"and zoom factor as a float.\n"
"\n"
"Usage:\n"
">>> m = Map(600,400)\n"
">>> m.envelope().center()\n"
"Coord(-0.5,-0.5) # default Map center\n"
">>> m.scale()\n"
"-0.0016666666666666668\n"
">>> m.pan_and_zoom(-1,-1,0.25)\n"
">>> m.scale()\n"
"0.00062500000000000001\n"
)
.def("query_map_point",&Map::query_map_point,
"Query a Map Layer (by layer index) for features \n"
"intersecting the given x,y location in the coordinates\n"
"of the pixmap or map surface.\n"
"Will return a Mapnik Featureset if successful\n"
"otherwise will return None.\n"
"\n"
"Usage:\n"
">>> feat = m.query_map_point(0,200,200)\n"
">>> feat\n"
">>> <mapnik._mapnik.Featureset object at 0x5fe1f0>\n"
">>> feat.next()\n"
">>> <mapnik._mapnik.Feature object at 0x5fe230>\n"
)
.def("query_point",&Map::query_point,
"Query a Map Layer (by layer index) for features \n"
"intersecting the given x,y location in the coordinates\n"
"of map projection.\n"
"Will return a Mapnik Featureset if successful\n"
"otherwise will return None.\n"
"\n"
"Usage:\n"
">>> feat = m.query_point(0,-122,48)\n"
">>> feat\n"
">>> <mapnik._mapnik.Featureset object at 0x5fe130>\n"
">>> feat.next()\n"
">>> <mapnik._mapnik.Feature object at 0x5fe1b0>\n"
)
.def("remove_style",&Map::remove_style,
"Remove a Mapnik Style from the map.\n"
"\n"
"Usage:\n"
">>> m.remove_style('Style Name')\n"
)
.def("scale", &Map::scale,
"Return the Map Scale.\n"
"Usage:\n"
"\n"
">>> m.scale()\n"
)
.def("zoom",&Map::zoom,
"Zoom in by a given factor.\n"
"Usage:\n"
"\n"
">>> m.zoom(0.25)\n"
)
.def("zoom_all",&Map::zoom_all,
"Set the geographical extent of the map\n"
"to the combined extents of all active layers.\n"
"\n"
"Usage:\n"
">>> m.zoom_all()\n"
)
.def("zoom_to_box",&Map::zoomToBox,
"Set the geographical extent of the map\n"
"by specifying a Mapnik Envelope.\n"
"\n"
"Usage:\n"
">>> extext = Envelope(-180.0, -90.0, 180.0, 90.0)\n"
">>> m.zoom_to_box(extent)\n"
)
.add_property("background",make_function
(&Map::background,return_value_policy<copy_const_reference>()),
&Map::set_background,
"The background color of the map.\n"
"\n"
"Usage:\n"
">>> m.background = Color('steelblue')\n"
)
.add_property("buffer_size",
&Map::buffer_size,
&Map::set_buffer_size,
"Get/Set the size of buffer around map in pixels.\n"
"\n"
"Usage:\n"
">>> m.buffer_size\n"
"0 # zero by default\n"
">>> m.buffer_size = 2\n"
">>> m.buffer_size\n"
"2\n"
)
.add_property("height",
&Map::getHeight,
&Map::setHeight,
"Get/Set the height of the map in pixels.\n"
"Minimum settable size is 16 pixels.\n"
"\n"
"Usage:\n"
">>> m.height\n"
"400\n"
">>> m.height = 600\n"
">>> m.height\n"
"600\n"
)
.add_property("layers",make_function
(layers_nonconst,return_value_policy<reference_existing_object>()),
"The list of map layers.\n"
"\n"
"Usage:\n"
">>> m.layers\n"
"<mapnik._mapnik.Layers object at 0x6d458>"
">>> m.layers[0]\n"
"<mapnik._mapnik.Layer object at 0x5fe130>\n"
)
.add_property("srs",
make_function(&Map::srs,return_value_policy<copy_const_reference>()),
&Map::set_srs,
"Spatial reference in Proj.4 format.\n"
"Either an epsg code or proj literal.\n"
"For example, a proj literal:\n"
"\t'+proj=latlong +datum=WGS84'\n"
"and a proj epsg code:\n"
"\t'+init=epsg:4326'\n"
"\n"
"Note: using epsg codes requires the installation of\n"
"the Proj.4 'epsg' data file normally found in '/usr/local/share/proj'\n"
"\n"
"Usage:\n"
">>> m.srs\n"
"'+proj=latlong +datum=WGS84' # The default srs if not initialized with custom srs\n"
">>> # set to google mercator with Proj.4 literal\n"
"... \n"
">>> m.srs = '+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +no_defs +over'\n"
)
.add_property("width",
&Map::getWidth,
&Map::setWidth,
"Get/Set the width of the map in pixels.\n"
"Minimum settable size is 16 pixels.\n"
"\n"
"Usage:\n"
">>> m.width\n"
"600\n"
">>> m.width = 800\n"
">>> m.width\n"
"800\n"
)
;
} }