Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendStyle

A data type that represents the configuration options for a legend style.

Hierarchy

  • LegendStyle

Index

Properties

Properties

Optional cell

cell: { size?: { height: number; width: number } }

Bar legend cell styles.

Type declaration

  • Optional size?: { height: number; width: number }

    Size for color cells in a bar legend.

    • height: number
    • width: number

Optional columns

columns: number

Optional gutter

gutter: { x: number; y: number }

Amount of horizontal and vertical padding between elements.

Type declaration

  • x: number
  • y: number

Optional interval

interval: number | string

Data value interval for which to draw cells between color stops.

Optional label

label: { color?: string; fontsize?: number; interval?: number | string; position?: LegendLabelPosition }

Text label styles.

Type declaration

  • Optional color?: string

    Text color for labels.

  • Optional fontsize?: number

    Font size for text labels.

  • Optional interval?: number | string

    Data value interval for which to display value text labels.

  • Optional position?: LegendLabelPosition

    Position of value labels relative to the color bar (bar legends only).

Optional metric

metric: boolean

Whether to display value labels in Metric units.

Optional orientation

orientation: LegendOrientation

Layout orientation (bar legends only).

Optional radius

radius: number

Circle radius for point-related legends.

Generated using TypeDoc