OpenLayers OpenLayers

Changeset 3568

Show
Ignore:
Timestamp:
07/03/07 13:15:37 (1 year ago)
Author:
tschaub
Message:

#794 - adding resolutions as a property of OpenLayers.Map - adding additional comments for ND as well - we need to revisit APIProperties on Layer and Map

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/lib/OpenLayers/Layer.js

    r3555 r3568  
    101101    /**  
    102102     * Property: options 
    103      * {Object}  
     103     * {Object} An optional object whose properties will be set on the layer. 
     104     * Any of the layer properties can be set as a property of the options 
     105     * object and sent to the constructor when the layer is created. 
    104106     */ 
    105107    options: null, 
    106108 
    107109    /** 
    108      * Property: gutter 
     110     * APIProperty: gutter 
    109111     * {Integer} Determines the width (in pixels) of the gutter around image 
    110112     *           tiles to ignore.  By setting this property to a non-zero  
    …… 
    119121 
    120122    /** 
    121      * Property: projection 
     123     * APIProperty: projection 
    122124     * {String} Set in the layer options to override the default projection 
    123125     *          string this layer - also set maxExtent, maxResolution, and  
    …… 
    127129     
    128130    /** 
    129      * Property: units 
     131     * APIProperty: units 
    130132     * {String} The layer map units.  Defaults to 'degrees'.  Possible values 
    131133     *          are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. 
    …… 
    134136 
    135137    /** 
    136      * Property: scales 
     138     * APIProperty: scales 
    137139     * {Array} 
    138140     */ 
    …… 
    140142 
    141143    /** 
    142      * Property: resolutions 
    143      * {Array} 
     144     * APIProperty: resolutions 
     145     * {Array} A list of map resolutions (map units per pixel) in descending 
     146     * order.  If this is not set in the layer constructor, it will be set 
     147     * based on other resolution related properties (maxExtent, maxResolution, 
     148     * maxScale, etc.). 
    144149     */ 
    145150    resolutions: null, 
    146151     
    147152    /** 
    148      * Property: maxExtent 
     153     * APIProperty: maxExtent 
    149154     * {<OpenLayers.Bounds>} 
    150155     */ 
    …… 
    152157     
    153158    /** 
    154      * Property: minExtent 
     159     * APIProperty: minExtent 
    155160     * {<OpenLayers.Bounds>} 
    156161     */ 
    …… 
    158163     
    159164    /** 
    160      * Property: maxResolution 
     165     * APIProperty: maxResolution 
    161166     * {Float} Default max is 360 deg / 256 px, which corresponds to 
    162167     *         zoom level 0 on gmaps.  Specify a different value in the layer  
    …… 
    167172 
    168173    /** 
    169      * Property: minResolution 
     174     * APIProperty: minResolution 
    170175     * {Float} 
    171176     */ 
    …… 
    173178 
    174179    /** 
    175      * Property: numZoomLevels 
     180     * APIProperty: numZoomLevels 
    176181     * {Integer} 
    177182     */ 
    …… 
    179184    
    180185    /** 
    181      * Property: minScale 
     186     * APIProperty: minScale 
    182187     * {Float} 
    183188     */ 
    …… 
    185190     
    186191    /** 
    187      * Property: maxScale 
     192     * APIProperty: maxScale 
    188193     * {Float} 
    189194     */ 
    …… 
    191196 
    192197    /** 
    193      * Property: displayOutsideMaxExtent 
     198     * APIProperty: displayOutsideMaxExtent 
    194199     * {Boolean} Request map tiles that are completely outside of the max extent 
    195200     *           for this layer.  Defaults to false 
    …… 
    198203 
    199204    /** 
    200      * Property: wrapDateLine 
     205     * APIProperty: wrapDateLine 
    201206     * {Boolean} #487 for more info.    
    202207     */ 

  • trunk/openlayers/lib/OpenLayers/Map.js

    r3565 r3568  
    137137    viewRequestID: 0, 
    138138 
    139     // Options 
     139  // Options 
    140140 
    141141    /** 
    …… 
    147147 
    148148    /** 
    149      * Property: projection 
     149     * APIProperty: projection 
    150150     * {String} Set in the map options to override the default projection  
    151151     *          string this map - also set maxExtent, maxResolution, and  
    …… 
    155155         
    156156    /** 
    157      * Property: units 
     157     * APIProperty: units 
    158158     * {String} The map units.  Defaults to 'degrees'.  Possible values are 
    159159     *          'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. 
    …… 
    162162 
    163163    /** 
    164      * Property: maxResolution 
     164     * APIProperty: resolutions 
     165     * {Array} A list of map resolutions (map units per pixel) in descending 
     166     * order.  If this is not set in the layer constructor, it will be set 
     167     * based on other resolution related properties (maxExtent, maxResolution, 
     168     * maxScale, etc.). 
     169     */ 
     170    resolutions: null, 
     171 
     172    /** 
     173     * APIProperty: maxResolution 
    165174     * {Float} Default max is 360 deg / 256 px, which corresponds to 
    166175     *          zoom level 0 on gmaps.  Specify a different value in the map  
    …… 
    171180 
    172181    /** 
    173      * Property: minResolution 
     182     * APIProperty: minResolution 
    174183     * {Float} 
    175184     */ 
    …… 
    177186 
    178187    /** 
    179      * Property: maxScale 
     188     * APIProperty: maxScale 
    180189     * {Float} 
    181190     */ 
    …… 
    183192 
    184193    /** 
    185      * Property: minScale 
     194     * APIProperty: minScale 
    186195     * {Float} 
    187196     */ 
    …… 
    189198 
    190199    /** 
    191      * Property: maxExtent 
     200     * APIProperty: maxExtent 
    192201     * {<OpenLayers.Bounds>} The maximum extent for the map.  Defaults to the 
    193202     *                       whole world in decimal degrees  
    …… 
    200209     
    201210    /** 
    202      * Property: minExtent 
     211     * APIProperty: minExtent 
    203212     * {<OpenLayers.Bounds>} 
    204213     */ 
    …… 
    206215     
    207216    /** 
    208      * Property: numZoomLevels 
     217     * APIProperty: numZoomLevels 
    209218     * {Integer} Number of zoom levels for the map.  Defaults to 16.  Set a 
    210219     *           different value in the map options if needed.