class Chevalet::Filters::Text

Annotate the image with text.

Parameters

text

Required. The text to draw on the image.

geometry

A geometry string describing the bounding box of the text. By default, text will fill the horizontal width of the image, and will be as high as is necessary to wrap all of the words in text. See Chevalet::Filters for information on geometry strings.

gravity

A gravity value specifying the position of the text on the image. See Chevalet::Filters for information on gravity.

x, y

The x- and y-offsets of the text in pixels from the sides as determined by the gravity parameter.

extend

Set to true to place the text outside of the original image, instead of on top of it. Set to an integer to add that many pixels of padding.

font

The font to use. See Chevalet::Filters for information on fonts.

size

The point size of the text.

color

The color of the text. See Chevalet::Filters for information on colors.

background

The background color of the text bounding box. See Chevalet::Filters for information on colors.

blend

The blend mode to use when compositing the text and the image. See Chevalet::Filters for information on blend modes.

stroke

The text stroke color. See Chevalet::Filters for more information on colors.

stroke_width

The text stroke width in pixels. Between 1 and 25, inclusive.

Constants

DefaultParams