kotlin-cesium-engine/cesium.engine/CreditDisplay

CreditDisplay

external class CreditDisplay( var container: <Error class: unknown class>, delimiter: String? = definedExternally, viewport: <Error class: unknown class>? = definedExternally)(source)

The credit display is responsible for displaying credits on screen.

// Add a credit with a tooltip, image and link to display onscreen
const credit = new Credit(`<a href="https://cesium.com/" target="_blank"><img src="/images/cesium_logo.png" title="Cesium"/></a>`, true);
viewer.creditDisplay.addStaticCredit(credit);

// Add a credit with a plaintext link to display in the lightbox
const credit = new Credit('<a href="https://cesium.com/" target="_blank">Cesium</a>');
viewer.creditDisplay.addStaticCredit(credit);

Parameters

delimiter

The string to separate text credits Default value - '•'

viewport

The HTML element that will contain the credits popup Default value - document.body

Constructors

CreditDisplay

constructor( container: <Error class: unknown class>, delimiter: String? = definedExternally, viewport: <Error class: unknown class>? = definedExternally)

Types

Companion

object Companion

Properties

container

var container: <Error class: unknown class>

The HTML element where credits will be displayed

Functions

addCreditToNextFrame

fun addCreditToNextFrame(credit: Credit)

Adds a Credit that will show on screen or in the lightbox until the next frame. This is mostly for internal use. Use CreditDisplay.addStaticCredit to add a persistent credit to the screen.

addStaticCredit

fun addStaticCredit(credit: Credit)

Adds a Credit that will show on screen or in the lightbox until removed with CreditDisplay.removeStaticCredit.

beginFrame

fun beginFrame()

Resets the credit display to a beginning of frame state, clearing out current credits.

destroy

fun destroy()

Destroys the resources held by this object. Destroying an object allows for deterministic release of resources, instead of relying on the garbage collector to destroy this object.

endFrame

fun endFrame()

Sets the credit display to the end of frame state, displaying credits from the last frame in the credit container.

isDestroyed

fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false.

removeStaticCredit

fun removeStaticCredit(credit: Credit)

Removes a static credit shown on screen or in the lightbox.

update

fun update()

Updates the credit display before a new frame is rendered.