class anychart.core.ui.ChartCredits Improve this Doc
Extends: anychart.core.Base
Define class Credits.
Note: Use anychart.ui#credits method to create instance of this class.
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Methods Overview
| Specific settings | |
| alt() | Alternative text for credits. |
| imgAlt() | Image alternative text. |
| logoSrc() | Logo source for credits. |
| text() | Text for credits. |
| url() | Url for credits. |
| Events | |
| listen() | Adds an event listener. |
| listenOnce() | Adds a single time event listener. |
| removeAllListeners() | Removes all listeners. |
| unlisten() | Removes the listener. |
| unlistenByKey() | Removes the listener by the key. |
Methods Description
alt
Setter for credits alt.
Detailed description
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Title value. |
Returns:
anychart.core.ui.ChartCredits - Self instance for method chaining.Try it:
imgAlt
Getter for the image alternative text.
Returns:
string - Image alternative text. See listing
var imgAlt = credits.imgAlt();
Setter for the image alternative text.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Alternative text. |
Returns:
anychart.core.ui.ChartCredits - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
}. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
logoSrc
Getter for credits logo source value.
Returns:
string - Current credits logo source.Try it:
Setter for credits logo source value.
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Logo source value. |
Returns:
anychart.core.ui.ChartCredits - Self instance for method chaining.Try it:
removeAllListeners
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
text
Setter for credits text value.
Detailed description
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Text value. |
Returns:
anychart.core.ui.ChartCredits - Self instance for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
url
Setter for credits url.
Detailed description
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Url value. |
Returns:
anychart.core.ui.ChartCredits - Self instance for method chaining.Try it: