AnyChart
API Reference
Still have questions?
Contact support
Top

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.
Interactivity
enabled()Credits state (enabled or disabled).

Methods Description

alt

Getter for credits alt.

Returns:

string - Credits alternative text.
Setter for credits alt.

Params:

NameTypeDescription
textstringAlternative text to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.

enabled

Getter for the credits state.

Returns:

boolean | null - Credits state.
See listing
var credits = chart.credits();
var state = credits.enabled();
Setter for the credits state.

Params:

NameTypeDescription
enabledbooleanEnabled state to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.

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:

NameTypeDescription
textstringAlternative text to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

logoSrc

Getter for credits logo source value.

Returns:

string - Credits logo source.
Setter for credits logo source value.
Note: You can't customize credits without a license key. See AnyChart Licensing to learn more.

Params:

NameTypeDescription
logoSrcstringLogo source to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

text

Getter for credits text value.

Returns:

string - Credits text.
Setter for credits text value.

Params:

NameTypeDescription
textstringText to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

url

Getter for the credits URL.

Returns:

string - Credits URL.
Setter for the credits URL.

Params:

NameTypeDescription
urlstringURL to set.

Returns:

anychart.core.ui.ChartCredits - Self instance for method chaining.