Package com.vaadin.componentfactory.maps.model

Class Credits

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Credits
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") 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.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Credits

      public Credits()

      Constructor for Credits.

    • Credits

      public Credits(Boolean enabled)

      Constructor for Credits.

      Parameters:
      enabled - a Boolean object.

    • Credits

      public Credits(String text)

      Constructor for Credits.

      Parameters:
      text - a String object.

  • Method Details

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)
      Whether to show the credits text.

      Defaults to: true

      Parameters:
      enabled - a Boolean object.

    • getHref

      public String getHref()

      Getter for the field href.

      Returns:
      a String object.
      See Also:

    • setHref

      public void setHref(String href)
      The URL for the credits label.

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

      Parameters:
      href - a String object.

    • getMapText

      public String getMapText()

      Getter for the field mapText.

      Returns:
      a String object.
      See Also:

    • setMapText

      public void setMapText(String mapText)
      Credits for map source to be concatenated with conventional credit text. By default this is a format string that collects copyright information from the map if available.

      Parameters:
      mapText - a String object.

    • getMapTextFull

      public String getMapTextFull()

      Getter for the field mapTextFull.

      Returns:
      a String object.
      See Also:

    • setMapTextFull

      public void setMapTextFull(String mapTextFull)
      Detailed credits for map source to be displayed on hover of credits text. By default this is a format string that collects copyright information from the map if available.

      Defaults to: {geojson.copyright}

      Parameters:
      mapTextFull - a String object.

    • getPosition

      public Position getPosition()

      Getter for the field position.

      Returns:
      a Position object.
      See Also:

    • setPosition

      public void setPosition(Position position)
      Position configuration for the credits label. Supported properties are align, verticalAlign, x and y. Defaults to 
       position: {
                align: 'right',
                x: -10,
                verticalAlign: 'bottom',
                y: -5
        }
      Parameters:
      position - a Position object.

    • getStyle

      public Style getStyle()

      Getter for the field style.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public void setStyle(Style style)
      CSS styles for the credits label. Defaults to: 
       style: {
                cursor: 'pointer',
                color: '#909090',
                fontSize: '10px'

        }
      Parameters:
      style - a Style object.

    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:

    • setText

      public void setText(String text)
      The text for the credits label. If a map is loaded as GeoJSON, the text defaults to "Highcharts @ {map-credits}". Otherwise, it defaults to "Highcharts.com".
      Parameters:
      text - a String object.