AGTextParams

Synopsis

text parameters

group AGTextParams
{
AGColor color = "antibackground";
AGColor fillColor = "transparent";
AGFont font = "roman-simplex";
AGColor frameColor ="antibackground";
AGDistance frameWidth = 0.0;
AGHorizontalJustificationEnum horizontalJustification = "center";
AGMultiLineJustificationEnum multiLineJustification = "center";
AGFloat multiLineSpacingFactor = 0.0;
AGString+IPort2 text[];
AGVerticalJustificationEnum verticalJustification = "half";
};

Description

AGTextParams is a base object containing parameters common to all text objects.

Subobjects

text

An array of text strings. Multiple text strings are drawn only if an XY coordinate pair is supplied for each string in the text array. XY coordinate pairs are given in the geometry parameter of any of the AGText, AGRestrictedText, or AGTransformableText objects.

color
font

Color and font of the text.

fillColor
frameColor
frameWidth

Fill color, frame color, and frame width of bounding box for text.

horizontalJustification

Controls the horizontal justification of the text. Valid values are:

• "left"

• "center"

• "right"

verticalJustification

Controls the vertical justification of the text. Valid values are:

• "bottom"

• "font bottom"

• "font base"

• "font half"

• "half"

• "font cap"

• "font top"

• "top"

multiLineJustification

Controls the multiline justification of text that contains at least one newline ("\n") character in the string to draw. Valid values are:

• "left"

• "center"

• "right"

• "blocked"

multiLineSpacingFactor

Controls the spacing between adjacent lines of text that contain at least one newline ("\n") character in the string. The value is relative to the height of the individual text lines. Negative values are allowed.

Example

Not available.

File

v/ag.v