Skip to content

Settings

Starplot has a few global settings for things that affect all the plots you create:

You can set these values in two ways: through code or through environment variables:

Code
from starplot import settings

settings.language = "it"

# Plots will now use the Italian translation
Environment Variables
# Add the STARPLOT_ prefix to the setting 
# name (and uppercase the entire name):

STARPLOT_DATA_PATH=/home/myuser/data
STARPLOT_LANGUAGE=fr

data_path

  • Type: str | Path
  • Default = current working directory

Path that Starplot will use for data and the DuckDB spatial extension, which is required for the data backend.

debug

  • Type: bool
  • Default = False

Global setting for debug mode. When this is enabled, Starplot will log debugging information and plot polygons for debugging text issues

language

  • Type: str
  • Default = 'en-us'

Default language for plotted labels, as an ISO-639 code. Case insensitive.

Supported values:

  • en-us = English (default)
  • de = German
  • es = Spanish
  • fa = Persian (Farsi). Make sure you have a Persian font installed that supports RTL (such as Vazir or Noto Sans Arabic) and set it as the font in your plot's style.
  • fr = French
  • it = Italian
  • lt = Lithuanian
  • nl = Dutch
  • zh-cn = Chinese. Make sure you have a good Chinese font installed (such as Noto Sans SC) and you'll also need to set that as the font in your plot's style.
  • zh-tw = Traditional Chinese

🌐 Want to see another language available? Please help us add it! Details here.

precision

  • Type: int
  • Default = 4

Number of decimal places to round coordinates and dimensions to when rendering SVG output.

svg_text_type

  • Type: str
  • Default = 'element'
  • Method for rendering text in SVG exports:
    • "path" (default) will render all text as paths. This will increase the filesize, but allow all viewers to see the font correctly (even if they don't have the font installed on their system).
    • "element" will render all text as an SVG <text> element, which means the text will be editable in graphic design applications but the text may render in a system default font if the original font isn't available.