html2canvas-pro
Version:
Screenshots with JavaScript. Next generation!
53 lines (52 loc) • 2 kB
TypeScript
import { Matrix } from '../css/property-descriptors/transform';
import { Path } from './path';
export declare const enum EffectType {
TRANSFORM = 0,
CLIP = 1,
OPACITY = 2,
CLIP_PATH = 3
}
export declare const enum EffectTarget {
BACKGROUND_BORDERS = 2,
CONTENT = 4
}
export interface IElementEffect {
readonly type: EffectType;
readonly target: number;
}
export declare class TransformEffect implements IElementEffect {
readonly offsetX: number;
readonly offsetY: number;
readonly matrix: Matrix;
readonly type: EffectType;
readonly target: number;
constructor(offsetX: number, offsetY: number, matrix: Matrix);
}
export declare class ClipEffect implements IElementEffect {
readonly path: Path[];
readonly target: EffectTarget;
readonly type: EffectType;
constructor(path: Path[], target: EffectTarget);
}
export declare class OpacityEffect implements IElementEffect {
readonly opacity: number;
readonly type: EffectType;
readonly target: number;
constructor(opacity: number);
}
/**
* Clips the element and all its descendants to an arbitrary canvas-drawn shape.
* The `applyClip` callback is responsible for calling beginPath, the shape
* operations, and ctx.clip() — giving each shape type full control over how
* the path is constructed (arc, ellipse, lineTo, Path2D, etc.).
*/
export declare class ClipPathEffect implements IElementEffect {
readonly applyClip: (ctx: CanvasRenderingContext2D) => void;
readonly type: EffectType;
readonly target: number;
constructor(applyClip: (ctx: CanvasRenderingContext2D) => void);
}
export declare const isTransformEffect: (effect: IElementEffect) => effect is TransformEffect;
export declare const isClipEffect: (effect: IElementEffect) => effect is ClipEffect;
export declare const isOpacityEffect: (effect: IElementEffect) => effect is OpacityEffect;
export declare const isClipPathEffect: (effect: IElementEffect) => effect is ClipPathEffect;