Skip to content

Interface: StreamplotOptions

Defined in: charts/fields.ts:439

A vector field sampled on a regular lattice.

Extends

Properties

arrows?

ts
optional arrows?: boolean;

Defined in: charts/fields.ts:445

Draw an arrowhead at the midpoint of each line. Default true.


arrowSize?

ts
optional arrowSize?: number;

Defined in: charts/fields.ts:447

Arrow size in data units. Defaults to a third of a cell.


color?

ts
optional color?: string;

Defined in: charts/fields.ts:440


colormap?

ts
optional colormap?: ColormapSpec;

Defined in: charts/fields.ts:443

Colour each line by its mean speed through this colormap instead of color.


cols

ts
cols: number;

Defined in: charts/fields.ts:323

Inherited from

VectorField.cols


density?

ts
optional density?: number;

Defined in: charts/fields.ts:330

Seeds per axis, as a multiple of the base 25x25 lattice. Default 1.

Inherited from

StreamlineOptions.density


extent

ts
extent: {
  x: Range;
  y: Range;
};

Defined in: charts/fields.ts:325

x

ts
x: Range;

y

ts
y: Range;

Inherited from

VectorField.extent


maxSteps?

ts
optional maxSteps?: number;

Defined in: charts/fields.ts:334

Give up on a line after this many steps in each direction. Default 400.

Inherited from

StreamlineOptions.maxSteps


name?

ts
optional name?: string;

Defined in: charts/fields.ts:448


renderType?

ts
optional renderType?: RenderType;

Defined in: charts/fields.ts:449


rows

ts
rows: number;

Defined in: charts/fields.ts:324

Inherited from

VectorField.rows


step?

ts
optional step?: number;

Defined in: charts/fields.ts:332

Integration step as a fraction of a cell. Default 0.35.

Inherited from

StreamlineOptions.step


u

ts
u: ArrayLike<number>;

Defined in: charts/fields.ts:321

Row-major u / v components, length cols * rows; row 0 at the bottom.

Inherited from

VectorField.u


v

ts
v: ArrayLike<number>;

Defined in: charts/fields.ts:322

Inherited from

VectorField.v


width?

ts
optional width?: number;

Defined in: charts/fields.ts:441


yAxis?

ts
optional yAxis?: string;

Defined in: charts/fields.ts:450

MIT licensed. WebGL2 required.