@urban-toolkit/autk-plot

---

@urban-toolkit/autk-plot / AutkPlot

Class: AutkPlot

Defined in: plot.ts:41

Unified public entrypoint for autk-plot plot creation and interaction.

AutkPlot wraps plot-specific implementations (scatterplot, barchart, parallel-coordinates, table, linechart, heatmatrix) behind a single constructor and a stable API for selection and event handling.

The wrapper delegates all behavior to the concrete plot instance selected by config.type while exposing a plot-agnostic interface to consumers.

Example

const plot = new AutkPlot(plotDiv, {
  type: 'scatterplot',
  collection,
  attributes: { axis: ['x', 'y'] },
  labels: { axis: ['x', 'y'], title: 'Example' }
});

plot.events.on('click', ({ selection }) => {
  console.log(selection);
});

Constructors

Constructor

new AutkPlot(div, config): AutkPlot

Defined in: plot.ts:56

Creates a plot wrapper for the requested plot type.

Parameters

div

HTMLElement

Host HTML element where the plot should render.

config

UnifiedPlotConfig

Discriminated plot configuration with a type field.

Returns

AutkPlot

Throws

If config.type is not supported.

Example

const plot = new AutkPlot(plotDiv, { type: 'scatterplot', collection, attributes: { axis: ['x', 'y'] } });

Accessors

events

Get Signature

get events(): EventEmitter<PlotEventRecord>

Defined in: plot.ts:93

Gets the plot event dispatcher.

Returns

EventEmitter<PlotEventRecord>

Typed event dispatcher exposed by the concrete plot.

---

instance

Get Signature

get instance(): PlotBaseInteractive

Defined in: plot.ts:77

Gets the underlying concrete plot instance.

This is mainly useful for advanced scenarios that require direct access to implementation-specific behavior.

Returns

PlotBaseInteractive

Internal plot implementation instance.

---

selection

Get Signature

get selection(): number[]

Defined in: plot.ts:85

Gets the active selection as source feature ids.

Returns

number[]

Selected source feature ids.

---

type

Get Signature

get type(): PlotType

Defined in: plot.ts:65

Gets the active plot type handled by this wrapper.

Returns

PlotType

Active plot type discriminator.

Methods

draw()

draw(): void

Defined in: plot.ts:128

Triggers a synchronous redraw of the underlying plot implementation.

Returns

void

Throws

Never throws.

Example

plot.draw();

---

setSelection()

setSelection(selection): void

Defined in: plot.ts:105

Applies a new selection to the plot as source feature ids.

Parameters

selection

number[]

Source feature ids to highlight/select.

Returns

void

Throws

Never throws.

Example

plot.setSelection([0, 3, 7]);

---

updateCollection()

updateCollection(collection): void

Defined in: plot.ts:117

Replaces the plot's data collection and redraws in place.

Parameters

collection

FeatureCollection<Geometry, GeoJsonProperties>

New GeoJSON feature collection to render.

Returns

void

Throws

Never throws.

Example

plot.updateCollection(newCollection);