main.cesium.Credit.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* A credit contains data pertaining to how to display attributions/credits for certain content on the screen.
* ```
* //Create a credit with a tooltip, image and link
* var credit = new Credit('
');
* ```
* @see Online Documentation
*
* @constructor
* @property [html] An string representing an html code snippet
* @property [showOnScreen] If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover
* Default value - `false`
* @see Online Documentation
*/
@JsName("\$cesium__Credit")
external class Credit(
val html: String,
val showOnScreen: Boolean = definedExternally,
) {
/**
* Gets the credit element
* @see Online Documentation
*/
val element: org.w3c.dom.HTMLElement
companion object {
/**
* Returns true if the credits are equal
* @param [left] The first credit
* @param [right] The second credit
* @return `true` if left and right are equal, `false` otherwise.
* @see Online Documentation
*/
fun equals(
left: Credit,
right: Credit,
): Boolean
/**
* Duplicates a Credit instance.
* @param [credit] The Credit to duplicate.
* @return A new Credit instance that is a duplicate of the one provided. (Returns undefined if the credit is undefined)
* @see Online Documentation
*/
fun clone(credit: Credit? = definedExternally): Credit
}
}