plotynium.options

plotynium.options.ColorOptions dataclass

ColorOptions(scheme=None, legend=False, labels=None)

Color options applied on circles, lines, rectangles or symbols when it is possible.

labels class-attribute instance-attribute

labels = field(default=None)

legend class-attribute instance-attribute

legend = field(default=False)

scheme class-attribute instance-attribute

scheme = field(default=None)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TColorOptions:
    default_values = ColorOptions()
    if values is None:
        return default_values
    return ColorOptions(
        scheme=values.get("scheme", default_values.scheme),
        legend=values.get("legend", default_values.legend),
        labels=values.get("labels", default_values.labels),
    )

plotynium.options.SymbolOptions dataclass

SymbolOptions(legend=False)

Symbol options used for dots mark when symbols are specified.

legend class-attribute instance-attribute

legend = field(default=False)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TSymbolOptions:
    default_values = SymbolOptions()
    if values is None:
        return default_values
    return SymbolOptions(legend=values.get("legend", default_values.legend))

plotynium.options.StyleOptions dataclass

StyleOptions(background='none', color='black', font_size=12, font_family='sans-serif')

Style options of the plot

background class-attribute instance-attribute

background = field(default='none')

color class-attribute instance-attribute

color = field(default='black')

font_family class-attribute instance-attribute

font_family = field(default='sans-serif')

font_size class-attribute instance-attribute

font_size = field(default=12)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TStyleOptions:
    default_values = StyleOptions()
    if values is None:
        return default_values
    return StyleOptions(
        background=values.get("background", default_values.background),
        color=values.get("color", default_values.color),
        font_size=values.get("font_size", default_values.font_size),
        font_family=values.get("font_family", default_values.font_family),
    )

plotynium.options.SortOptions dataclass

SortOptions(by='', descending=False)

Sort options for bar mark

by class-attribute instance-attribute

by = field(default='')

descending class-attribute instance-attribute

descending = field(default=False)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TSortOptions:
    default_values = SortOptions()
    if values is None:
        return default_values
    return SortOptions(
        by=values.get("by", default_values.by),
        descending=values.get("descending", default_values.descending),
    )

plotynium.options.XOptions dataclass

XOptions(nice=False, grid=False, label=None, count=None, specifier=None)

Options for x axis

count class-attribute instance-attribute

count = field(default=None)

grid class-attribute instance-attribute

grid = field(default=False)

label class-attribute instance-attribute

label = field(default=None)

nice class-attribute instance-attribute

nice = field(default=False)

specifier class-attribute instance-attribute

specifier = field(default=None)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TXOptions:
    default_values = XOptions()
    if values is None:
        return default_values
    return XOptions(
        nice=values.get("nice", default_values.nice),
        grid=values.get("grid", default_values.grid),
        label=values.get("label", default_values.label),
        count=values.get("count", default_values.count),
        specifier=values.get("specifier", default_values.specifier),
    )

plotynium.options.YOptions dataclass

YOptions(nice=True, grid=False, label=None, count=None, specifier=None)

Options for y axis

count class-attribute instance-attribute

count = field(default=None)

grid class-attribute instance-attribute

grid = field(default=False)

label class-attribute instance-attribute

label = field(default=None)

nice class-attribute instance-attribute

nice = field(default=True)

specifier class-attribute instance-attribute

specifier = field(default=None)

new staticmethod

new(values=None)

Source code in plotynium/options.py

@staticmethod
def new(values: dict | None = None) -> TYOptions:
    default_values = YOptions()
    if values is None:
        return default_values
    return YOptions(
        nice=values.get("nice", default_values.nice),
        grid=values.get("grid", default_values.grid),
        label=values.get("label", default_values.label),
        count=values.get("count", default_values.count),
        specifier=values.get("specifier", default_values.specifier),
    )