TextOverlayTransformation class

NOTE: Permissions

Contact sales to enable text overlay features for your project.

Text overlay operation permits arbitrary, user provided content. This might be used for vandalism and serving of offensive and misleading messages from customer domain. Therefore, we recommend using it along with signed URLs.

The text operation allows placing arbitrary text on top of an image.

Inheritance
Implemented types

Constructors

TextOverlayTransformation({required Dimensions relativeDimensions, required Offsets relativeCoordinates, required String text, TextFontTransformation? font, TextAlignTransformation? align, TextBackgroundBoxTransformation? background})

Properties

align → TextAlignTransformation?
final
background → TextBackgroundBoxTransformation?
final
delimiter → String
Instruction delimiter
no setterinherited
font → TextFontTransformation?
final
hashCode → int
The hash code for this object.
no setterinherited
operation → String
CDN API operation URL directive
no setteroverride
params → List<String>
Related parameters
no setteroverride
relativeCoordinates → Offsets
Position of text area. Coordinates represent an offset along each of the axes in either pixel or percent format. In general, the coordinate system is similar to the CSS background-position. For example, -/text/90px10p/10%,90%/... places text in bottom left corner
final
relativeDimensions → Dimensions
Linear dimensions of area allocated for text placement. These dimensions are used for text alignment, and width affects line wrapping
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
text → String
Actual text to be placed
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited