Project

General

Profile

Download (1.92 KB) Statistics
| Branch: | Tag: | Revision:
1
/* Copyright (c) 2006-2013 by OpenLayers Contributors (see authors.txt for
2
 * full list of contributors). Published under the 2-clause BSD license.
3
 * See license.txt in the OpenLayers distribution or repository for the
4
 * full text of the license. */
5

    
6
/**
7
 * @requires OpenLayers/Format/XML/VersionedOGC.js
8
 */
9

    
10
/**
11
 * Class: OpenLayers.Format.XLS
12
 * Read/Write XLS (OpenLS). Create a new instance with the <OpenLayers.Format.XLS>
13
 *     constructor. Currently only implemented for Location Utility Services, more
14
 *     specifically only for Geocoding. No support for Reverse Geocoding as yet.
15
 * 
16
 * Inherits from:
17
 *  - <OpenLayers.Format.XML.VersionedOGC>
18
 */
19
OpenLayers.Format.XLS = OpenLayers.Class(OpenLayers.Format.XML.VersionedOGC, {
20
    
21
    /**
22
     * APIProperty: defaultVersion
23
     * {String} Version number to assume if none found.  Default is "1.1.0".
24
     */
25
    defaultVersion: "1.1.0",
26
 
27
    /**
28
     * APIProperty: stringifyOutput
29
     * {Boolean} If true, write will return a string otherwise a DOMElement.
30
     * Default is true.
31
     */
32
    stringifyOutput: true,
33
    
34
    /**
35
     * Constructor: OpenLayers.Format.XLS
36
     * Create a new parser for XLS.
37
     *
38
     * Parameters:
39
     * options - {Object} An optional object whose properties will be set on
40
     *     this instance.
41
     */
42

    
43
    /**
44
     * APIMethod: write
45
     * Write out an XLS request.
46
     *
47
     * Parameters:
48
     * request - {Object} An object representing the LUS request.
49
     * options - {Object} Optional configuration object.
50
     *
51
     * Returns:
52
     * {String} An XLS document string.
53
     */
54
    
55
    /**
56
     * APIMethod: read
57
     * Read an XLS doc and return an object representing the result.
58
     *
59
     * Parameters:
60
     * data - {String | DOMElement} Data to read.
61
     * options - {Object} Options for the reader.
62
     *
63
     * Returns:
64
     * {Object} An object representing the GeocodeResponse.
65
     */
66

    
67
    CLASS_NAME: "OpenLayers.Format.XLS" 
68
});
(40-40/41)