Class: CreditDisplay

CreditDisplay

new CreditDisplay(container, delimiteropt)

The credit display is responsible for displaying credits on screen.
Parameters:
Name Type Attributes Default Description
container HTMLElement The HTML element where credits will be displayed
delimiter String <optional>
 ' • ' The string to separate text credits
Source:
Example
var creditDisplay = new Cesium.CreditDisplay(creditContainer);

Members

container :HTMLElement

The HTML element where credits will be displayed.
Type:
  • HTMLElement
Source:

Methods

addCredit(credit)

Adds a credit to the list of current credits to be displayed in the credit container
Parameters:
Name Type Description
credit Credit The credit to display
Source:

addDefaultCredit(credit)

Adds credits that will persist until they are removed
Parameters:
Name Type Description
credit Credit The credit to added to defaults
Source:

beginFrame(credit)

Resets the credit display to a beginning of frame state, clearing out current credits.
Parameters:
Name Type Description
credit Credit The credit to display
Source:

destroy() → {undefined}

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.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Source:
Throws:
This object was destroyed, i.e., destroy() was called.
Type
DeveloperError
Returns:
Type
undefined

endFrame(credit)

Sets the credit display to the end of frame state, displaying current credits in the credit container
Parameters:
Name Type Description
credit Credit The credit to display
Source:

isDestroyed() → {Boolean}

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

Source:
Returns:
true if this object was destroyed; otherwise, false.
Type
Boolean

removeDefaultCredit(credit)

Removes a default credit
Parameters:
Name Type Description
credit Credit The credit to be removed from defaults
Source: