OpenLayers OpenLayers

Changeset 3535

Show
Ignore:
Timestamp:
06/29/07 06:12:38 (1 year ago)
Author:
crschmidt
Message:

complete vector docs.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Layer/Vector.js

    r3522 r3535  
    2121 
    2222    /** 
    23      * Property: isBaseLayer 
     23     * APIProperty: isBaseLayer 
    2424     * {Boolean} The layer is a base layer.  Default is true.  Set this property 
    2525     * in the layer options 
    …… 
    2727    isBaseLayer: false, 
    2828 
    29     /** @type Boolean */ 
     29    /**  
     30     * APIProperty: isFixed 
     31     * {Boolean} Whether the layer remains in one place while dragging the 
     32     * map. 
     33     */ 
    3034    isFixed: false, 
    3135 
    32     /** @type Boolean */ 
     36    /**  
     37     * APIProperty: isVector 
     38     * {Boolean} Whether the layer is a vector layer. 
     39     */ 
    3340    isVector: true, 
    3441 
    35     /** @type Array(OpenLayer.Feature.Vector) */ 
     42    /**  
     43     * APIProperty: features 
     44     * Array({<OpenLayer.Feature.Vector>})  
     45     */ 
    3646    features: null, 
    3747     
    38     /** @type Array(OpenLayers.Feature.Vector) */ 
     48    /**  
     49     * Property: selectedFeatures 
     50     * Array({<OpenLayers.Feature.Vector>})  
     51     */ 
    3952    selectedFeatures: null, 
    4053 
    41     /** @type {Boolean} */ 
     54    /** 
     55     * APIProperty: reportError 
     56     * {Boolean} report error message via alert() when loading of renderers 
     57     * fails. 
     58     */ 
    4259    reportError: true,  
    4360 
    44     /** @type {Object} */ 
     61    /**  
     62     * APIProperty: style 
     63     * {Object} Default style for the layer 
     64     */ 
    4565    style: null, 
    4666 
    4767    /** 
    48      * List of supported Renderer classes. Add to this list to 
     68     * Property: renderers 
     69     * Array({String}) List of supported Renderer classes. Add to this list to 
    4970     * add support for additional renderers. This list is ordered: 
    5071     * the first renderer which returns true for the  'supported()' 
    5172     * method will be used, if not defined in the 'renderer' option. 
    52      *  
    53      * @type {Array(String)}  
    5473     */ 
    5574    renderers: ['SVG', 'VML'], 
    5675     
    57     /** @type OpenLayers.Renderer */ 
     76    /**  
     77     * Property: renderer 
     78     * {<OpenLayers.Renderer>} 
     79     */ 
    5880    renderer: null, 
    5981    
    6082    /**  
    61      * geometryType allows you to limit the types of geometries this 
    62      * layer supports. This should be set to something like  
     83     * APIProperty: geometryType 
     84     * {String} geometryType allows you to limit the types of geometries this 
     85     * layer supports. This should be set to something like 
    6386     * "OpenLayers.Geometry.Point" to limit types. 
    64      *  
    65      * @type string  
    6687     */ 
    6788    geometryType: null, 
    6889 
    69     /** Whether the Vector Layer features have been drawn yet. 
    70      * 
    71      * @type boolean  
     90    /**  
     91     * Property: drawn 
     92     * {Boolean} Whether the Vector Layer features have been drawn yet. 
    7293     */ 
    7394    drawn: false, 
    …… 
    108129 
    109130    /** 
    110      * Method: destroy 
     131     * APIMethod: destroy 
    111132     * Destroy this layer 
    112133     */ 
    …… 
    125146    }, 
    126147 
    127     /** Iterates through the available renderer implementations and selects  
    128      *  and assigns the first one whose "supported()" function returns true. 
    129      *  
    130      * @private 
    131      *  
     148    /**  
     149     * Method: assignRenderer 
     150     * Iterates through the available renderer implementations and selects  
     151     * and assigns the first one whose "supported()" function returns true. 
    132152     */     
    133153    assignRenderer: function()  { 
    …… 
    142162 
    143163    /**  
     164     * Method: displayError  
    144165     * Let the user know their browser isn't supported. 
    145      *  
    146      * @private 
    147      *  
    148166     */ 
    149167    displayError: function() { 
    …… 
    156174    }, 
    157175 
    158     /** The layer has been added to the map.  
    159      *  
    160      *  If there is no renderer set, the layer can't be used. Remove it. 
    161      *  Otherwise, give the renderer a reference to the map and set its size. 
    162      *  
    163      * @param {<OpenLayers.Map>} map 
     176    /**  
     177     * Method: setMap 
     178     * The layer has been added to the map.  
     179     *  
     180     * If there is no renderer set, the layer can't be used. Remove it. 
     181     * Otherwise, give the renderer a reference to the map and set its size. 
     182     *  
     183     * Parameters: 
     184     * map - {<OpenLayers.Map>}  
    164185     */ 
    165186    setMap: function(map) {         
    …… 
    174195    }, 
    175196     
    176     /** Notify the renderer of the change in size.  
     197    /** 
     198     * Method: onMapResize 
     199     * Notify the renderer of the change in size.  
    177200     *  
    178201     */ 
    …… 
    182205    }, 
    183206 
    184     /** Reset the vector layer's div so that it once again is lined up with  
     207    /** 
     208     * Method: moveTo 
     209     *  Reset the vector layer's div so that it once again is lined up with  
    185210     *   the map. Notify the renderer of the change of extent, and in the 
    186211     *   case of a change of zoom level (resolution), have the  
    …… 
    190215     *   features and draw each one. 
    191216     *  
    192      * @param {<OpenLayers.Bounds>} bounds 
    193      * @param {Boolean} zoomChanged 
    194      * @param {Boolean} dragging 
     217     * Parameters: 
     218     * bounds - {<OpenLayers.Bounds>}  
     219     * zoomChanged - {Boolean}  
     220     * dragging - {Boolean}  
    195221     */ 
    196222    moveTo: function(bounds, zoomChanged, dragging) { 
    …… 
    214240 
    215241    /** 
    216      * @param {Array(OpenLayers.Feature.Vector} features 
     242     * APIMethod: addFeatures 
     243     * Add Features to the layer. 
     244     * 
     245     * Parameters: 
     246     * features - {Array(<OpenLayers.Feature.Vector>)}  
    217247     */ 
    218248    addFeatures: function(features) { 
    …… 
    252282 
    253283    /** 
    254      * @param {Array(OpenLayers.Feature.Vector} features 
     284     * APIMethod: removeFeatures 
     285     *  
     286     * Parameters: 
     287     * features - {Array(<OpenLayers.Feature.Vector>)}  
    255288     */ 
    256289    removeFeatures: function(features) { 
    …… 
    276309 
    277310    /** 
     311     * APIMethod: destroyFeatures 
    278312     * Destroy all features on the layer and empty the selected features array. 
    279313     */ 
    …… 
    286320 
    287321    /** 
     322     * Method: drawFeature 
    288323     * Draw (or redraw) a feature on the layer.  If the optional style argument 
    289324     * is included, this style will be used.  If no style is included, the 
    …… 
    291326     * the layer's style will be used. 
    292327     *  
    293      * @param {<OpenLayers.Feature.Vector>} feature 
    294      * @param {Object} style 
     328     * Parameters:  
     329     * feature - {<OpenLayers.Feature.Vector>}  
     330     * style - {Object}  
    295331     */ 
    296332    drawFeature: function(feature, style) { 
    …… 
    306342     
    307343    /** 
     344     * Method: eraseFeatures 
    308345     * Erase features from the layer. 
    309      *  
    310      * @param {Array(OpenLayers.Feature.Vector)} features 
     346     * 
     347     * Parameters: 
     348     * features - {Array(OpenLayers.Feature.Vector)}  
    311349     */ 
    312350    eraseFeatures: function(features) { 
    …… 
    315353 
    316354    /** 
     355     * Method: getFeatureFromEvent 
    317356     * Given an event, return a feature if the event occurred over one. 
    318357     * Otherwise, return null. 
    319358     * 
    320      * @param {Event} 
    321      * @type OpenLayers.Feature.Vector 
    322      * @return A feature if one was under the event 
     359     * Parameters: 
     360     * evt - {Event}  
     361     * 
     362     * Returns: 
     363     * {<OpenLayers.Feature.Vector>} A feature if one was under the event. 
    323364     */ 
    324365    getFeatureFromEvent: function(evt) { 
    …… 
    328369     
    329370    /** 
     371     * APIMethod: getFeatureById 
    330372     * Given a feature id, return the feature if it exists in the features array 
    331      *  
    332      * @param {String} featureId 
    333      * @type OpenLayers.Feature.Vector 
    334      * @return A feature corresponding to the given featureId 
     373     * 
     374     * Parameters: 
     375     * featureId - {String}  
     376     * 
     377     * Returns: 
     378     * {<OpenLayers.Feature.Vector>} A feature corresponding to the given 
     379     * featureId 
    335380     */ 
    336381    getFeatureById: function(featureId) { 
    …… 
    363408 
    364409    /** 
    365      * method called when a feature is inserted. 
     410     * APIMethod: onFeatureInsert 
     411     * method called after a feature is inserted. 
    366412     * Does nothing by default. Override this if you 
    367413     * need to do something on feature updates. 
    368      *  
    369      * @param {<OpenLayers.Feature.Vector>} feature 
     414     * 
     415     * Paarameters:  
     416     * feature - {<OpenLayers.Feature.Vector>}  
    370417     */ 
    371418    onFeatureInsert: function(feature) { 
    …… 
    373420     
    374421    /** 
     422     * APIMethod: preFeatureInsert 
    375423     * method called before a feature is inserted. 
    376424     * Does nothing by default. Override this if you 
    377425     * need to do something when features are first added to the 
    378426     * layer, but before they are drawn, such as adjust the style. 
    379      *  
    380      * @param {<OpenLayers.Feature.Vector>} feature 
     427     * 
     428     * Parameters: 
     429     * feature - {<OpenLayers.Feature.Vector>}  
    381430     */ 
    382431    preFeatureInsert: function(feature) {