toad.plotting.MapStyle

class toad.plotting.MapStyle(resolution='110m', coastline_linewidth=0.5, border_linewidth=0.25, grid_labels=False, grid_lines=True, grid_style='--', grid_width=0.5, grid_color='gray', grid_alpha=0.5, borders=True, projection=None, extent=None, map_frame=True, continent_shading=False, continent_shading_color='#E9E9E9', ocean_shading=False, ocean_shading_color='#E9E9E9', plot_contour=True, plot_fill=True, add_labels=True, contour_linewidth=1.5, other_legend_pos=None, cluster_alpha=0.75, other_cluster_alpha=0.5)

Bases: object

Configuration for map styling parameters.

This dataclass contains all the configuration options for styling maps with Plotter, including coastline, grid, and projection settings.

Parameters:

  • resolution (Literal['110m', '50m', '10m'] | str)

  • coastline_linewidth (float)

  • border_linewidth (float)

  • grid_labels (bool)

  • grid_lines (bool)

  • grid_style (str)

  • grid_width (float)

  • grid_color (str)

  • grid_alpha (float)

  • borders (bool)

  • projection (str | Projection | None)

  • extent (Tuple[float, float, float, float] | None)

  • map_frame (bool)

  • continent_shading (bool)

  • continent_shading_color (str)

  • ocean_shading (bool)

  • ocean_shading_color (str)

  • plot_contour (bool)

  • plot_fill (bool)

  • add_labels (bool)

  • contour_linewidth (float)

  • other_legend_pos (Tuple[float, float] | None)

  • cluster_alpha (float)

  • other_cluster_alpha (float)

__init__(resolution='110m', coastline_linewidth=0.5, border_linewidth=0.25, grid_labels=False, grid_lines=True, grid_style='--', grid_width=0.5, grid_color='gray', grid_alpha=0.5, borders=True, projection=None, extent=None, map_frame=True, continent_shading=False, continent_shading_color='#E9E9E9', ocean_shading=False, ocean_shading_color='#E9E9E9', plot_contour=True, plot_fill=True, add_labels=True, contour_linewidth=1.5, other_legend_pos=None, cluster_alpha=0.75, other_cluster_alpha=0.5)
Parameters:

  • resolution (Literal['110m', '50m', '10m'] | str)

  • coastline_linewidth (float)

  • border_linewidth (float)

  • grid_labels (bool)

  • grid_lines (bool)

  • grid_style (str)

  • grid_width (float)

  • grid_color (str)

  • grid_alpha (float)

  • borders (bool)

  • projection (str | Projection | None)

  • extent (Tuple[float, float, float, float] | None)

  • map_frame (bool)

  • continent_shading (bool)

  • continent_shading_color (str)

  • ocean_shading (bool)

  • ocean_shading_color (str)

  • plot_contour (bool)

  • plot_fill (bool)

  • add_labels (bool)

  • contour_linewidth (float)

  • other_legend_pos (Tuple[float, float] | None)

  • cluster_alpha (float)

  • other_cluster_alpha (float)

Return type:

None

Methods

__init__([resolution, coastline_linewidth, ...])

Attributes

add_labels

border_linewidth

borders

cluster_alpha

coastline_linewidth

continent_shading

continent_shading_color

contour_linewidth

extent

grid_alpha

grid_color

grid_labels

grid_lines

grid_style

grid_width

map_frame

ocean_shading

ocean_shading_color

other_cluster_alpha

other_legend_pos

plot_contour

plot_fill

projection

resolution

add_labels: bool = True
border_linewidth: float = 0.25
borders: bool = True
cluster_alpha: float = 0.75
coastline_linewidth: float = 0.5
continent_shading: bool = False
continent_shading_color: str = '#E9E9E9'
contour_linewidth: float = 1.5
extent: Tuple[float, float, float, float] | None = None
grid_alpha: float = 0.5
grid_color: str = 'gray'
grid_labels: bool = False
grid_lines: bool = True
grid_style: str = '--'
grid_width: float = 0.5
map_frame: bool = True
ocean_shading: bool = False
ocean_shading_color: str = '#E9E9E9'
other_cluster_alpha: float = 0.5
other_legend_pos: Tuple[float, float] | None = None
plot_contour: bool = True
plot_fill: bool = True
projection: str | Projection | None = None
resolution: Literal['110m', '50m', '10m'] | str = '110m'