Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Drawing » DrawStringLabels_MultiColor

DrawStringLabels_MultiColor


Module: FoundationLite

Draws strings (text) on an image with multiple colors.

Name Type Range Description
Input value inImage Image Input image
Input value inLabels StringLabel?Array? String to draw
Input value inLocationAlignment CoordinateSystem2D*
Input value inLocationAnchor Anchor2D
Input value inColorIds Hash?Array*
Input value inPalette PixelArray*
Input value inDrawingStyle DrawingStyle
Input value inSize Real 10.0 - Height of a character in pixels
Input value inOrientationAngle Real Orientation of text in degrees
Input value inForceRgb Bool Filter will convert monochromatic image to RGB if needed
Input value inBackgroundColor Pixel* Color of pixels drawn on image in text row
Output value outImage Image Output image

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty inPalette while inLabels has objects to draw in DrawStringLabels_MultiColor.
DomainError No palette defined with inPalette for specified inColorIds in DrawStringLabels_MultiColor.
DomainError The sizes inLabels and inColorIds do not match in DrawStringLabels_MultiColor.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawStringLabels filter group.