Class: D3PBand ​

Defined in: core/layout.ts:14

A strip along one side of the chart, taken from the room of the plot. Titles, legends and any component of your own that has to sit around the plot reserve one, and draw in its rect().

Accessors ​

size ​

Get Signature ​

ts
get size(): number;

Defined in: core/layout.ts:27

The width of the strip (the height for the top and the bottom), in pixels.

Returns ​

number

Set Signature ​

ts
set size(value): void;

Defined in: core/layout.ts:31

Change the width (or height) of the strip: the plot gives or takes the difference.

Parameters ​
value ​

number

Returns ​

void

Constructors ​

Constructor ​

ts
new D3PBand(
   layout, 
   side, 
   _size, 
   span, 
   order
): D3PBand;

Defined in: core/layout.ts:15

Parameters ​

layout ​

D3PLayout

side ​

D3PSide

The side the strip is on.

_size ​

number

span ​

D3PBandSpan

Along the chart (chart) or along the plot (plot).

order ​

number

Stacking rank: the lower, the further from the plot.

Returns ​

D3PBand

Methods ​

rect() ​

ts
rect(): object;

Defined in: core/layout.ts:43

Where the strip is, in the coordinates of the svg (the whole chart, margins included).

Returns ​

object

height ​
ts
height: number;
width ​
ts
width: number;
x ​
ts
x: number;
y ​
ts
y: number;

release() ​

ts
release(): void;

Defined in: core/layout.ts:38

Give the strip back to the plot.

Returns ​

void

Properties ​

order ​

ts
readonly order: number;

Defined in: core/layout.ts:23

Stacking rank: the lower, the further from the plot.

side ​

ts
readonly side: D3PSide;

Defined in: core/layout.ts:18

The side the strip is on.

span ​

ts
readonly span: D3PBandSpan;

Defined in: core/layout.ts:21

Along the chart (chart) or along the plot (plot).