You are here

Home » API reference » Charts 5.0.x » ChartBase.php

abstract class ChartBase in Charts 5.0.x

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

Base class Chart plugins.

Hierarchy

Expanded class hierarchy of ChartBase

6 files declare their use of ChartBase
Billboard.php in modules/charts_billboard/src/Plugin/chart/Library/Billboard.php
C3.php in modules/charts_c3/src/Plugin/chart/Library/C3.php
Chart.php in src/Element/Chart.php
Chartjs.php in modules/charts_chartjs/src/Plugin/chart/Library/Chartjs.php
Google.php in modules/charts_google/src/Plugin/chart/Library/Google.php

... See full list

File

src/Plugin/chart/Library/ChartBase.php, line 14

Namespace

Drupal\charts\Plugin\chart\Library
View source 
abstract class ChartBase extends PluginBase implements ChartInterface {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function getChartName() {
    return $this->pluginDefinition['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * Gets defaults settings.
   *
   * @return array
   *   The defaults settings.
   */
  public static function getDefaultSettings() {
    $defaults = [
      'type' => 'line',
      'library' => NULL,
      'grouping' => FALSE,
      'fields' => [
        'label' => NULL,
        'data_providers' => NULL,
      ],
      'display' => [
        'title' => '',
        'title_position' => 'out',
        'data_labels' => FALSE,
        'data_markers' => TRUE,
        'legend' => TRUE,
        'legend_position' => 'right',
        'background' => '',
        'three_dimensional' => FALSE,
        'polar' => FALSE,
        'tooltips' => TRUE,
        'tooltips_use_html' => FALSE,
        'dimensions' => [
          'width' => NULL,
          'width_units' => '%',
          'height' => NULL,
          'height_units' => 'px',
        ],
        'gauge' => [
          'green_to' => 100,
          'green_from' => 85,
          'yellow_to' => 85,
          'yellow_from' => 50,
          'red_to' => 50,
          'red_from' => 0,
          'max' => 100,
          'min' => 0,
        ],
        'colors' => self::getDefaultColors(),
      ],
    ];
    return $defaults;
  }

  /**
   * Gets the default hex colors.
   *
   * @return array
   *   The hex colors.
   */
  public static function getDefaultColors() {
    return [
      '#2f7ed8',
      '#0d233a',
      '#8bbc21',
      '#910000',
      '#1aadce',
      '#492970',
      '#f28f43',
      '#77a1e5',
      '#c42525',
      '#a6c96a',
    ];
  }

  /**
   * Gets options properties.
   *
   * @param array $element
   *   The element.
   *
   * @return array
   *   The options.
   */
  protected function getOptionsFromElementProperties(array $element) {
    $options = [];
    $properties_mapping = ChartsDefaultSettings::getLegacySettingsMappingKeys();

    // Remove properties which don't have a mapping.
    $filtered_element = array_filter($element, function ($property) use ($properties_mapping) {
      $property = ltrim($property, '#');
      return isset($properties_mapping[$property]);
    });
    foreach ($filtered_element as $property => $value) {
      $property = ltrim($property, '#');
      $property_map = $properties_mapping[$property];
      if (substr($property_map, 0, 7) === 'display') {

        // Stripping the 'display_' in front of the mapping key.
        $property_map = substr($property_map, 8, strlen($property_map));
        if (substr($property_map, 0, 10) === 'dimensions') {

          // Stripping dimensions_.
          $property_map = substr($property_map, 11, strlen($property_map));
          $options['display']['dimensions'][$property_map] = $value;
        }
        elseif (substr($property_map, 0, 5) === 'gauge') {

          // Stripping gauge_.
          $property_map = substr($property_map, 6, strlen($property_map));
          $options['display']['gauge'][$property_map] = $value;
        }
        else {
          $options['display'][$property_map] = $value;
        }
      }
      elseif (substr($property_map, 0, 5) === 'xaxis') {

        // Stripping xaxis_.
        $property_map = substr($property_map, 6, strlen($property_map));
        $options['xaxis'][$property_map] = $value;
      }
      elseif (substr($property_map, 0, 5) === 'yaxis') {

        // Stripping yaxis_.
        $property_map = substr($property_map, 6, strlen($property_map));
        if (substr($property_map, 0, 9) === 'secondary') {

          // Stripping gauge_.
          $property_map = substr($property_map, 10, strlen($property_map));
          $options['yaxis']['secondary'][$property_map] = $value;
        }
        else {
          $options['yaxis'][$property_map] = $value;
        }
      }
      elseif (substr($property_map, 0, 6) === 'fields') {

        // Stripping fields_.
        $property_map = substr($property_map, 7, strlen($property_map));
        if ($property_map === 'data_providers' && is_array($value)) {
          $data_providers = !empty($options['fields']['data_providers']) ? $options['fields']['data_providers'] : [];
          if ($property === 'data_fields' || $property == 'field_colors') {
            $options['fields']['data_providers'] = ChartsDefaultSettings::getFieldsDataProviders($data_providers, $value);
          }
        }
        else {
          $options['fields'][$property_map] = $value;
        }
      }
      else {

        // We make sure that we handle the color unneeded array.
        $options[$property_map] = $property_map !== 'color' ? $value : $value[0];
      }
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ChartBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 5
ChartBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 1
ChartBase::getChartName public function Return the name of the chart. Overrides ChartInterface::getChartName
ChartBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ChartBase::getDefaultColors public static function Gets the default hex colors.
ChartBase::getDefaultSettings public static function Gets defaults settings.
ChartBase::getOptionsFromElementProperties protected function Gets options properties.
ChartBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ChartBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 2
ChartBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ChartInterface::DUAL_AXIS constant Used to define a dual axis.
ChartInterface::preRender public function Pre render. 5
ChartInterface::SINGLE_AXIS constant Used to define a single axis.
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
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.