English | 简体中文

Credit

new Cesium.Credit(html, showOnScreen)

A credit contains data pertaining to how to display attributions/credits for certain content on the screen.
Name Type Default Description
html string An string representing an html code snippet
showOnScreen boolean false optional If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover
Throws:
Example:
// Create a credit with a tooltip, image and link
const credit = new Cesium.Credit('<a href="https://cesium.com/" target="_blank"><img src="/images/cesium_logo.png" title="Cesium"/></a>');

Members

readonly element : HTMLElement

Gets the credit element

readonly html : string

The credit content

showOnScreen : boolean

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

Methods

static Cesium.Credit.clone(credit)Credit

Duplicates a Credit instance.
Name Type Description
credit Credit optional The Credit to duplicate.
Returns:
A new Credit instance that is a duplicate of the one provided. (Returns undefined if the credit is undefined)

static Cesium.Credit.equals(left, right)boolean

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

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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.