# Copyright 2016-present CERN – European Organization for Nuclear Research
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Any
from qf_lib.plotting.decorators.chart_decorator import ChartDecorator
from qf_lib.plotting.decorators.simple_legend_item import SimpleLegendItem
[docs]class DataElementDecorator(ChartDecorator, SimpleLegendItem):
"""
Wrapper for main data element used by a certain type of Chart. It stores the data container, plot settings
and a handle for matplotlib's element representing the charted data (curve in LineChart, bars in BarChart etc.).
Parameters
----------
data_container: object
container for the data to be charted (its type depends on the type of the chart)
key: str
Key is the identifier of the data element. It must be unique to each data element across the chart.
use_secondary_axes: bool
Whether this data element should be plotted on the secondary axis.
plot_settings: Any
Additional settings for plotting the data element.
"""
def __init__(self, data_container: object, key: str = None, use_secondary_axes: bool = False, **plot_settings: Any):
ChartDecorator.__init__(self, key)
SimpleLegendItem.__init__(self)
self.data = data_container
self.use_secondary_axes = use_secondary_axes
self.plot_settings = plot_settings
[docs] def decorate(self, chart: "Chart") -> None:
# DataElementDecorator is being plotted in the Chart.apply_data_element_decorators together with all other
# DataElementDecorators.
pass