new Credit(html, showOnScreen)
The copyright statement contains data related to the ownership/copyright statement of how certain content is displayed on the screen.
| Name | Type | Default | Description |
|---|---|---|---|
html |
String |
optional
A string representing an HTML code snippet. |
|
showOnScreen |
Boolean | false |
optional
If true, the copyright statement will be visible in the main copyright statement, otherwise it will appear in a pop-up window. |
Throws:
-
Need to use HTML.
- Type
- DeveloperError
Example
//Create a credit with a tooltip, image and link
Members
-
readonly elementHTMLElement
-
Obtain copyright declaration elements
-
readonly htmlString
-
Copyright statement content.
-
readonly showOnScreenBoolean
-
Should the copyright statement be displayed on the screen or in a pop-up window.
Methods
-
static clone(credit){Credit}
-
Copy the copyright statement instance.
Name Type Description creditCredit optional The copyright statement to be copied.
Returns:
Type Description Credit The new copyright declaration instance is a duplicate of the provided instance. (If the copyright statement is undefined, return undefined). -
static equals(left, right){Boolean}
-
If the copyright declaration is equal, return true
Name Type Description leftCredit The first copyright statement on the left.
rightCredit The second copyright statement on the right.
Returns:
Type Description Boolean If left and right are equal, return true; otherwise, return false. -
equals(Credit){Boolean}
-
If the copyright declaration is equal, return true.
Name Type Description CreditCredit Comparison between copyright statements.
Returns:
Type Description Boolean If left and right are equal, return true; otherwise, return false.