Merge pull request #6075 from AnalyticalGraphicsInc/credits-params

Remove deprecated Credit parameters

Author: pjcozzi

CHANGES.md

@@ -3,6 +3,8 @@ Change Log
 
 ### 1.41 - 2018-01-02
 
+* Breaking changes
+  * Removed the `text`, `imageUrl`, and `link` parameters for `Credit`, which were deprecated in Cesium 1.40.  Use `options.text`, `options.imageUrl`, and `options.link` instead.
 * Added support for clipping planes
     * Added `clippingPlanes` property to `ModelGraphics`, `Model`, and `Cesium3DTileset`, which specifies a `ClippingPlaneCollection` to selectively disable rendering on the object. [#5913](https://github.com/AnalyticalGraphicsInc/cesium/pull/5913)
     * Added `clippingPlanes` property to `Globe` which specifies a `ClippingPlaneCollection` to selectively disable rendering of the globe surface. [#5996](https://github.com/AnalyticalGraphicsInc/cesium/pull/5996)

Source/Core/Credit.js

@@ -2,13 +2,11 @@ define([
     './defaultValue',
     './defined',
     './defineProperties',
-    './deprecationWarning',
     './DeveloperError'
 ], function(
     defaultValue,
     defined,
     defineProperties,
-    deprecationWarning,
     DeveloperError) {
     'use strict';
 
@@ -26,31 +24,31 @@ define([
      * @alias Credit
      * @constructor
      *
+     * @exception {DeveloperError} options.text, options.imageUrl, or options.link is required.
+     *
      * @example
      * //Create a credit with a tooltip, image and link
-     * var credit = new Cesium.Credit('Cesium', '/images/cesium_logo.png', 'http://cesiumjs.org/');
+     * var credit = new Cesium.Credit({
+     *     text : 'Cesium',
+     *     imageUrl : '/images/cesium_logo.png',
+     *     link : 'http://cesiumjs.org/'
+     * });
      */
-    function Credit(options, imageUrl, link) {
-        var text;
-        var showOnScreen;
-        if (typeof options !== 'object') {
-            deprecationWarning('Credit parameters', 'The Credit text, imageUrl and link parameters have been replaced by a single options object parameter with text, imageUrl and link properties. Use of the old parameters will be removed in Cesium 1.41');
-            text = options;
-            showOnScreen = false;
-        } else {
-            text = options.text;
-            imageUrl = options.imageUrl;
-            link = options.link;
-            showOnScreen = defaultValue(options.showOnScreen, false);
-        }
+    function Credit(options) {
+        options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+        var text = options.text;
+        var imageUrl = options.imageUrl;
+        var link = options.link;
+        var showOnScreen = defaultValue(options.showOnScreen, false);
 
         var hasLink = (defined(link));
         var hasImage = (defined(imageUrl));
         var hasText = (defined(text));
 
         //>>includeStart('debug', pragmas.debug);
         if (!hasText && !hasImage && !hasLink) {
-            throw new DeveloperError('text, imageUrl or link is required');
+            throw new DeveloperError('options.text, options.imageUrl, or options.link is required.');
         }
         //>>includeEnd('debug');
 

Source/Scene/WebMapTileServiceImageryProvider.js

@@ -78,7 +78,7 @@ define([
      *     tileMatrixSetID : 'default028mm',
      *     // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
      *     maximumLevel: 19,
-     *     credit : new Cesium.Credit('U. S. Geological Survey')
+     *     credit : new Cesium.Credit({ text : 'U. S. Geological Survey' })
      * });
      * viewer.imageryLayers.addImageryProvider(shadedRelief1);
      *
@@ -91,7 +91,7 @@ define([
      *     format : 'image/jpeg',
      *     tileMatrixSetID : 'default028mm',
      *     maximumLevel: 19,
-     *     credit : new Cesium.Credit('U. S. Geological Survey')
+     *     credit : new Cesium.Credit({ text : 'U. S. Geological Survey' })
      * });
      * viewer.imageryLayers.addImageryProvider(shadedRelief2);
      *
@@ -114,7 +114,7 @@ define([
      *     format : 'image/png',
      *     clock: clock,
      *     times: times,
-     *     credit : new Cesium.Credit('NASA Global Imagery Browse Services for EOSDIS')
+     *     credit : new Cesium.Credit({ text : 'NASA Global Imagery Browse Services for EOSDIS' })
      * });
      * viewer.imageryLayers.addImageryProvider(weather);
      *