Merge pull request #1657 from elemoine/renderer

Do not expose both renderer and renderers options
2014-02-06 18:37:27 +01:00
parent 57f77bb444 1acc542bb6
commit 261832c629
36 changed files with 44 additions and 41 deletions
--- a/examples/accessible.js
+++ b/examples/accessible.js
@@ -11,7 +11,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/animation.js
+++ b/examples/animation.js
@@ -28,7 +28,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/bind-input.js
+++ b/examples/bind-input.js
@@ -30,7 +30,7 @@ var view = new ol.View2D({

 var map = new ol.Map({
  layers: [layer],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/bing-maps.js
+++ b/examples/bing-maps.js
@@ -26,7 +26,7 @@ for (i = 0, ii = styles.length; i < ii; ++i) {
 }
 var map = new ol.Map({
  layers: layers,
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [-6655.5402445057125, 6709968.258934638],
--- a/examples/canvas-tiles.js
+++ b/examples/canvas-tiles.js
@@ -22,7 +22,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform(
--- a/examples/custom-controls.js
+++ b/examples/custom-controls.js
@@ -71,7 +71,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/d3.js
+++ b/examples/d3.js
@@ -19,7 +19,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ['canvas'],
+  renderer: 'canvas',
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform([-97, 38], 'EPSG:4326', 'EPSG:3857'),
--- a/examples/device-orientation.js
+++ b/examples/device-orientation.js
@@ -16,7 +16,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/drag-and-drop-image-vector.js
+++ b/examples/drag-and-drop-image-vector.js
@@ -105,7 +105,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/drag-rotate-and-zoom.js
+++ b/examples/drag-rotate-and-zoom.js
@@ -16,7 +16,7 @@ var map = new ol.Map({
      source: new ol.source.MapQuest({layer: 'sat'})
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/epsg-4326.js
+++ b/examples/epsg-4326.js
@@ -29,7 +29,7 @@ var map = new ol.Map({
  ]),
  layers: layers,
  // The OSgeo server does not set cross origin headers, so we cannot use WebGL
-  renderers: [ol.RendererHint.CANVAS, ol.RendererHint.DOM],
+  renderer: [ol.RendererHint.CANVAS, ol.RendererHint.DOM],
  target: 'map',
  view: new ol.View2D({
    projection: 'EPSG:4326',
--- a/examples/full-screen.js
+++ b/examples/full-screen.js
@@ -24,7 +24,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/geolocation.js
+++ b/examples/geolocation.js
@@ -24,7 +24,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/layer-group.js
+++ b/examples/layer-group.js
@@ -31,7 +31,7 @@ var map = new ol.Map({
      ]
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform([37.40570, 8.81566], 'EPSG:4326', 'EPSG:3857'),
--- a/examples/mapquest.js
+++ b/examples/mapquest.js
@@ -33,7 +33,7 @@ var layers = [

 var map = new ol.Map({
  layers: layers,
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform(
--- a/examples/min-max-resolution.js
+++ b/examples/min-max-resolution.js
@@ -26,7 +26,7 @@ var map = new ol.Map({
      maxResolution: 20000
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [653600, 5723680],
--- a/examples/mobile-full-screen.js
+++ b/examples/mobile-full-screen.js
@@ -20,7 +20,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: view
 });
--- a/examples/mouse-position.js
+++ b/examples/mouse-position.js
@@ -26,7 +26,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/moveend.js
+++ b/examples/moveend.js
@@ -13,7 +13,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/navigation-controls.js
+++ b/examples/navigation-controls.js
@@ -21,7 +21,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/overlay.js
+++ b/examples/overlay.js
@@ -15,7 +15,7 @@ var layer = new ol.layer.Tile({

 var map = new ol.Map({
  layers: [layer],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/popup.js
+++ b/examples/popup.js
@@ -48,7 +48,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  overlays: [overlay],
  target: 'map',
  view: new ol.View2D({
--- a/examples/preload.js
+++ b/examples/preload.js
@@ -15,7 +15,7 @@ var map1 = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map1',
  view: new ol.View2D({
    center: [-4808600, -2620936],
@@ -33,7 +33,7 @@ var map2 = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map2'
 });
 map2.bindTo('view', map1);
--- a/examples/rotation.js
+++ b/examples/rotation.js
@@ -11,7 +11,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [-25860000, 4130000],
--- a/examples/scale-line.js
+++ b/examples/scale-line.js
@@ -19,7 +19,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/semi-transparent-layer.js
+++ b/examples/semi-transparent-layer.js
@@ -19,7 +19,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform([-77.93255, 37.9555], 'EPSG:4326', 'EPSG:3857'),
--- a/examples/simple.js
+++ b/examples/simple.js
@@ -11,7 +11,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/stamen.js
+++ b/examples/stamen.js
@@ -19,7 +19,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: ol.proj.transform(
--- a/examples/teleport.js
+++ b/examples/teleport.js
@@ -11,7 +11,7 @@ var map = new ol.Map({
      source: new ol.source.OSM()
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  view: new ol.View2D({
    center: [0, 0],
    zoom: 2
--- a/examples/tilejson.js
+++ b/examples/tilejson.js
@@ -14,7 +14,7 @@ var map = new ol.Map({
      })
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [0, 0],
--- a/examples/wms-custom-proj.js
+++ b/examples/wms-custom-proj.js
@@ -59,7 +59,7 @@ var map = new ol.Map({
    })
  ]),
  layers: layers,
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    projection: projection,
--- a/examples/wms-image-custom-proj.js
+++ b/examples/wms-image-custom-proj.js
@@ -51,7 +51,7 @@ var layers = [

 var map = new ol.Map({
  layers: layers,
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    projection: projection,
--- a/examples/wms-no-proj.js
+++ b/examples/wms-no-proj.js
@@ -53,7 +53,7 @@ var projection = new ol.proj.Projection({

 var map = new ol.Map({
  layers: layers,
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    center: [660000, 190000],
--- a/examples/zoomify.js
+++ b/examples/zoomify.js
@@ -42,7 +42,7 @@ var map = new ol.Map({
      source: source
    })
  ],
-  renderers: ol.RendererHints.createFromQueryData(),
+  renderer: ol.RendererHints.createFromQueryData(),
  target: 'map',
  view: new ol.View2D({
    projection: proj,
--- a/src/objectliterals.jsdoc
+++ b/src/objectliterals.jsdoc
@@ -42,8 +42,7 @@
 * @property {boolean|undefined} ol3Logo Show ol3 logo. Default is `true`.
 * @property {ol.Collection|Array.<ol.Overlay>|undefined} overlays
 *     Overlays initially added to the map.
- * @property {ol.RendererHint|undefined} renderer Renderer.
- * @property {Array.<ol.RendererHint>|undefined} renderers Renderers.
+ * @property {ol.RendererHint|Array.<ol.RendererHint>|undefined} renderer Renderer.
 * @property {Element|string|undefined} target The container for the map.
 * @property {ol.IView|undefined} view The map's view. Currently
 *     {@link ol.View2D} is available as view.
--- a/src/ol/map.js
+++ b/src/ol/map.js
@@ -1370,10 +1370,14 @@ ol.Map.createOptionsInternal = function(options) {
   * @type {Array.<ol.RendererHint>}
   */
  var rendererHints;
-  if (goog.isDef(options.renderers)) {
-    rendererHints = options.renderers;
-  } else if (goog.isDef(options.renderer)) {
-    rendererHints = [options.renderer];
+  if (goog.isDef(options.renderer)) {
+    if (goog.isArray(options.renderer)) {
+      rendererHints = options.renderer;
+    } else if (goog.isString(options.renderer)) {
+      rendererHints = [options.renderer];
+    } else {
+      goog.asserts.fail('Incorrect format for renderer option');
+    }
  } else {
    rendererHints = ol.DEFAULT_RENDERER_HINTS;
  }