Interface: D3PColorLegendOptions ​

Defined in: core/color.ts:111

Options of the legend of a color scale: the scale, its position (or inside the plot), its length, thickness and ticks, and its title.

Properties ​

bus? ​

ts
bus?: D3PBus;

Defined in: core/color.ts:113

The bus the legend uses (the global bus by default).

inside? ​

ts
inside?: boolean;

Defined in: core/color.ts:122

false (default): outside of the plot, in the margin on that side, which must be large enough (about 70 px on the right). true: over a corner of the plot.

length? ​

ts
length?: number;

Defined in: core/color.ts:124

Length of the gradient bar and its thickness, in pixels.

position? ​

ts
position?: "top" | "right" | "bottom" | "left";

Defined in: core/color.ts:117

Side of the chart it sits on (default right).

scale ​

ts
scale: D3PColorScale;

Defined in: core/color.ts:115

The scale the legend shows.

thickness? ​

ts
thickness?: number;

Defined in: core/color.ts:126

Thickness of the gradient bar, in pixels.

tickCount? ​

ts
tickCount?: number;

Defined in: core/color.ts:128

The number of ticks along the bar.

tickFormat? ​

ts
tickFormat?: (v) => string;

Defined in: core/color.ts:130

Writes the values of the ticks.

Parameters ​

v ​

number

Returns ​

string

title? ​

ts
title?: string;

Defined in: core/color.ts:132

The title above the bar.