XLS.js 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. * @requires OpenLayers/Format/XML/VersionedOGC.js
  7. */
  8. /**
  9. * Class: OpenLayers.Format.XLS
  10. * Read/Write XLS (OpenLS). Create a new instance with the <OpenLayers.Format.XLS>
  11. * constructor. Currently only implemented for Location Utility Services, more
  12. * specifically only for Geocoding. No support for Reverse Geocoding as yet.
  13. *
  14. * Inherits from:
  15. * - <OpenLayers.Format.XML.VersionedOGC>
  16. */
  17. OpenLayers.Format.XLS = OpenLayers.Class(OpenLayers.Format.XML.VersionedOGC, {
  18. /**
  19. * APIProperty: defaultVersion
  20. * {String} Version number to assume if none found. Default is "1.1.0".
  21. */
  22. defaultVersion: "1.1.0",
  23. /**
  24. * APIProperty: stringifyOutput
  25. * {Boolean} If true, write will return a string otherwise a DOMElement.
  26. * Default is true.
  27. */
  28. stringifyOutput: true,
  29. /**
  30. * Constructor: OpenLayers.Format.XLS
  31. * Create a new parser for XLS.
  32. *
  33. * Parameters:
  34. * options - {Object} An optional object whose properties will be set on
  35. * this instance.
  36. */
  37. /**
  38. * APIMethod: write
  39. * Write out an XLS request.
  40. *
  41. * Parameters:
  42. * request - {Object} An object representing the LUS request.
  43. * options - {Object} Optional configuration object.
  44. *
  45. * Returns:
  46. * {String} An XLS document string.
  47. */
  48. /**
  49. * APIMethod: read
  50. * Read an XLS doc and return an object representing the result.
  51. *
  52. * Parameters:
  53. * data - {String | DOMElement} Data to read.
  54. * options - {Object} Options for the reader.
  55. *
  56. * Returns:
  57. * {Object} An object representing the GeocodeResponse.
  58. */
  59. CLASS_NAME: "OpenLayers.Format.XLS"
  60. });