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. All credits are displayed `inline`, if you have an image we recommend sizing it correctly to match the text or use css to `vertical-align` it. |
Throws:
-
DeveloperError : html is required.
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" style="vertical-align: -7px" title="Cesium"/></a>');
Members
Gets the credit element
The credit content
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)
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.
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.