class ChartData in Charts 5.0.x

Provides a chart data render element.

Plugin annotation

@RenderElement("chart_data");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\charts\Element\ChartData

3 #type uses of ChartData

Chart::buildElement in src/Element/Chart.php

Build the element.

ChartsApiExample::display in modules/charts_api_example/src/Controller/ChartsApiExample.php

Display the dashboard of charts.

ChartsPluginStyleChart::render in src/Plugin/views/style/ChartsPluginStyleChart.php

Render the display in this style.

File

src/Element/ChartData.php, line 12

Namespace

Drupal\charts\Element

class ChartData extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#title' => NULL,
      '#labels' => NULL,
      '#data' => [],
      '#color' => NULL,
      '#show_in_legend' => TRUE,
      // Show inline labels next to the data.
      '#show_labels' => FALSE,
      // If building multicharts. The chart type, e.g. pie.
      '#chart_type' => NULL,
      // Line chart only.
      '#line_width' => 1,
      // Line chart only. Size in pixels, e.g. 1, 5.
      '#marker_radius' => 3,
      // If using multiple axes, key for the matching y axis.
      '#target_axis' => NULL,
      // Formatting options.
      // The number of digits after the decimal separator. e.g. 2.
      '#decimal_count' => NULL,
      // A custom date format, e.g. %Y-%m-%d.
      '#date_format' => NULL,
      '#prefix' => NULL,
      '#suffix' => NULL,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChartData::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.