[mapserver-commits] r11986 - branches/branch-6-0/docs/en/mapscript
trunk/docs/en/mapscript
svn at osgeo.org
svn at osgeo.org
Wed Aug 3 17:34:11 EDT 2011
Author: havatv
Date: 2011-08-03 14:34:11 -0700 (Wed, 03 Aug 2011)
New Revision: 11986
Modified:
branches/branch-6-0/docs/en/mapscript/mapscript.txt
trunk/docs/en/mapscript/mapscript.txt
Log:
Changed scale to scaledenom in mapscript document (#3958). Changed min and max in explanation accordingly. Also adjusted with line breaks before column 80.
Modified: branches/branch-6-0/docs/en/mapscript/mapscript.txt
===================================================================
--- branches/branch-6-0/docs/en/mapscript/mapscript.txt 2011-08-03 21:03:17 UTC (rev 11985)
+++ branches/branch-6-0/docs/en/mapscript/mapscript.txt 2011-08-03 21:34:11 UTC (rev 11986)
@@ -198,14 +198,14 @@
layer : layerObj_ immutable
Reference to the parent layer
-maxscale : float
- The maximum scale at which class is drawn
+maxscaledenom : float
+ The minimum scale at which class is drawn
metadata : hashTableObj_ immutable
class metadata hash table.
-minscale : float
- The minimum scale at which class is drawn
+minscaledenom : float
+ The maximum scale at which class is drawn
name : string
Unique within a layer
@@ -470,9 +470,10 @@
size : int immutable
To access this attribute use the getSize method.
-.. note:: the getSize method is inefficient as it does a call to getBytes and then computes
- the size of the byte array. The bytearray is then immediately discarded. In most
- cases it is more efficient to call getBytes directly.
+.. note:: the getSize method is inefficient as it does a call to
+ getBytes and then computes the size of the byte array. The
+ bytearray is then immediately discarded. In most cases it is more
+ efficient to call getBytes directly.
width : int immutable
Image width in pixels.
@@ -497,9 +498,10 @@
getSize() : int
Resturns the size of the binary buffer representing the image buffer.
-.. note:: the getSize method is inefficient as it does a call to getBytes and then computes
- the size of the byte array. The byte array is then immediately discarded. In most
- cases it is more efficient to call getBytes directly.
+.. note:: the getSize method is inefficient as it does a call to
+ getBytes and then computes the size of the byte array. The byte
+ array is then immediately discarded. In most cases it is more
+ efficient to call getBytes directly.
save( string filename [, mapObj_ parent_map=NULL ] ) : int
Save image to *filename*. The optional *parent_map* parameter must be
@@ -509,8 +511,9 @@
Write image data to an open file descriptor or, by default, to *stdout*.
Returns MS_SUCCESS or MS_FAILURE.
-.. note:: This method is current enabled for Python and C# only. C# supports writing onto a
- Stream object. User-contributed typemaps are needed for Perl, Ruby, and Java.
+.. note:: This method is current enabled for Python and C# only. C#
+ supports writing onto a Stream object. User-contributed typemaps
+ are needed for Perl, Ruby, and Java.
.. note:: The free() method of imageObj has been deprecated. In MapServer
revisions 4+ all instances of imageObj will be properly disposed of by
@@ -853,12 +856,12 @@
labelitem : string
Attribute defining feature label text.
-labelmaxscale : float
+labelmaxscaledenom : float
+ Minimum scale at which layer will be labeled.
+
+labelminscaledenom : float
Maximum scale at which layer will be labeled.
-labelminscale : float
- Minimum scale at which layer will be labeled.
-
labelrequires : string
Logical expression.
@@ -872,14 +875,14 @@
Maximum number of layer features that will be drawn. For shapefile data
this means the first N features where N = maxfeatures.
-maxscale : float
- Maximum scale at which layer will be drawn.
+maxscaledenom : float
+ Minimum scale at which layer will be drawn.
metadata : hashTableObj_ immutable
Layer metadata.
-minscale : float
- Minimum scale at which layer will be drawn.
+minscaledenom : float
+ Maximum scale at which layer will be drawn.
name : string
Unique identifier for layer.
@@ -906,7 +909,8 @@
Logical expression.
sizeunits : int
- Units of class size values. MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
+ Units of class size values. MS_INCHES, MS_FEET, MS_MILES,
+ MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
status : int
MS_ON, MS_OFF, or MS_DEFAULT.
@@ -914,7 +918,7 @@
styleitem : string
Attribute defining styles.
-symbolscale : float
+symbolscaledenom : float
Scale at which symbols are default size.
template : string
@@ -931,7 +935,8 @@
Search buffer for point and line queries.
toleranceunits : int
- MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
+ MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS,
+ MS_KILOMETERS, MS_DD or MS_PIXELS
transform : int
Whether or not layer data is to be transformed to image units.
@@ -1104,8 +1109,8 @@
Returns the index at which the class was inserted.
isVisible( ) : int
- Returns MS_TRUE or MS_FALSE after considering the layer status, minscale,
- and maxscale within the context of the parent map.
+ Returns MS_TRUE or MS_FALSE after considering the layer status, minscaledenom,
+ and maxscaledenom within the context of the parent map.
moveClassDown( int class ) : int
The class specified by the class index will be moved up into
@@ -1487,7 +1492,7 @@
resolution : float
Nominal DPI resolution. Default is 72.
-scale : float
+scaledenom : float
The nominal map scale. A value of 25000 means 1:25000 scale.
scalebar : scalebarObj_ immutable
@@ -2510,8 +2515,9 @@
Draws the individual shape using layer. Returns MS_SUCCESS or MS_FAILURE.
equals( shapeObj shape2 ) : int
- Returns MS_TRUE if the shape and shape2 are equal (geometry only). Returns -1
- on error and MS_FALSE otherwise. Requires GEOS support.
+ Returns MS_TRUE if the shape and shape2 are equal (geometry
+ only). Returns -1 on error and MS_FALSE otherwise. Requires GEOS
+ support.
fromWKT( char \*wkt ) : shapeObj
Returns a new shapeObj based on a well-known text representation of a
@@ -2636,33 +2642,37 @@
Foreground or fill pen color.
mincolor : colorObj_
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
minsize : int
Minimum pen or symbol width for scaling styles.
minvalue : double
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
minwidth : int
Minimum width of the symbol.
maxcolor : colorObj_
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
maxsize : int
Maximum pen or symbol width for scaling.
maxvalue : double
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
maxwidth : int
Maximum width of the symbol.
@@ -2677,13 +2687,15 @@
Outline pen color.
rangeitem : string
- Attribute/field that stores the values for the Color Range Mapping (:ref:`rfc6`).
+ Attribute/field that stores the values for the Color Range Mapping
+ (:ref:`rfc6`).
size : int
Pixel width of the style's pen or symbol.
sizeitem : string
- Attribute/field that stores the size to be used in rendering. Value is given in pixels.
+ Attribute/field that stores the size to be used in
+ rendering. Value is given in pixels.
symbol : int
The index within the map symbolset of the style's symbol.
@@ -2896,8 +2908,8 @@
map : mapObj immutable
Reference to parent mapObj.
-maxscale : float
- Maximum map scale.
+maxscaledenom : float
+ Minimum map scale.
maxtemplate : string
**TODO**
@@ -2905,8 +2917,8 @@
metadata : hashTableObj_ immutable
metadata hash table.
-minscale : float
- Minimum map scale.
+minscaledenom : float
+ Maximum map scale.
mintemplate : string
**TODO**
Modified: trunk/docs/en/mapscript/mapscript.txt
===================================================================
--- trunk/docs/en/mapscript/mapscript.txt 2011-08-03 21:03:17 UTC (rev 11985)
+++ trunk/docs/en/mapscript/mapscript.txt 2011-08-03 21:34:11 UTC (rev 11986)
@@ -198,14 +198,14 @@
layer : layerObj_ immutable
Reference to the parent layer
-maxscale : float
- The maximum scale at which class is drawn
+maxscaledenom : float
+ The minimum scale at which class is drawn
metadata : hashTableObj_ immutable
class metadata hash table.
-minscale : float
- The minimum scale at which class is drawn
+minscaledenom : float
+ The maximum scale at which class is drawn
name : string
Unique within a layer
@@ -470,9 +470,10 @@
size : int immutable
To access this attribute use the getSize method.
-.. note:: the getSize method is inefficient as it does a call to getBytes and then computes
- the size of the byte array. The bytearray is then immediately discarded. In most
- cases it is more efficient to call getBytes directly.
+.. note:: the getSize method is inefficient as it does a call to
+ getBytes and then computes the size of the byte array. The
+ bytearray is then immediately discarded. In most cases it is more
+ efficient to call getBytes directly.
width : int immutable
Image width in pixels.
@@ -497,9 +498,10 @@
getSize() : int
Resturns the size of the binary buffer representing the image buffer.
-.. note:: the getSize method is inefficient as it does a call to getBytes and then computes
- the size of the byte array. The byte array is then immediately discarded. In most
- cases it is more efficient to call getBytes directly.
+.. note:: the getSize method is inefficient as it does a call to
+ getBytes and then computes the size of the byte array. The byte
+ array is then immediately discarded. In most cases it is more
+ efficient to call getBytes directly.
save( string filename [, mapObj_ parent_map=NULL ] ) : int
Save image to *filename*. The optional *parent_map* parameter must be
@@ -509,8 +511,9 @@
Write image data to an open file descriptor or, by default, to *stdout*.
Returns MS_SUCCESS or MS_FAILURE.
-.. note:: This method is current enabled for Python and C# only. C# supports writing onto a
- Stream object. User-contributed typemaps are needed for Perl, Ruby, and Java.
+.. note:: This method is current enabled for Python and C# only. C#
+ supports writing onto a Stream object. User-contributed typemaps
+ are needed for Perl, Ruby, and Java.
.. note:: The free() method of imageObj has been deprecated. In MapServer
revisions 4+ all instances of imageObj will be properly disposed of by
@@ -853,12 +856,12 @@
labelitem : string
Attribute defining feature label text.
-labelmaxscale : float
+labelmaxscaledenom : float
+ Minimum scale at which layer will be labeled.
+
+labelminscaledenom : float
Maximum scale at which layer will be labeled.
-labelminscale : float
- Minimum scale at which layer will be labeled.
-
labelrequires : string
Logical expression.
@@ -872,14 +875,14 @@
Maximum number of layer features that will be drawn. For shapefile data
this means the first N features where N = maxfeatures.
-maxscale : float
- Maximum scale at which layer will be drawn.
+maxscaledenom : float
+ Minimum scale at which layer will be drawn.
metadata : hashTableObj_ immutable
Layer metadata.
-minscale : float
- Minimum scale at which layer will be drawn.
+minscaledenom : float
+ Maximum scale at which layer will be drawn.
name : string
Unique identifier for layer.
@@ -906,7 +909,8 @@
Logical expression.
sizeunits : int
- Units of class size values. MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
+ Units of class size values. MS_INCHES, MS_FEET, MS_MILES,
+ MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
status : int
MS_ON, MS_OFF, or MS_DEFAULT.
@@ -914,7 +918,7 @@
styleitem : string
Attribute defining styles.
-symbolscale : float
+symbolscaledenom : float
Scale at which symbols are default size.
template : string
@@ -931,7 +935,8 @@
Search buffer for point and line queries.
toleranceunits : int
- MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS, MS_KILOMETERS, MS_DD or MS_PIXELS
+ MS_INCHES, MS_FEET, MS_MILES, MS_NAUTICALMILES, MS_METERS,
+ MS_KILOMETERS, MS_DD or MS_PIXELS
transform : int
Whether or not layer data is to be transformed to image units.
@@ -1104,8 +1109,8 @@
Returns the index at which the class was inserted.
isVisible( ) : int
- Returns MS_TRUE or MS_FALSE after considering the layer status, minscale,
- and maxscale within the context of the parent map.
+ Returns MS_TRUE or MS_FALSE after considering the layer status, minscaledenom,
+ and maxscaledenom within the context of the parent map.
moveClassDown( int class ) : int
The class specified by the class index will be moved up into
@@ -1487,7 +1492,7 @@
resolution : float
Nominal DPI resolution. Default is 72.
-scale : float
+scaledenom : float
The nominal map scale. A value of 25000 means 1:25000 scale.
scalebar : scalebarObj_ immutable
@@ -2510,8 +2515,9 @@
Draws the individual shape using layer. Returns MS_SUCCESS or MS_FAILURE.
equals( shapeObj shape2 ) : int
- Returns MS_TRUE if the shape and shape2 are equal (geometry only). Returns -1
- on error and MS_FALSE otherwise. Requires GEOS support.
+ Returns MS_TRUE if the shape and shape2 are equal (geometry
+ only). Returns -1 on error and MS_FALSE otherwise. Requires GEOS
+ support.
fromWKT( char \*wkt ) : shapeObj
Returns a new shapeObj based on a well-known text representation of a
@@ -2636,33 +2642,37 @@
Foreground or fill pen color.
mincolor : colorObj_
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
minsize : int
Minimum pen or symbol width for scaling styles.
minvalue : double
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
minwidth : int
Minimum width of the symbol.
maxcolor : colorObj_
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
maxsize : int
Maximum pen or symbol width for scaling.
maxvalue : double
- Attribute for Color Range Mapping (:ref:`rfc6`). mincolor, minvalue, maxcolor,
- maxvalue define the range for mapping a continuous feature value to a continuous
- range of colors when rendering the feature on the map.
+ Attribute for Color Range Mapping (:ref:`rfc6`). mincolor,
+ minvalue, maxcolor, maxvalue define the range for mapping a
+ continuous feature value to a continuous range of colors when
+ rendering the feature on the map.
maxwidth : int
Maximum width of the symbol.
@@ -2677,13 +2687,15 @@
Outline pen color.
rangeitem : string
- Attribute/field that stores the values for the Color Range Mapping (:ref:`rfc6`).
+ Attribute/field that stores the values for the Color Range Mapping
+ (:ref:`rfc6`).
size : int
Pixel width of the style's pen or symbol.
sizeitem : string
- Attribute/field that stores the size to be used in rendering. Value is given in pixels.
+ Attribute/field that stores the size to be used in
+ rendering. Value is given in pixels.
symbol : int
The index within the map symbolset of the style's symbol.
@@ -2896,8 +2908,8 @@
map : mapObj immutable
Reference to parent mapObj.
-maxscale : float
- Maximum map scale.
+maxscaledenom : float
+ Minimum map scale.
maxtemplate : string
**TODO**
@@ -2905,8 +2917,8 @@
metadata : hashTableObj_ immutable
metadata hash table.
-minscale : float
- Minimum map scale.
+minscaledenom : float
+ Maximum map scale.
mintemplate : string
**TODO**
More information about the mapserver-commits
mailing list