Package com.vaadin.flow.component.charts.model

Class Credits

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Credits

All Implemented Interfaces:

Serializable

public class Credits
extends AbstractConfigurationObject

Highchart by default puts a credits label in the lower right corner of the chart. This can be changed using these options.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Credits()
Credits(Boolean enabled)
Credits(String text)

Method Summary

Modifier and Type	Method	Description
Boolean	getEnabled()
String	getHref()
Position	getPosition()
Style	getStyle()
String	getText()
void	setEnabled(Boolean enabled)	Whether to show the credits text.
void	setHref(String href)	The URL for the credits label.
void	setPosition(Position position)	Position configuration for the credits label.
void	setStyle(Style style)	CSS styles for the credits label.
void	setText(String text)	The text for the credits label.
void	setUnsafeHref(String href)	Sets the URL for the credits label without validating its scheme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Credits

public Credits()

Credits

public Credits(Boolean enabled)

Credits

public Credits(String text)

Method Detail

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Whether to show the credits text.

Defaults to: true

getHref

public String getHref()

See Also:

setHref(String)

setHref

public void setHref(String href)

The URL for the credits label.

Defaults to: http://www.highcharts.com

Throws:

IllegalArgumentException - if href uses a scheme that is not considered safe according to DeploymentConfiguration.getUrlSafeSchemes(); see setUnsafeHref(String) and the "safeUrlSchemes" configuration property

See Also:

setUnsafeHref(String)

setUnsafeHref

public void setUnsafeHref(String href)

Sets the URL for the credits label without validating its scheme.

Unlike setHref(String), this method does not reject URLs based on the "safeUrlSchemes" configuration. Use it only for URLs that are fully under your control and known to be safe. Passing untrusted input here can expose the application to cross-site scripting (XSS) attacks.

Parameters:

href - the URL for the credits label

See Also:

setHref(String)

getPosition

public Position getPosition()

See Also:

setPosition(Position)

setPosition

public void setPosition(Position position)

Position configuration for the credits label.

getStyle

public Style getStyle()

See Also:

setStyle(Style)

setStyle

public void setStyle(Style style)

CSS styles for the credits label.

Defaults to: { "cursor": "pointer", "color": "#999999", "fontSize": "10px" }

getText

public String getText()

See Also:

setText(String)

setText

public void setText(String text)

The text for the credits label.

Defaults to: Highcharts.com