pygmt/pygmt/params/box.py at a3f3b56435853a8eb5b944bbcab9e5b3521f450e · GenericMappingTools/pygmt · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
"""
Class for the box around GMT embellishments.
"""

from collections.abc import Sequence
from dataclasses import dataclass
from typing import ClassVar

from pygmt.params.base import Alias, BaseParams


@dataclass(repr=False)
class Box(BaseParams):
    """
    Class for the box around GMT embellishments.

    Attributes
    ----------
    clearance
        Set clearances between the embellishment and the box border. Can be either a
        scalar value or a list of two/four values.

        - a scalar value means a uniform clearance in all four directions.
        - a list of two values means separate clearances in x- and y- directions.
        - a list of four values means separate clearances for left/right/bottom/top.
    fill
        Fill for the box. None means no fill.

    """

    clearance: float | str | Sequence[float | str] | None = None
    fill: str | None = None
    innerborder: str | Sequence | None = None
    pen: str | None = None
    radius: float | bool | None = False
    shading: str | Sequence | None = None

    __aliases__: ClassVar = [
        Alias("clearance", "+c", "/"),
        Alias("fill", "+g"),
        Alias("innerborder", "+i", "/"),
        Alias("pen", "+p"),
        Alias("radius", "+r"),
        Alias("shading", "+s", "/"),
    ]