1001fx - NoCode functions icon

1001fx - NoCode functions

1001fx is a set of functions for any automation platform. Our functions are simple, very well tested, scalable and offer features that most automation platforms do not offer.

Actions74

images → Mask an Image with a Circle Mask

AI-generated

Overview

This node allows you to apply a circular mask to an image, effectively cropping the image into a circle with a specified radius and center position. This is useful for creating profile pictures, thumbnails, or any scenario where you need a circular version of an image. For example, you could use this node to automatically generate round avatars from uploaded user photos.

Properties

Name Meaning
Radius The radius for your circle. Determines how large the circular mask will be. (Required)
X coordinate The horizontal position of your circle center. Defaults to 0 if not specified.
Y coordinate The vertical position of your circle center. Defaults to 0 if not specified.
Image file Image file to be processed. The path or reference to the input image. (Required)
Binary Property Name of the binary property to which to write the data of the processed image. (Required; default: "data")

Output

  • Binary Data:
    The output is a binary file containing the processed image with the applied circular mask. The binary data is stored under the property name specified in "Binary Property".

    • The original binary properties are preserved.
    • The filename and content type are set according to the processed image.

  • JSON:
    The json field contains the original JSON data from the input item. If an error occurs and "Continue On Fail" is enabled, the json field will contain an error property with details about the failure.

Dependencies

  • External Service: Requires access to the 1001fx API.
  • API Key: You must configure the 1001fxApi credential in n8n.
  • Environment: No additional environment variables are required beyond standard n8n configuration.

Troubleshooting

  • Common Issues:

    • Missing or Invalid Image File: If the "Image file" property is not provided or does not point to a valid image, the node will fail.
    • Radius Too Small or Not Provided: The "Radius" property is required and must be at least 1. If omitted or invalid, the node will throw an error.
    • API Credential Errors: If the 1001fxApi credential is missing or incorrect, authentication errors will occur.
    • Output Binary Property Name: If the "Binary Property" name does not match the expected usage downstream, subsequent nodes may not find the processed image.

  • Error Messages:

    • Errors from the 1001fx API are returned in the error property of the output JSON when "Continue On Fail" is enabled.
    • Authentication or network errors will also appear in the error property.

Links and References

Discussion