interface ChartInterface in Charts 8.3

Defines an interface for Chart plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\charts\Plugin\chart\ChartInterface

File

src/Plugin/chart/ChartInterface.php, line 10

Namespace

Drupal\charts\Plugin\chart

interface ChartInterface extends PluginInspectionInterface {

  /**
   * Creates a JSON Object formatted for the charting library JavaScript.
   *
   * @param array $options
   *   Options.
   * @param array $categories
   *   Categories.
   * @param array $seriesData
   *   Series data.
   * @param array $attachmentDisplayOptions
   *   Attachment display options.
   * @param array $variables
   *   Variables.
   * @param string $chartId
   *   Chart ID.
   * @param array $customOptions
   *   Overrides.
   */
  public function buildVariables(array $options, array $categories, array $seriesData, array $attachmentDisplayOptions, array &$variables, $chartId, array $customOptions = []);

  /**
   * Return the name of the chart.
   *
   * @return string
   *   Returns the name as a string.
   */
  public function getChartName();

}

Members

Name	Modifiers	Type	Description	Overrides
ChartInterface::buildVariables	public	function	Creates a JSON Object formatted for the charting library JavaScript.	5
ChartInterface::getChartName	public	function	Return the name of the chart.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2