Interface: FigureExportOptions

Defined in: StylePresets.ts:142

Properties

preset?

optional preset?: 
  | SurfViewStylePresetName
  | SurfViewStylePreset;

Defined in: StylePresets.ts:143

---

width?

optional width?: number;

Defined in: StylePresets.ts:144

---

height?

optional height?: number;

Defined in: StylePresets.ts:145

---

dpi?

optional dpi?: number;

Defined in: StylePresets.ts:146

---

background?

optional background?: FigureBackground;

Defined in: StylePresets.ts:152

Explicit background; overrides transparent and backgroundColor. When omitted, transparent falls back to the preset's figure default and the colour to the live viewer background.

---

transparent?

optional transparent?: boolean;

Defined in: StylePresets.ts:153

---

colorbar?

optional colorbar?: boolean;

Defined in: StylePresets.ts:154

---

colorbarLayer?

optional colorbarLayer?: string;

Defined in: StylePresets.ts:156

Layer whose colormap, range, threshold and caps the colour key shows (default: the active layer).

---

colorbarLabel?

optional colorbarLabel?: string;

Defined in: StylePresets.ts:157

---

colorbarRange?

optional colorbarRange?: [number, number];

Defined in: StylePresets.ts:158

---

colorbarColors?

optional colorbarColors?: string[];

Defined in: StylePresets.ts:159

---

colorbarThreshold?

optional colorbarThreshold?: [number, number] | null;

Defined in: StylePresets.ts:161

Masked interval drawn as a hatched band on the key; null hides the band.

---

colorbarCaps?

optional colorbarCaps?: Partial<FigureColorbarCaps>;

Defined in: StylePresets.ts:162

---

roiLabels?

optional roiLabels?: boolean | FigureExportLabel[];

Defined in: StylePresets.ts:163

---

scaleBar?

optional scaleBar?: boolean;

Defined in: StylePresets.ts:164

---

scaleBarLabel?

optional scaleBarLabel?: string;

Defined in: StylePresets.ts:165

---

scaleBarLength?

optional scaleBarLength?: number;

Defined in: StylePresets.ts:166

---

fontScale?

optional fontScale?: number;

Defined in: StylePresets.ts:167

---

backgroundColor?

optional backgroundColor?: number;

Defined in: StylePresets.ts:168

---

title?

optional title?: string;

Defined in: StylePresets.ts:169

---

subtitle?

optional subtitle?: string;

Defined in: StylePresets.ts:170

---

downloadFilename?

optional downloadFilename?: string;

Defined in: StylePresets.ts:171