Interface Config

The config that's used by PB.

interface Config {
    autoAdjustOffset: boolean;
    autoDetectRetina: boolean;
    backgroundColor: string;
    canvas: string | HTMLCanvasElement | SVGElement;
    canvasHeightFactor: number;
    canvasWidthFactor: number;
    cssScaleX: number;
    cssScaleY: number;
    cssUniformScale: boolean;
    defaultCanvasHeight: number;
    defaultCanvasWidth: number;
    drawOrigin: boolean;
    drawRaster: boolean;
    enableGL?: boolean;
    enableKeys: boolean;
    enableMouse: boolean;
    enableMouseWheel: boolean;
    enablePan: boolean;
    enableSVGExport: boolean;
    enableTouch: boolean;
    enableZoom: boolean;
    fitToParent: boolean;
    fullSize: boolean;
    isBackdropFiltersEnabled?: boolean;
    offsetAdjustXPercent: number;
    offsetAdjustYPercent: number;
    offsetX: number;
    offsetY: number;
    postDraw?: ((draw, fill) => void);
    preClear?: (() => void);
    preDraw?: ((draw, fill) => void);
    rasterAdjustFactor: number;
    rasterGrid: boolean;
    rasterScaleX: number;
    rasterScaleY: number;
    redrawOnResize: boolean;
    saveFile?: (() => void);
    scaleX: number;
    scaleY: number;
    setToRetina?: (() => void);
}

Hierarchy (view full)

  • Record<string, boolean | number | string | Function | HTMLCanvasElement | SVGElement | undefined>
  • Pick<CSSBackdropFilterParams, "isBackdropFiltersEnabled">

Properties

autoAdjustOffset autoDetectRetina backgroundColor canvas canvasHeightFactor canvasWidthFactor cssScaleX cssScaleY cssUniformScale defaultCanvasHeight defaultCanvasWidth drawOrigin drawRaster enableGL? enableKeys enableMouse enableMouseWheel enablePan enableSVGExport enableTouch enableZoom fitToParent fullSize isBackdropFiltersEnabled? offsetAdjustXPercent offsetAdjustYPercent offsetX offsetY postDraw? preClear? preDraw? rasterAdjustFactor rasterGrid rasterScaleX rasterScaleY redrawOnResize saveFile? scaleX scaleY setToRetina?

Properties

autoAdjustOffset

autoAdjustOffset: boolean

autoDetectRetina

autoDetectRetina: boolean

backgroundColor

backgroundColor: string

canvas

canvas: string | HTMLCanvasElement | SVGElement

canvasHeightFactor

canvasHeightFactor: number

canvasWidthFactor

canvasWidthFactor: number

cssScaleX

cssScaleX: number

cssScaleY

cssScaleY: number

cssUniformScale

cssUniformScale: boolean

defaultCanvasHeight

defaultCanvasHeight: number

defaultCanvasWidth

defaultCanvasWidth: number

drawOrigin

drawOrigin: boolean

drawRaster

drawRaster: boolean

Optional enableGL

enableGL?: boolean

enableKeys

enableKeys: boolean

enableMouse

enableMouse: boolean

enableMouseWheel

enableMouseWheel: boolean

enablePan

enablePan: boolean

enableSVGExport

enableSVGExport: boolean

enableTouch

enableTouch: boolean

enableZoom

enableZoom: boolean

fitToParent

fitToParent: boolean

fullSize

fullSize: boolean

Optional isBackdropFiltersEnabled

isBackdropFiltersEnabled?: boolean

offsetAdjustXPercent

offsetAdjustXPercent: number

offsetAdjustYPercent

offsetAdjustYPercent: number

offsetX

offsetX: number

offsetY

offsetY: number

Optional postDraw

postDraw?: ((draw, fill) => void)

Type declaration

    • (draw, fill): void

    • Parameters

      Returns void

Optional preClear

preClear?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional preDraw

preDraw?: ((draw, fill) => void)

Type declaration

    • (draw, fill): void

    • Parameters

      Returns void

rasterAdjustFactor

rasterAdjustFactor: number

rasterGrid

rasterGrid: boolean

rasterScaleX

rasterScaleX: number

rasterScaleY

rasterScaleY: number

redrawOnResize

redrawOnResize: boolean

Optional saveFile

saveFile?: (() => void)

Type declaration

    • (): void

    • Returns void

scaleX

scaleX: number

scaleY

scaleY: number

Optional setToRetina

setToRetina?: (() => void)

Type declaration

    • (): void

    • Returns void

On This Page