Options & Enums

Options

Options tune chart appearance and behaviour. Each strategy declares a fixed _options map and validates option values at construction time.

Class	Python type	Notes
`BooleanOption`	`bool`	Default: `False` unless declared otherwise
`FloatOption`	`float \\| int`	Supports optional `min_value` / `max_value` bounds
`IntOption`	`int`	Supports optional `min_value` / `max_value` bounds
`StringOption`	`str`	Default: `None` unless declared otherwise
`SortOrderOption`	`SortOrder`	Default: `SortOrder.NONE`
`LinePlacementOption`	`LinePlacement`	Default: `LinePlacement.OVERLAPPING`
`LineInterpolationOption`	`LineInterpolation`	Default: `LineInterpolation.LINEAR`
`LineSortOrderOption`	`LineSortOrder`	Default: `LineSortOrder.NONE`
`GeoProjectionOption`	`GeoProjection`	Default: `GeoProjection.NATURAL_EARTH`

Enums

`SortOrder`

from orama.enums import SortOrder

SortOrder.NONE        # 0 — no sorting applied
SortOrder.ASCENDING   # 1
SortOrder.DESCENDING  # -1

`LinePlacement`

Controls how multiple line series are positioned relative to each other.

from orama.enums import LinePlacement

LinePlacement.OVERLAPPING       # lines drawn on top of each other (default)
LinePlacement.STACKED           # lines stacked additively
LinePlacement.STACKED_RELATIVE  # lines stacked as relative percentages (100 %)
LinePlacement.RIDGELINE         # lines offset vertically (ridgeline / joy plot)

`LineInterpolation`

Controls the interpolation mode between data points on a line trace.

from orama.enums import LineInterpolation

LineInterpolation.LINEAR   # straight segments between points (default)
LineInterpolation.SPLINE   # smooth curved interpolation
LineInterpolation.STEP_HV  # horizontal then vertical step ("hv")
LineInterpolation.STEP_VH  # vertical then horizontal step ("vh")

`LineSortOrder`

Controls how line series or categories are sorted in the legend.

from orama.enums import LineSortOrder

LineSortOrder.NONE              # no sorting (default)
LineSortOrder.ALPHABETICAL_ASC  # alphabetically ascending
LineSortOrder.ALPHABETICAL_DESC # alphabetically descending
LineSortOrder.FIRST_VALUE_ASC   # ascending by first data-point value
LineSortOrder.FIRST_VALUE_DESC  # descending by first data-point value
LineSortOrder.LAST_VALUE_ASC    # ascending by last data-point value
LineSortOrder.LAST_VALUE_DESC   # descending by last data-point value

`GeoProjection`

Controls the map projection used by ChoroplethMapChartStrategy.

from orama.enums import GeoProjection

GeoProjection.NATURAL_EARTH    # Natural Earth (default for GeoProjectionOption)
GeoProjection.MERCATOR         # Mercator
GeoProjection.ORTHOGRAPHIC     # Orthographic
GeoProjection.EQUIRECTANGULAR  # Equirectangular (default in ChoroplethMapChartStrategy)
GeoProjection.ROBINSON         # Robinson
GeoProjection.KAVRAYSKIY7      # Kavrayskiy VII