You are here

interface TypeInterface in Charts 5.0.x

Same name and namespace in other branches
  1. 8.4 src/Plugin/chart/Type/TypeInterface.php \Drupal\charts\Plugin\chart\Type\TypeInterface

Defines an interface for Chart type plugins.

Hierarchy

Expanded class hierarchy of TypeInterface

All classes that implement TypeInterface

File

src/Plugin/chart/Type/TypeInterface.php, line 8

Namespace

Drupal\charts\Plugin\chart\Type
View source
interface TypeInterface {

  /**
   * Gets the chart type ID.
   *
   * @return string
   *   The chart type ID.
   */
  public function getId();

  /**
   * Gets the chart type label.
   *
   * @return string
   *   The chart type label.
   */
  public function getLabel();

  /**
   * Gets the chart type axis.
   *
   * @return string
   *   The chart type axis.
   */
  public function getAxis();

  /**
   * Gets whether the chart type axis is inverted.
   *
   * @return bool
   *   TRUE if the chart type axis is inverted, FALSE otherwise.
   */
  public function isAxisInverted();

  /**
   * Gets whether the chart type axis supports stacking.
   *
   * @return bool
   *   TRUE if the chart type axis supports stacking, FALSE otherwise.
   */
  public function supportStacking();

}

Members

Namesort descending Modifiers Type Description Overrides
TypeInterface::getAxis public function Gets the chart type axis. 1
TypeInterface::getId public function Gets the chart type ID. 1
TypeInterface::getLabel public function Gets the chart type label. 1
TypeInterface::isAxisInverted public function Gets whether the chart type axis is inverted. 1
TypeInterface::supportStacking public function Gets whether the chart type axis supports stacking. 1