Merge pull request #947 from elemoine/attribution

Make ol.Attribution take an options object
2013-09-02 03:10:41 -07:00
parent fdc70f3c30 729039ba04
commit 1c72a4d078
13 changed files with 96 additions and 64 deletions
--- a/examples/localized-openstreetmap.js
+++ b/examples/localized-openstreetmap.js
@@ -11,9 +11,10 @@ var map = new ol.Map({
    new ol.layer.TileLayer({
      source: new ol.source.OSM({
        attributions: [
-          new ol.Attribution(
-              'All maps &copy; ' +
-              '<a href="http://www.opencyclemap.org/">OpenCycleMap</a>'),
+          new ol.Attribution({
+            html: 'All maps &copy; ' +
+                '<a href="http://www.opencyclemap.org/">OpenCycleMap</a>'
+          }),
          ol.source.OSM.DATA_ATTRIBUTION
        ],
        url: 'http://{a-c}.tile.opencyclemap.org/cycle/{z}/{x}/{y}.png'
--- a/examples/wms-custom-proj.js
+++ b/examples/wms-custom-proj.js
@@ -21,10 +21,12 @@ var layers = [
    source: new ol.source.TiledWMS({
      url: 'http://wms.geo.admin.ch/',
      crossOrigin: 'anonymous',
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'Pixelmap 1:1000000 / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'Pixelmap 1:1000000 / geo.admin.ch</a>'
+      })],
      params: {
        'LAYERS': 'ch.swisstopo.pixelkarte-farbe-pk1000.noscale',
        'FORMAT': 'image/jpeg'
@@ -36,10 +38,12 @@ var layers = [
    source: new ol.source.TiledWMS({
      url: 'http://wms.geo.admin.ch/',
      crossOrigin: 'anonymous',
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'National parks / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'National parks / geo.admin.ch</a>'
+      })],
      params: {'LAYERS': 'ch.bafu.schutzgebiete-paerke_nationaler_bedeutung'},
      extent: extent
    })
--- a/examples/wms-no-proj.js
+++ b/examples/wms-no-proj.js
@@ -13,10 +13,12 @@ goog.require('ol.source.TiledWMS');
 var layers = [
  new ol.layer.TileLayer({
    source: new ol.source.TiledWMS({
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'Pixelmap 1:1000000 / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'Pixelmap 1:1000000 / geo.admin.ch</a>'
+      })],
      crossOrigin: 'anonymous',
      params: {
        'LAYERS': 'ch.swisstopo.pixelkarte-farbe-pk1000.noscale',
@@ -27,10 +29,12 @@ var layers = [
  }),
  new ol.layer.ImageLayer({
    source: new ol.source.SingleImageWMS({
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'National parks / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'National parks / geo.admin.ch</a>'
+      })],
      crossOrigin: 'anonymous',
      params: {'LAYERS': 'ch.bafu.schutzgebiete-paerke_nationaler_bedeutung'},
      url: 'http://wms.geo.admin.ch/'
--- a/examples/wms-single-image-custom-proj.js
+++ b/examples/wms-single-image-custom-proj.js
@@ -18,10 +18,12 @@ var layers = [
    source: new ol.source.SingleImageWMS({
      url: 'http://wms.geo.admin.ch/',
      crossOrigin: 'anonymous',
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'Pixelmap 1:1000000 / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'Pixelmap 1:1000000 / geo.admin.ch</a>'
+      })],
      params: {
        'LAYERS': 'ch.swisstopo.pixelkarte-farbe-pk1000.noscale',
        'FORMAT': 'image/jpeg'
@@ -33,10 +35,12 @@ var layers = [
    source: new ol.source.SingleImageWMS({
      url: 'http://wms.geo.admin.ch/',
      crossOrigin: 'anonymous',
-      attributions: [new ol.Attribution(
-          '&copy; ' +
-          '<a href="http://www.geo.admin.ch/internet/geoportal/en/home.html">' +
-          'National parks / geo.admin.ch</a>')],
+      attributions: [new ol.Attribution({
+        html: '&copy; ' +
+            '<a href="http://www.geo.admin.ch/internet/geoportal/' +
+            'en/home.html">' +
+            'National parks / geo.admin.ch</a>'
+      })],
      params: {'LAYERS': 'ch.bafu.schutzgebiete-paerke_nationaler_bedeutung'},
      extent: extent
    })
--- a/examples/wmts-ign.js
+++ b/examples/wmts-ign.js
@@ -51,10 +51,11 @@ xhr.onload = function() {
      'http://gpp3-wxs.ign.fr/static/logos/IGN/IGN.gif'
    ];

-    var attribution = new ol.Attribution(
-        '<a href="http://www.geoportail.fr/" target="_blank">' +
-        '<img src="http://api.ign.fr/geoportail/api/js/latest/' +
-        'theme/geoportal/img/logo_gp.gif"></a>');
+    var attribution = new ol.Attribution({
+      html: '<a href="http://www.geoportail.fr/" target="_blank">' +
+          '<img src="http://api.ign.fr/geoportail/api/js/latest/' +
+          'theme/geoportal/img/logo_gp.gif"></a>'
+    });

    var sourceOptions;
    var source;
--- a/src/objectliterals.jsdoc
+++ b/src/objectliterals.jsdoc
@@ -1,3 +1,10 @@
+/**
+ * @typedef {Object} ol.AttributionOptions
+ * @property {string} html HTML markup for this attribution.
+ * @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
+ *     Tile ranges (FOR INTERNAL USE ONLY).
+ */
+
 /**
 * @typedef {Object} ol.DeviceOrientationOptions
 * @property {boolean|undefined} tracking Tracking.
--- a/src/ol/attribution.exports
+++ b/src/ol/attribution.exports
@@ -1 +1 @@
-@exportSymbol ol.Attribution
+@exportClass ol.Attribution ol.AttributionOptions
--- a/src/ol/attribution.js
+++ b/src/ol/attribution.js
@@ -11,31 +11,31 @@ goog.require('ol.TileRange');
 *
 *     source: new ol.source.OSM({
 *       attributions: [
- *       new ol.Attribution(
- *         'All maps &copy; ' +
- *         '<a href="http://www.opencyclemap.org/">OpenCycleMap</a>'),
+ *       new ol.Attribution({
+ *         html: 'All maps &copy; ' +
+ *             '<a href="http://www.opencyclemap.org/">OpenCycleMap</a>'
+ *       }),
 *       ol.source.OSM.DATA_ATTRIBUTION
 *     ],
 *     ..
 *
 * @constructor
- * @param {string} html The markup to use for display of the attribution.
- * @param {Object.<string, Array.<ol.TileRange>>=} opt_tileRanges Tile ranges
- *     (FOR INTERNAL USE ONLY).
+ * @param {ol.AttributionOptions} options Attribution options.
 */
-ol.Attribution = function(html, opt_tileRanges) {
+ol.Attribution = function(options) {

  /**
   * @private
   * @type {string}
   */
-  this.html_ = html;
+  this.html_ = options.html;

  /**
   * @private
   * @type {Object.<string, Array.<ol.TileRange>>}
   */
-  this.tileRanges_ = opt_tileRanges || null;
+  this.tileRanges_ = goog.isDef(options.tileRanges) ?
+      options.tileRanges : null;

 };

--- a/src/ol/source/bingmapssource.js
+++ b/src/ol/source/bingmapssource.js
@@ -131,7 +131,7 @@ ol.source.BingMaps.prototype.handleImageryMetadataResponse =
                }
              }
            });
-        return new ol.Attribution(html, tileRanges);
+        return new ol.Attribution({html: html, tileRanges: tileRanges});
      });
  this.setAttributions(attributions);

--- a/src/ol/source/mapquestsource.js
+++ b/src/ol/source/mapquestsource.js
@@ -14,9 +14,10 @@ goog.require('ol.source.XYZ');
 ol.source.MapQuestOSM = function() {

  var attributions = [
-    new ol.Attribution(
-        'Tiles Courtesy of ' +
-        '<a href="http://www.mapquest.com/" target="_blank">MapQuest</a>'),
+    new ol.Attribution({
+      html: 'Tiles Courtesy of ' +
+          '<a href="http://www.mapquest.com/" target="_blank">MapQuest</a>'
+    }),
    ol.source.OSM.DATA_ATTRIBUTION
  ];

@@ -41,12 +42,14 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ);
 ol.source.MapQuestOpenAerial = function() {

  var attributions = [
-    new ol.Attribution(
-        'Tiles Courtesy of ' +
-        '<a href="http://www.mapquest.com/" target="_blank">MapQuest</a>'),
-    new ol.Attribution(
-        'Portions Courtesy NASA/JPL-Caltech and ' +
-        'U.S. Depart. of Agriculture, Farm Service Agency')
+    new ol.Attribution({
+      html: 'Tiles Courtesy of ' +
+          '<a href="http://www.mapquest.com/" target="_blank">MapQuest</a>'
+    }),
+    new ol.Attribution({
+      html: 'Portions Courtesy NASA/JPL-Caltech and ' +
+          'U.S. Depart. of Agriculture, Farm Service Agency'
+    })
  ];

  goog.base(this, {
--- a/src/ol/source/osmsource.js
+++ b/src/ol/source/osmsource.js
@@ -44,21 +44,24 @@ goog.inherits(ol.source.OSM, ol.source.XYZ);
 * @const
 * @type {ol.Attribution}
 */
-ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution(
-    'Data &copy; <a href="http://www.openstreetmap.org/">OpenStreetMap</a> ' +
-    'contributors, ' +
-    '<a href="http://www.openstreetmap.org/copyright">ODbL</a>');
+ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
+  html: 'Data &copy; ' +
+      '<a href="http://www.openstreetmap.org/">OpenStreetMap</a> ' +
+      'contributors, ' +
+      '<a href="http://www.openstreetmap.org/copyright">ODbL</a>'
+});


 /**
 * @const
 * @type {ol.Attribution}
 */
-ol.source.OSM.TILE_ATTRIBUTION = new ol.Attribution(
-    'Tiles &copy; ' +
-    '<a href="http://www.openstreetmap.org/">OpenStreetMap</a> ' +
-    'contributors, ' +
-    '<a href="http://creativecommons.org/licenses/by-sa/2.0/">CC BY-SA</a>');
+ol.source.OSM.TILE_ATTRIBUTION = new ol.Attribution({
+  html: 'Tiles &copy; ' +
+      '<a href="http://www.openstreetmap.org/">OpenStreetMap</a> ' +
+      'contributors, ' +
+      '<a href="http://creativecommons.org/licenses/by-sa/2.0/">CC BY-SA</a>'
+});


 /**
--- a/src/ol/source/stamensource.js
+++ b/src/ol/source/stamensource.js
@@ -114,8 +114,10 @@ goog.inherits(ol.source.Stamen, ol.source.XYZ);
 * @const {Array.<ol.Attribution>}
 */
 ol.source.Stamen.ATTRIBUTIONS = [
-  new ol.Attribution(
-      'Map tiles by <a href="http://stamen.com/">Stamen Design</a>, under ' +
-      '<a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.'),
+  new ol.Attribution({
+    html: 'Map tiles by <a href="http://stamen.com/">Stamen Design</a>, ' +
+        'under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY' +
+        ' 3.0</a>.'
+  }),
  ol.source.OSM.DATA_ATTRIBUTION
 ];
--- a/src/ol/source/tilejsonsource.js
+++ b/src/ol/source/tilejsonsource.js
@@ -113,7 +113,10 @@ ol.source.TileJSON.prototype.handleTileJSONResponse = function() {
          [tileGrid.getTileRangeForExtentAndZ(attributionExtent, z)];
    }
    this.setAttributions([
-      new ol.Attribution(tileJSON.attribution, tileRanges)
+      new ol.Attribution({
+        html: tileJSON.attribution,
+        tileRanges: tileRanges
+      })
    ]);
  }