Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendOptions

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

Hierarchy

Index

Properties

Optional account

account: Account

Aeris account used when requesting data for dynamic legends.

Optional autosize

autosize: boolean

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

Optional filter

filter: string

Optional format

format: "svg" | "png"

Output format.

Optional keys

keys: string

Optional metric

metric: boolean

Whether data units should be output in Metric.

Optional range

range: [number]

Data value range to display in the legend.

Optional size

size: Size

Output size.

Optional styles

styles: LegendStyle

Style options.

Optional title

title: string

Legend title.

Optional type

type: string

Legend type code.

Optional units

units: { imperial?: string; metric?: string }

Units configuration.

Type declaration

  • Optional imperial?: string

    Imperial unit string.

  • Optional metric?: string

    Metric unit string.

Optional url

url: string | { imperial: string; metric: string }

Image url to display for the legend.

Optional within

within: any

Generated using TypeDoc