Type Alias CommonOptions

CommonOptions: {
    compressColorsTo8Bit?: boolean;
    decimate?: number;
    enableWorkers?: boolean;
    filters?: Readonly<DimensionFilter[]>;
    workerConcurrency?: number;
}

Type declaration

  • OptionalcompressColorsTo8Bit?: boolean

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

    Default Value

    true
  • Optionaldecimate?: 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?: boolean

    Enable web workers to perform CPU intensive tasks.

    Default Value

    true
  • Optionalfilters?: Readonly<DimensionFilter[]>

    The filters to use.

  • OptionalworkerConcurrency?: number

    The maximum number of workers created by the worker pool. If undefined, the maximum number of workers will be allowed.

    Default Value

    undefined

Settings

Member Visibility