Interface PBParams

For initialization the constructor needs a mix of config and draw-settings.

interface PBParams {
    autoAdjustOffset: boolean;
    autoDetectRetina: boolean;
    backgroundColor: string;
    blur?: number;
    brightness?: number;
    canvas: string | HTMLCanvasElement | SVGElement;
    canvasHeightFactor: number;
    canvasWidthFactor: number;
    contrast?: number;
    cssScaleX: number;
    cssScaleY: number;
    cssUniformScale: boolean;
    defaultCanvasHeight: number;
    defaultCanvasWidth: number;
    drawOrigin: boolean;
    drawRaster: boolean;
    dropShadow?: number;
    dropShadowColor?: string;
    effectFilterColor?: string;
    enableGL?: boolean;
    enableKeys: boolean;
    enableMouse: boolean;
    enableMouseWheel: boolean;
    enablePan: boolean;
    enableSVGExport: boolean;
    enableTouch: boolean;
    enableZoom: boolean;
    fitToParent: boolean;
    fullSize: boolean;
    grayscale?: number;
    hueRotate?: number;
    invert?: number;
    isBackdropFiltersEnabled?: boolean;
    isBlurEnabled?: boolean;
    isBrightnessEnabled?: boolean;
    isContrastEnabled?: boolean;
    isDropShadowEnabled?: boolean;
    isEffectsColorEnabled?: boolean;
    isGrayscaleEnabled?: boolean;
    isHueRotateEnabled?: boolean;
    isInvertEnabled?: boolean;
    isOpacityEnabled?: boolean;
    isSaturateEnabled?: boolean;
    isSepiaEnabled?: boolean;
    offsetAdjustXPercent: number;
    offsetAdjustYPercent: number;
    offsetX: number;
    offsetY: number;
    opacity?: number;
    postDraw?: ((draw, fill) => void);
    preClear?: (() => void);
    preDraw?: ((draw, fill) => void);
    rasterAdjustFactor: number;
    rasterGrid: boolean;
    rasterScaleX: number;
    rasterScaleY: number;
    redrawOnResize: boolean;
    saturate?: number;
    saveFile?: (() => void);
    scaleX: number;
    scaleY: number;
    sepia?: number;
    setToRetina?: (() => void);
    title?: string;
}

Hierarchy (view full)

Properties

autoAdjustOffset autoDetectRetina backgroundColor blur? brightness? canvas canvasHeightFactor canvasWidthFactor contrast? cssScaleX cssScaleY cssUniformScale defaultCanvasHeight defaultCanvasWidth drawOrigin drawRaster dropShadow? dropShadowColor? effectFilterColor? enableGL? enableKeys enableMouse enableMouseWheel enablePan enableSVGExport enableTouch enableZoom fitToParent fullSize grayscale? hueRotate? invert? isBackdropFiltersEnabled? isBlurEnabled? isBrightnessEnabled? isContrastEnabled? isDropShadowEnabled? isEffectsColorEnabled? isGrayscaleEnabled? isHueRotateEnabled? isInvertEnabled? isOpacityEnabled? isSaturateEnabled? isSepiaEnabled? offsetAdjustXPercent offsetAdjustYPercent offsetX offsetY opacity? postDraw? preClear? preDraw? rasterAdjustFactor rasterGrid rasterScaleX rasterScaleY redrawOnResize saturate? saveFile? scaleX scaleY sepia? setToRetina? title?

Properties

autoAdjustOffset

autoAdjustOffset: boolean

autoDetectRetina

autoDetectRetina: boolean

backgroundColor

backgroundColor: string

Optional blur

blur?: number

Optional brightness

brightness?: number

canvas

canvas: string | HTMLCanvasElement | SVGElement

canvasHeightFactor

canvasHeightFactor: number

canvasWidthFactor

canvasWidthFactor: number

Optional contrast

contrast?: number

cssScaleX

cssScaleX: number

cssScaleY

cssScaleY: number

cssUniformScale

cssUniformScale: boolean

defaultCanvasHeight

defaultCanvasHeight: number

defaultCanvasWidth

defaultCanvasWidth: number

drawOrigin

drawOrigin: boolean

drawRaster

drawRaster: boolean

Optional dropShadow

dropShadow?: number

Optional dropShadowColor

dropShadowColor?: string

Optional effectFilterColor

effectFilterColor?: string

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 grayscale

grayscale?: number

Optional hueRotate

hueRotate?: number

Optional invert

invert?: number

Optional isBackdropFiltersEnabled

isBackdropFiltersEnabled?: boolean

Optional isBlurEnabled

isBlurEnabled?: boolean

Optional isBrightnessEnabled

isBrightnessEnabled?: boolean

Optional isContrastEnabled

isContrastEnabled?: boolean

Optional isDropShadowEnabled

isDropShadowEnabled?: boolean

Optional isEffectsColorEnabled

isEffectsColorEnabled?: boolean

Optional isGrayscaleEnabled

isGrayscaleEnabled?: boolean

Optional isHueRotateEnabled

isHueRotateEnabled?: boolean

Optional isInvertEnabled

isInvertEnabled?: boolean

Optional isOpacityEnabled

isOpacityEnabled?: boolean

Optional isSaturateEnabled

isSaturateEnabled?: boolean

Optional isSepiaEnabled

isSepiaEnabled?: boolean

offsetAdjustXPercent

offsetAdjustXPercent: number

offsetAdjustYPercent

offsetAdjustYPercent: number

offsetX

offsetX: number

offsetY

offsetY: number

Optional opacity

opacity?: 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 saturate

saturate?: number

Optional saveFile

saveFile?: (() => void)

Type declaration

    • (): void

    • Returns void

scaleX

scaleX: number

scaleY

scaleY: number

Optional sepia

sepia?: number

Optional setToRetina

setToRetina?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional title

title?: string

On This Page