[Commits] r1879 - in core/trunk/geoext/lib/GeoExt: data plugins widgets
commits at geoext.org
commits at geoext.org
Tue Feb 9 17:41:40 CET 2010
Author: ahocevar
Date: 2010-02-09 17:41:40 +0100 (Tue, 09 Feb 2010)
New Revision: 1879
Modified:
core/trunk/geoext/lib/GeoExt/data/PrintPage.js
core/trunk/geoext/lib/GeoExt/data/PrintProvider.js
core/trunk/geoext/lib/GeoExt/plugins/PrintExtent.js
core/trunk/geoext/lib/GeoExt/widgets/PrintMapPanel.js
Log:
apidoc fixes to make everything work in sphinx again. Non-functional change.
Modified: core/trunk/geoext/lib/GeoExt/data/PrintPage.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/PrintPage.js 2010-02-09 16:40:48 UTC (rev 1878)
+++ core/trunk/geoext/lib/GeoExt/data/PrintPage.js 2010-02-09 16:41:40 UTC (rev 1879)
@@ -154,7 +154,7 @@
},
/** api: method[fit]
- * :param fitTo: :class:`GeoExt.MapPanel`|``OpenLayers.Map``|``OpenLayers.Feature.Vector``
+ * :param fitTo: :class:`GeoExt.MapPanel` or ``OpenLayers.Map`` or ``OpenLayers.Feature.Vector``
* The map or feature to fit the page to.
* :param loose: ``Boolean`` If true, the closest matching print extent
* will be chosen. If set to false, the chosen print extent will
Modified: core/trunk/geoext/lib/GeoExt/data/PrintProvider.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/PrintProvider.js 2010-02-09 16:40:48 UTC (rev 1878)
+++ core/trunk/geoext/lib/GeoExt/data/PrintProvider.js 2010-02-09 16:41:40 UTC (rev 1879)
@@ -53,9 +53,9 @@
/** api: config[url]
* ``String`` Base url of the print service. Only required if
- * :ref:`GeoExt.data.PrintProvider.capabilities` is not provided. This
- * is usually something like ``http://path/to/mapfish/print`` for Mapfish,
- * and ``http://path/to/geoserver/pdf`` for GeoServer with the printing
+ * ``capabilities`` is not provided. This
+ * is usually something like http://path/to/mapfish/print for Mapfish,
+ * and http://path/to/geoserver/pdf for GeoServer with the printing
* extension installed. This property requires that the print service is
* at the same origin as the application (or accessible via proxy).
*/
@@ -67,11 +67,11 @@
url: null,
/** api: config[capabilities]
- * ``Object`` Capabilities of the print service. Only required if
- * :ref:`GeoExt.data.PrintProvider.url` is not provided. This is the
- * object returned by the ``info.json`` endpoint of the print service,
- * and is usually obtained by including a script tag pointing to
- * ``http://path/to/printservice/info.json?var=myvar`` in the head of the
+ * ``Object`` Capabilities of the print service. Only required if ``url``
+ * is not provided. This is the object returned by the ``info.json``
+ * endpoint of the print service, and is usually obtained by including a
+ * script tag pointing to
+ * http://path/to/printservice/info.json?var=myvar in the head of the
* html document, making the capabilities accessible as ``window.myvar``.
* This property should be used when no local print service or proxy is
* available, or when you do not listen for the ``loadcapabilities``
@@ -116,7 +116,8 @@
* ``Ext.data.JsonStore`` read-only. A store representing the scales
* available.
*
- * Record fields:
+ * Fields of records in this store:
+ *
* * name - ``String`` the name of the scale
* * value - ``Float`` the scale denominator
*/
@@ -126,7 +127,8 @@
* ``Ext.data.JsonStore`` read-only. A store representing the dpis
* available.
*
- * Record fields:
+ * Fields of records in this store:
+ *
* * name - ``String`` the name of the dpi
* * value - ``Float`` the dots per inch
*/
@@ -136,7 +138,8 @@
* ``Ext.data.JsonStore`` read-only. A store representing the layouts
* available.
*
- * Records fields:
+ * Fields of records in this store:
+ *
* * name - ``String`` the name of the layout
* * size - ``Object`` width and height of the map in points
* * rotation - ``Boolean`` indicates if rotation is supported
@@ -145,14 +148,13 @@
/** api: property[dpi]
* ``Ext.data.Record`` the record for the currently used resolution.
- * Read-only, use :ref:`GeoExt.data.PrintProvider.setDpi` to set the
- * value.
+ * Read-only, use ``setDpi`` to set the value.
*/
dpi: null,
/** api: property[layout]
* ``Ext.data.Record`` the record of the currently used layout. Read-only,
- * use :ref:`GeoExt.data.PrintProvider.setLayout` to set the value.
+ * use ``setLayout`` to set the value.
*/
layout: null,
@@ -170,9 +172,7 @@
this.addEvents(
/** api: events[loadcapabilities]
* Triggered when the capabilities have finished loading. This
- * event will only fire when
- * :ref:`GeoExt.data.PrintProvider.capabilities` is not
- * configured.
+ * event will only fire when ``capabilities`` is not configured.
*
* Listener arguments:
* * printProvider - :class:`GeoExt.data.PrintProvider` this
@@ -278,11 +278,17 @@
},
/** api: method[print]
- * :param map: ``GeoExt.MapPanel``|``OpenLayers.Map`` The map to print.
- * :param pages: ``Array``(:class:`GeoExt.data.PrintPage`) or
+ * :param map: ``GeoExt.MapPanel`` or ``OpenLayers.Map`` The map to print.
+ * :param pages: ``Array`` of :class:`GeoExt.data.PrintPage` or
* :class:`GeoExt.data.PrintPage` page(s) to print.
- * :param options: ``Object`` of additional options:
- * * ``legend``: :class:`GeoExt.LegendPanel` If provided, the legend
+ * :param options: ``Object`` of additional options, see below.
+ *
+ * Sends the print command to the print service and opens a new window
+ * with the resulting PDF.
+ *
+ * Valid properties for the ``options`` argument:
+ *
+ * * ``legend`` - :class:`GeoExt.LegendPanel` If provided, the legend
* will be added to the print document. For the printed result to
* look like the LegendPanel, the following settings in the
* ``!legends`` block of the print module are recommended:
@@ -293,8 +299,6 @@
* maxIconHeight: 0
* classIndentation: 0
*
- * Sends the print command to the print service and opens a new window
- * with the resulting PDF.
*/
print: function(map, pages, options) {
if(map instanceof GeoExt.MapPanel) {
Modified: core/trunk/geoext/lib/GeoExt/plugins/PrintExtent.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/plugins/PrintExtent.js 2010-02-09 16:40:48 UTC (rev 1878)
+++ core/trunk/geoext/lib/GeoExt/plugins/PrintExtent.js 2010-02-09 16:41:40 UTC (rev 1879)
@@ -124,7 +124,7 @@
/** api: method[print]
* :param options: ``Object`` Options to send to the PrintProvider's
- * print method. See :ref:`GeoExt.data.PrintProvider.print`.
+ * print method. See :class:`GeoExt.data.PrintProvider` :: ``print``.
*
* Prints all pages as shown on the map.
*/
Modified: core/trunk/geoext/lib/GeoExt/widgets/PrintMapPanel.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/PrintMapPanel.js 2010-02-09 16:40:48 UTC (rev 1878)
+++ core/trunk/geoext/lib/GeoExt/widgets/PrintMapPanel.js 2010-02-09 16:41:40 UTC (rev 1879)
@@ -79,11 +79,11 @@
*
* .. note:: ``numZoomLevels`` and ``resolutions`` of the map will be set
* by this PrintMapPanel, and the layers will be copied from
- * :ref:`GeoExt.PrintMapPanel.sourceMap`.
+ * ``sourceMap``.
*/
/** api: config[sourceMap]
- * :class:`GeoExt.MapPanel`|``OpenLayers.Map`` The map that is to be
+ * :class:`GeoExt.MapPanel` or ``OpenLayers.Map`` The map that is to be
* printed.
*/
@@ -93,7 +93,7 @@
sourceMap: null,
/** api: config[printProvider]
- * :class:`GeoExt.data.PrintProvider`|``Object`` PrintProvider to use
+ * :class:`GeoExt.data.PrintProvider` or ``Object`` PrintProvider to use
* for printing. If an ``Object`` is provided, a new PrintProvider will
* be created and configured with the object.
*/
@@ -103,12 +103,12 @@
* PrintMapPanel.
*
* .. note:: The PrintMapPanel requires the printProvider's capabilities
- * to be available upon initialization. This means that a PrintMapPanel
- * configured with an object as ``printProvider`` will only work when
- * ``capabilities`` is provided in the printProvider's configuration
- * object. If ``printProvider`` is provided as an instance of
- * :class:`GeoExt.data.PrintProvider`, the capabilities must be loaded
- * before PrintMapPanel initialization.
+ * to be available upon initialization. This means that a PrintMapPanel
+ * configured with an object as ``printProvider`` will only work when
+ * ``capabilities`` is provided in the printProvider's configuration
+ * object. If ``printProvider`` is provided as an instance of
+ * :class:`GeoExt.data.PrintProvider`, the capabilities must be loaded
+ * before PrintMapPanel initialization.
*/
printProvider: null,
@@ -118,6 +118,26 @@
*/
printPage: null,
+ /** api: config[center]
+ * ``OpenLayers.LonLat`` or ``Array(Number)`` A location for the map
+ * center. Do not set, as this will be overridden with the
+ * ``sourceMap`` center.
+ */
+ center: null,
+
+ /** api: config[zoom]
+ * ``Number`` An initial zoom level for the map. Do not set, as this
+ * will be overridden with a zoom level matching the ``sourceMap``.
+ */
+ zoom: null,
+
+ /** api: config[extent]
+ * ``OpenLayers.Bounds or Array(Number)`` An initial extent for the map.
+ * Do not set, as this will be overridden with an extent matching the
+ * ``sourceMap`` resolution.
+ */
+ extent: null,
+
/**
* private: method[initComponent]
* private override
@@ -215,10 +235,11 @@
},
/** api: method[print]
- * :param options: ``Object`` options for the printProvider's
- * :ref:`GeoExt.data.PrintProvider.print` method.
- * Convenience method for printing the map, without the need to interact
- * with the printProvider and printPage.
+ * :param options: ``Object`` options for
+ * the :class:`GeoExt.data.PrintProvider` :: ``print`` method.
+ *
+ * Convenience method for printing the map, without the need to
+ * interact with the printProvider and printPage.
*/
print: function(options) {
this.printProvider.print(this.map, [this.printPage], options);
More information about the Commits
mailing list