Interface: GeovisWorkspaceSidebarColorRampSetting

Defined in: context/GeovisWorkspaceContext.ts:593

A color-ramp setting: a list of ramps, one chosen at a time.

A ramp is a choice among named alternatives, which is why this is its own control rather than a slider over a palette index: the options are unordered — there is no "more" direction to drag towards — and each has to show the colors it stands for before it is picked.

Properties

create?

optional create?: GeovisWorkspaceSidebarColorRampCreate

Defined in: context/GeovisWorkspaceContext.ts:602

Lets the reader build a ramp. Omitted, the list is exactly options.

---

defaultValue?

optional defaultValue?: string

Defined in: context/GeovisWorkspaceContext.ts:600

Ramp chosen on first render. Defaults to the first option.

---

kind

kind: "colorRamp"

Defined in: context/GeovisWorkspaceContext.ts:594

---

menuId

menuId: string

Defined in: context/GeovisWorkspaceContext.ts:596

Menu id the chosen ramp's id is reported under.

---

onRemove?

optional onRemove?: (params) => void

Defined in: context/GeovisWorkspaceContext.ts:604

A removable row was dismissed. The app drops that id from options.

Parameters

Parameter	Type
params	{ id: string; }
params.id	string

Returns

void

---

options

options: GeovisWorkspaceSidebarColorRampOption[]

Defined in: context/GeovisWorkspaceContext.ts:598

The selectable ramps, in the order they are rendered.