dhxpyt.slider.slider_config

 1from typing import Any, Callable, Dict, Optional, Union
 2
 3
 4
 5class SliderConfig:
 6    """
 7    Configuration class for the Slider widget.
 8    """
 9
10    def __init__(self,
11                 min: float,
12                 max: float,
13                 step: float = 1,
14                 value: Union[float, str, list] = None,
15                 css: str = None,
16                 helpMessage: str = None,
17                 hiddenLabel: bool = None,
18                 inverse: bool = None,
19                 label: str = None,
20                 labelPosition: str = None,
21                 labelWidth: Union[str, int] = None,
22                 majorTick: float = None,
23                 mode: str = "horizontal",
24                 range: bool = None,
25                 tick: float = None,
26                 tickTemplate: Callable[[float], str] = None,
27                 tooltip: bool = True):
28        """
29        Initializes the SliderConfig.
30
31        :param min: (Required) The minimal value of slider.
32        :param max: (Required) The maximal value of slider.
33        :param step: (Optional) The step the slider thumb will be moved with. Default is 1.
34        :param value: (Optional) The value the thumb will be set at on initialization of the slider.
35        :param css: (Optional) Adds style classes for the component.
36        :param helpMessage: (Optional) Adds an icon with a question mark next to Slider.
37        :param hiddenLabel: (Optional) Adds a hidden label for a Slider that will be used while sending a form to the server.
38        :param inverse: (Optional) Enables/disables the inverse slider mode.
39        :param label: (Optional) Specifies the label of a slider.
40        :param labelPosition: (Optional) Defines the position of a label of a slider ("left" | "top").
41        :param labelWidth: (Optional) Sets the width of a label.
42        :param majorTick: (Optional) Sets interval of rendering numeric values on the slider scale.
43        :param mode: (Optional) The direction of the Slider scale ("vertical" | "horizontal"). Default is "horizontal".
44        :param range: (Optional) Enables/disables the possibility to select a range of values on the slider.
45        :param tick: (Optional) Sets the interval of steps for rendering the slider scale.
46        :param tickTemplate: (Optional) Sets a template for rendering values on the scale.
47        :param tooltip: (Optional) Enables a tooltip on hovering over the slider thumb. Default is True.
48        """
49        self.min = min
50        self.max = max
51        self.step = step
52        self.value = value
53        self.css = css
54        self.helpMessage = helpMessage
55        self.hiddenLabel = hiddenLabel
56        self.inverse = inverse
57        self.label = label
58        self.labelPosition = labelPosition
59        self.labelWidth = labelWidth
60        self.majorTick = majorTick
61        self.mode = mode
62        self.range = range
63        self.tick = tick
64        self.tickTemplate = tickTemplate
65        self.tooltip = tooltip
66
67    def to_dict(self) -> Dict[str, Any]:
68        """
69        Converts the SliderConfig into a dictionary format.
70        """
71        config_dict = {
72            'min': self.min,
73            'max': self.max,
74            'step': self.step,
75            'value': self.value,
76            'css': self.css,
77            'helpMessage': self.helpMessage,
78            'hiddenLabel': self.hiddenLabel,
79            'inverse': self.inverse,
80            'label': self.label,
81            'labelPosition': self.labelPosition,
82            'labelWidth': self.labelWidth,
83            'majorTick': self.majorTick,
84            'mode': self.mode,
85            'range': self.range,
86            'tick': self.tick,
87            'tooltip': self.tooltip,
88        }
89        # Handle the tickTemplate function
90        if self.tickTemplate:
91            # Since tickTemplate is a function, we can't serialize it to JSON
92            # We'll store it separately and handle it in the Slider class
93            config_dict['tickTemplate'] = self.tickTemplate
94
95        # Remove None values
96        config_dict = {k: v for k, v in config_dict.items() if v is not None}
97        return config_dict