Credit

new Cesium.Credit(options)
Core/Credit.js 37

A credit contains data pertaining to how to display attributions/credits for certain content on the screen.
Name Type Description
options Object optional An object with the following properties
Name Type Default Description
text String optional The text to be displayed on the screen if no imageUrl is specified.
imageUrl String optional The source location for an image
link String optional A URL location for which the credit will be hyperlinked
showOnScreen String false optional If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover
Throws:
  • 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({
    text : 'Cesium',
    imageUrl : '/images/cesium_logo.png',
    link : 'https://cesiumjs.org/'
});

Members

readonlyimageUrl : String
Core/Credit.js 99

The source location for the image.
A URL location for the credit hyperlink

readonlyshowOnScreen : Boolean
Core/Credit.js 136

Whether the credit should be displayed on screen or in a lightbox

readonlytext : String
Core/Credit.js 87

The credit text

Methods

staticCesium.Credit.equals(left, right) → Boolean
Core/Credit.js 168

Returns true if the credits are equal
Name Type Description
left Credit The first credit
right Credit The second credit
Returns:
true if left and right are equal, false otherwise.

equals(credit) → Boolean
Core/Credit.js 181

Returns true if the credits are equal
Name Type Description
credit Credit The credit to compare to.
Returns:
true if left and right are equal, false otherwise.

hasImage() → Boolean
Core/Credit.js 148

Returns true if the credit has an imageUrl
Returns:
Returns true if the credit has a link
Returns: