Interface CommonOptions

interface CommonOptions {
    compressColorsTo8Bit?: boolean;
    decimate?: number;
    enableWorkers?: boolean;
    filters?: readonly DimensionFilter[];
}

Hierarchy (view full)

Properties

compressColorsTo8Bit? decimate? enableWorkers? filters?

Properties

OptionalcompressColorsTo8Bit

compressColorsTo8Bit?: boolean

If true, colors are compressed to 8-bit (instead of 16-bit).

Default Value

true

Optionaldecimate

decimate?: number

If specified, will keep every Nth point. For example, a decimation value of 10 will keep one point out of ten, and discard the 9 other points. Useful to reduce memory usage.

Default Value

1

OptionalenableWorkers

enableWorkers?: boolean

Enable web workers to perform CPU intensive tasks.

Default Value

true

Optionalfilters

filters?: readonly DimensionFilter[]

The filters to use.

Settings

Member Visibility

On This Page

Properties