Top
You are looking at an outdated 7.9.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.core.ui.Credits Improve this Doc

Extends: anychart.core.VisualBase

Define class Credits.
Note: Use method anychart.ui#credits to create instance of this class.
Note: You can't customize credits without your licence key. To buy licence key go to Buy page.

Methods Overview

Specific settings
alt()Alternative text for credits.
inChart()Location of the credits.
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.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
zIndex()Z-index of the element.

Methods Description

alt

Getter for credits alt.

Returns:

string - Current credits alternative text.

Try it:

Setter for credits alt.

Params:

Name Type Description
value string Title value.

Returns:

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

Try it:

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

inChart

Gets 'in chart' flag.

Returns:

boolean - The current value.

Try it:

Sets 'in chart' flag.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

logoSrc

Getter for credits logo src value.

Returns:

string - Current credits logo source.

Try it:

Setter for credits logo src value.
Note: You can't customize credits without your licence key. To buy licence key go to Buy page.

Params:

Name Type Description
value string Logo source value.

Returns:

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
landscape boolean
false
Flag of landscape.

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

Getter for credits text value.

Returns:

string - Current credits text.

Try it:

Setter for credits text value.

Params:

Name Type Description
value string Text value.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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

Getter for credits url.

Returns:

string - Current credits url.

Try it:

Setter for credits url.

Params:

Name Type Description
value string Url value.

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: