ViewportInit

Documentation / @elitechart/core / ViewportInit

Viewport geometry + time/price extents. Pass to Viewport.from.

Example

code

const init: ViewportInit = {
  width: 800, height: 480, dpr: 2,
  timeFrom: asTimestampMs(t0), timeTo: asTimestampMs(t1),
  priceFrom: asPrice(67_000), priceTo: asPrice(68_000),
};

Properties

dpr

code

readonly dpr: number;

Defined in: viewport/viewport.ts:36

height

code

readonly height: number;

Defined in: viewport/viewport.ts:35

plotBottom?

code

readonly optional plotBottom?: number;

Defined in: viewport/viewport.ts:44

plotLeft?

code

readonly optional plotLeft?: number;

Defined in: viewport/viewport.ts:46

X-axis reserved for the chart plot area (full width minus price-axis band).

plotRight?

code

readonly optional plotRight?: number;

Defined in: viewport/viewport.ts:47

plotTop?

code

readonly optional plotTop?: number;

Defined in: viewport/viewport.ts:43

Y-axis reserved for the chart plot area (full height minus time-axis band).

priceFrom

code

readonly priceFrom: Price;

Defined in: viewport/viewport.ts:39

priceKind?

code

readonly optional priceKind?: PriceScaleKind;

Defined in: viewport/viewport.ts:41

priceTo

code

readonly priceTo: Price;

Defined in: viewport/viewport.ts:40

timeFrom

code

readonly timeFrom: TimestampMs;

Defined in: viewport/viewport.ts:37

timeTo

code

readonly timeTo: TimestampMs;

Defined in: viewport/viewport.ts:38

width

code

readonly width: number;

Defined in: viewport/viewport.ts:34