Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendImageOptions

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

Hierarchy

  • LegendImageOptions

Index

Properties

Optional autosize

autosize: boolean

Whether the image should be sized automatically based on its configuration.

Optional cell

cell: { pad?: number; size?: Size }

Bar legend cell options.

Type declaration

  • Optional pad?: number

    Cell spacing.

  • Optional size?: Size

    Cell size.

Optional columns

columns: number

Number of columns to restrict the legend elements to.

Optional format

format: string

Image output format.

Optional gutter

gutter: { x: number; y: number }

Amount of spacing between elements in x and y directions.

Type declaration

  • x: number
  • y: number

Optional interval

interval: string | number

Data value interval for color stops.

Optional keys

keys: string

Optional label

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

Text label options.

Type declaration

  • Optional color?: string
  • Optional custom?: string
  • Optional fontsize?: number
  • Optional interval?: string | number
  • Optional position?: LegendLabelPosition

Optional metric

metric: boolean

Whether to render data in metric units.

Optional orientation

orientation: LegendOrientation

Layout orientation.

Optional radius

radius: number

Circle radius for point legends.

Optional range

range: number[]

Data value range to include.

Optional size

size: Size

Output size.

Optional type

type: string

Legend type code.

Generated using TypeDoc