You are here

Home » API reference » Charts 8.3 » ChartsOverridesHighcharts.php

class ChartsOverridesHighcharts in Charts 8.3

Defines a concrete class for a Highcharts.

Plugin annotation


@ChartOverride(
  id = "charts_overrides_highcharts",
  name = @Translation("Highcharts Overrides")
)

Hierarchy

Expanded class hierarchy of ChartsOverridesHighcharts

File

starterkits/charts_overrides/src/Plugin/override/ChartsOverridesHighcharts.php, line 15

Namespace

Drupal\charts_overrides\Plugin\override
View source 
class ChartsOverridesHighcharts extends HighchartsOverrides {
  public function chartOverrides(array $originalOptions = []) {
    $options = [];

    //    The following are currently available for overriding; they are the
    //    private variables in
    //    charts_highcharts/src/Settings/Highcharts/HighchartsOptions.php
    //
    //    $options['plotOptions'] = [
    //        'series' => [
    //            'dataLabels' => [
    //                'enabled' => true,
    //                'color' => 'red'
    //            ],
    //        ],
    //    ];
    //
    //
    //  Unfortunately, if you want to override an axis, you have to do it in
    //  a counterintuitive way:
    //
    //  $options['axisY'] = [
    //    [
    //      'title' => [
    //        'text' => 'My Overridden Chart Title',
    //      ],
    //      'labels' => [
    //          'overflow' => 'justify',
    //          'suffix' => '',
    //          'prefix' => '',
    //      ],
    //      'stackLabels' => [
    //        'enabled' => TRUE,
    //      ],
    //      'plotBands' => NULL,
    //      'min' => NULL,
    //      'max' => NULL,
    //    ]
    //  ];
    //
    //  @todo: implement a solution from
    //    https://www.drupal.org/project/charts/issues/3049960
    //
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbstractChartOverride::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AbstractChartOverride::getName public function Get Chart Settings Name. Overrides ChartOverrideInterface::getName
ChartsOverridesHighcharts::chartOverrides public function Builds an array of Chart Settings with key value pairs Overrides HighchartsOverrides::chartOverrides
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 3
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. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.