Skip to content

interface export

ImageProperties

Published interface export ImageProperties.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/image.ts (opens in a new tab)

Signature

TypeScript
export interface ImageProperties {
    source: string | Buffer | ShapeType;
    x: number;
    y: number;
    width?: number;
    height?: number;
    inherit?: boolean;
    fit?: FitMode;
    align?: AlignMode;
    rotation?: number;
    opacity?: number;
    blur?: number;
    blendMode?: GlobalCompositeOperation;
    borderRadius?: number | "circular";
    borderPosition?: string;
    filters?: ImageFilter[];
    filterIntensity?: number;
    filterOrder?: "pre" | "post";
    mask?: {
        source: string | Buffer;
        mode?: "alpha" | "luminance" | "inverse";
    };
    clipPath?: Array<{
        x: number;
        y: number;
    }>;
    distortion?: ImageDistortionOptions;
    meshWarp?: ImageMeshWarpOptions;
    effects?: {
        vignette?: {
            intensity: number;
            size: number;
        };
        lensFlare?: {
            x: number;
            y: number;
            intensity: number;
        };
        chromaticAberration?: {
            intensity: number;
        };
        filmGrain?: {
            intensity: number;
        };
    };
    shape?: ShapeProperties;
    shadow?: ShadowOptions;
    stroke?: StrokeOptions;
    boxBackground?: BoxBackground;
}

Related APIs

No explicit related API metadata.

Next steps