nodes/generated

Interface EditImageNodeParameters

Source
interface EditImageNodeParameters {
    backgroundColor?: string;
    blur?: number;
    borderColor?: string;
    borderHeight?: number;
    borderWidth?: number;
    color?: string;
    cornerRadius?: number;
    dataPropertyName?: string;
    dataPropertyNameComposite?: string;
    degreesX?: number;
    degreesY?: number;
    endPositionX?: number;
    endPositionY?: number;
    fontColor?: string;
    fontSize?: number;
    height?: number;
    lineLength?: number;
    operation?:
        | "create"
        | "text"
        | "blur"
        | "border"
        | "composite"
        | "crop"
        | "draw"
        | "information"
        | "multiStep"
        | "resize"
        | "rotate"
        | "shear"
        | "transparent";
    operations?: {
        operations: {
            backgroundColor?: string;
            blur?: number;
            borderColor?: string;
            borderHeight?: number;
            borderWidth?: number;
            color?: string;
            cornerRadius?: number;
            dataPropertyNameComposite?: string;
            degreesX?: number;
            degreesY?: number;
            endPositionX?: number;
            endPositionY?: number;
            font?: string;
            fontColor?: string;
            fontSize?: number;
            height?: number;
            lineLength?: number;
            operation?: | "create"
            | "text"
            | "blur"
            | "border"
            | "composite"
            | "crop"
            | "draw"
            | "resize"
            | "rotate"
            | "shear"
            | "transparent";
            operator?: | "Add"
            | "Atop"
            | "Bumpmap"
            | "Copy"
            | "CopyBlack"
            | "CopyBlue"
            | "CopyCyan"
            | "CopyGreen"
            | "CopyMagenta"
            | "CopyOpacity"
            | "CopyRed"
            | "CopyYellow"
            | "Difference"
            | "Divide"
            | "In"
            | "Minus"
            | "Multiply"
            | "Out"
            | "Over"
            | "Plus"
            | "Subtract"
            | "Xor";
            positionX?: number;
            positionY?: number;
            primitive?: "circle"
            | "line"
            | "rectangle";
            resizeOption?:
                | "ignoreAspectRatio"
                | "maximumArea"
                | "minimumArea"
                | "onlyIfLarger"
                | "onlyIfSmaller"
                | "percent";
            rotate?: number;
            sigma?: number;
            startPositionX?: number;
            startPositionY?: number;
            text?: string;
            width?: number;
        }[];
    };
    operator?: | "Add"
    | "Atop"
    | "Bumpmap"
    | "Copy"
    | "CopyBlack"
    | "CopyBlue"
    | "CopyCyan"
    | "CopyGreen"
    | "CopyMagenta"
    | "CopyOpacity"
    | "CopyRed"
    | "CopyYellow"
    | "Difference"
    | "Divide"
    | "In"
    | "Minus"
    | "Multiply"
    | "Out"
    | "Over"
    | "Plus"
    | "Subtract"
    | "Xor";
    options?: {
        destinationKey?: string;
        fileName?: string;
        font?: string;
        format?: | "png"
        | "bmp"
        | "gif"
        | "jpeg"
        | "tiff"
        | "webp";
        quality?: number;
    };
    positionX?: number;
    positionY?: number;
    primitive?: "circle"
    | "line"
    | "rectangle";
    resizeOption?:
        | "ignoreAspectRatio"
        | "maximumArea"
        | "minimumArea"
        | "onlyIfLarger"
        | "onlyIfSmaller"
        | "percent";
    rotate?: number;
    sigma?: number;
    startPositionX?: number;
    startPositionY?: number;
    text?: string;
    width?: number;
}

Properties§

§readonly backgroundColor?: string

The background color of the image to create Default: "#ffffff00" Type options: {"showAlpha":true}

§readonly blur?: number

How strong the blur should be Default: 5 Type options: {"minValue":0,"maxValue":1000}

§readonly borderColor?: string

Color of the border Default: "#000000"

§readonly borderHeight?: number

The height of the border Default: 10

§readonly borderWidth?: number

The width of the border Default: 10

§readonly color?: string

The color of the primitive to draw Default: "#ff000000" Type options: {"showAlpha":true}

§readonly cornerRadius?: number

The radius of the corner to create round corners

§readonly dataPropertyName?: string

Name of the binary property in which the image data can be found Default: "data"

§readonly dataPropertyNameComposite?: string

The name of the binary property which contains the data of the image to composite on top of image which is found in Property Name

§readonly degreesX?: number

X (horizontal) shear degrees

§readonly degreesY?: number

Y (vertical) shear degrees

§readonly endPositionX?: number

X (horizontal) end position of the primitive Default: 250

§readonly endPositionY?: number

Y (horizontal) end position of the primitive Default: 250

§readonly fontColor?: string

Color of the text Default: "#000000"

§readonly fontSize?: number

Size of the text Default: 18

§readonly height?: number

The height of the image to create Default: 50 Type options: {"minValue":1}

§readonly lineLength?: number

Max amount of characters in a line before a line-break should get added Default: 80 Type options: {"minValue":1}

§readonly operation?:
    | "create"
    | "text"
    | "blur"
    | "border"
    | "composite"
    | "crop"
    | "draw"
    | "information"
    | "multiStep"
    | "resize"
    | "rotate"
    | "shear"
    | "transparent"

Default: "border"

§readonly operations?: { ... }

The operations to perform Default: {} Type options: {"multipleValues":true,"sortable":true}

§readonly operator?:
    | "Add"
    | "Atop"
    | "Bumpmap"
    | "Copy"
    | "CopyBlack"
    | "CopyBlue"
    | "CopyCyan"
    | "CopyGreen"
    | "CopyMagenta"
    | "CopyOpacity"
    | "CopyRed"
    | "CopyYellow"
    | "Difference"
    | "Divide"
    | "In"
    | "Minus"
    | "Multiply"
    | "Out"
    | "Over"
    | "Plus"
    | "Subtract"
    | "Xor"

The operator to use to combine the images Default: "Over"

§readonly options?: { ... }

Default: {}

§readonly positionX?: number

X (horizontal) position of the text Default: 50

§readonly positionY?: number

Y (vertical) position of the text Default: 50

§readonly primitive?: "circle" | "line" | "rectangle"

The primitive to draw Default: "rectangle"

§readonly resizeOption?:
    | "ignoreAspectRatio"
    | "maximumArea"
    | "minimumArea"
    | "onlyIfLarger"
    | "onlyIfSmaller"
    | "percent"

How to resize the image Default: "maximumArea"

§readonly rotate?: number

How much the image should be rotated Type options: {"minValue":-360,"maxValue":360}

§readonly sigma?: number

The sigma of the blur Default: 2 Type options: {"minValue":0,"maxValue":1000}

§readonly startPositionX?: number

X (horizontal) start position of the primitive Default: 50

§readonly startPositionY?: number

Y (horizontal) start position of the primitive Default: 50

§readonly text?: string

Text to write on the image Type options: {"rows":5}

§readonly width?: number

The width of the image to create Default: 50 Type options: {"minValue":1}