@urban-toolkit/autk-plot

---

@urban-toolkit/autk-plot / PlotConfig

Type Alias: PlotConfig

PlotConfig = object

Defined in: api.ts:39

Base configuration accepted by all plot implementations.

Properties

attributes?

optional attributes?: object

Defined in: api.ts:62

Feature property names to map to visual channels.

axis?

optional axis?: string[]

Property names mapped to axes.

color?

optional color?: string

Property name mapped to the color channel.

---

categoricalColorMapInterpolator?

optional categoricalColorMapInterpolator?: ColorMapInterpolator

Defined in: api.ts:77

Color interpolator used when the color attribute contains categorical (string) values. Defaults to OBSERVABLE10.

---

collection

collection: FeatureCollection<Geometry, GeoJsonProperties>

Defined in: api.ts:43

GeoJSON feature collection used as the plot data source.

---

colorMapInterpolator?

optional colorMapInterpolator?: ColorMapInterpolator

Defined in: api.ts:75

Color interpolator used for continuous (numeric) color encoding.

---

div

div: HTMLElement

Defined in: api.ts:41

Host HTML element where the plot renders.

---

domainSpec?

optional domainSpec?: ColorMapDomainSpec

Defined in: api.ts:73

Domain specification controlling how the colormap range is derived.

---

events?

optional events?: PlotEvent[]

Defined in: api.ts:45

Interaction events the plot should emit (click, brush, etc).

---

height?

optional height?: number

Defined in: api.ts:51

Plot height in pixels. Defaults to 500.

---

labels?

optional labels?: object

Defined in: api.ts:53

Display labels for axes, title, and color legend.

axis?

optional axis?: string[]

Labels for each axis.

color?

optional color?: string

Color legend label.

title?

optional title?: string

Plot title.

---

margins?

optional margins?: PlotMargins

Defined in: api.ts:47

Pixel margins around the plot drawing area.

---

tickFormats?

optional tickFormats?: string[]

Defined in: api.ts:71

D3 format strings for each axis tick.

---

transform?

optional transform?: PlotTransformConfig

Defined in: api.ts:69

Optional data transform applied before rendering.

---

width?

optional width?: number

Defined in: api.ts:49

Plot width in pixels. Defaults to 800.