Module: plot_style

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# 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 abc import ABC
from dataclasses import dataclass
from cl.runtime.plots.plot_style_key import PlotStyleKey
from cl.runtime.records.record_mixin import RecordMixin


@dataclass(slots=True, kw_only=True)
class PlotStyle(PlotStyleKey, RecordMixin[PlotStyleKey], ABC):
    """Plot color and layout options."""

    dark_theme: bool = False
    """If True, the image is rendered with dark theme (False by default)."""

    def get_key(self) -> PlotStyleKey:
        return PlotStyleKey(plot_style_id=self.plot_style_id)

Classes

class PlotStyle (*, plot_style_id: str = None, dark_theme: bool = False)

Plot color and layout options.

Expand source code

@dataclass(slots=True, kw_only=True)
class PlotStyle(PlotStyleKey, RecordMixin[PlotStyleKey], ABC):
    """Plot color and layout options."""

    dark_theme: bool = False
    """If True, the image is rendered with dark theme (False by default)."""

    def get_key(self) -> PlotStyleKey:
        return PlotStyleKey(plot_style_id=self.plot_style_id)

Ancestors

PlotStyleKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Subclasses

Static methods

def get_key_type() -> Type: Inherited from: PlotStyleKey.get_key_type

Return key type even when called from a record.

Fields

var dark_theme -> bool: If True, the image is rendered with dark theme (False by default).
var plot_style_id -> str: Inherited from: PlotStyleKey.plot_style_id

Unique plot style identifier.

Methods

def get_key(self) -> PlotStyleKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.