DocFormatter
Canvas(
width
=
null
,
height
=
null
,
Border
border
=
null
)
A rectangular container that holds elements with arbitrary position.
The canvas looks at the X, Y, HAlignment and VAlignment of each of its children. Each child
will be placed at (0, 0) offset unless one of these is overridden. If there is no X offset and an
HAlignment is specified and the canvas has a specified Width then the child will align as
directed. If there is no Y offset and a VAlignment is specified and the canvas has a specified
Height then the child will align as directed. If HAlign or YAlign is specified for the canvas, this
serves as the default HAlignment and VAlignment respectively for all the children.
Example 1
Example
=
Canvas
(2", 1", 1) {
TextColor
:
Colors
.
Blue
;
Span
{
1;
X
:
20;
Y
:
20;
};
Span {
2;
X
:
40;
Y
:
40;
};
Span {
3;
HAlignment
:
HAligns
.
Right;
VAlignment
:
VAligns
.
Bottom;
}
};
1
2
3
Example 2
Example2 = HBox {
VAlign: Top;
ShowExtent(new(5, 0, Colors.Red));
ShowExtent(new(10, 0, Colors.Green));
};
Internal Size: 190, 40
Internal Size: 180, 30
Properties
Name
Description
Action
Click action handler
Background
Fill color inside the border
Baseline
Baseline as a percentage of the height
Begin
First item of the revision
BorderClip
Clip contents inside border
BorderRadius
Radius of the four corners of the frame
Bracket
Place brackets around the the items in the container
ClipPath
Clipping region for the canvas
ConnectPoints
Connect points for a shape
Delimiter
Add the delimiter only if the parent formatter is not the last item in the list
Direction
Stacking direction for a canvas
End
Last item of the revision
HAlign
Horizontal cell and canvas alignment options
HAlignment
Horizontal cell and canvas alignment options
HRelative
Horizontal frame alignment options
Justify
Justification and spacing for items in a canvas
LastSeparator
The Separator between the last 2 items of a list of 3 or more
Leading
Leading as a percentage of the height
Margin
Outer margin padding
Midline
Midline as a percentage of the height
Opacity
Degree of opaqueness (i.e 1.0 -> normal, 0.5 -> 50% transparent)
PairSeparator
The Separator between a pair of items
ScalingMode
Scaling mode for bitmaps
Separation
Extra space between children
Separator
Insert this item between all items in the container
Shadow
Color and size of the shadow
TextAbbreviate
Abbreviate unit names
TextAlignment
Vertical aligments for text in a span
TextBackground
Fill color for the area behind the text
TextCase
Text casing options
TextColor
Fill color for the text
TextColumns
Break lines after n characters
TextCulture
CultureInfo object
TextDenominator
Show double values as fractions whose max denominator is this value (e.g. 8
means 3.125 -> 3 1/8)
TextDiagonal
Use diagonal fractions
TextDigits
Number of decimal digits for doubles (e.g. 3 -> 3.142)
TextDivision
Add space after n characters
TextEquation
Format text as a math equation
TextFace
Type of font face
TextFamily
The name of a font family or a FontFamily object
TextFormat
Numeric/date format (e.g. MM-DD-YYYY)
TextGroup
Group digits together (e.g. 1,000,000)
TextHeight
Height of text in measure or % (e.g. 8 pts or 90%)
TextHidden
Do not show text
TextItalic
Use Italic version of font family
TextLanguage
Flags indicating the language of the text
TextLetterSpace
Extra space between letters
TextLiteral
Do not proofread
TextMinDigits
Remove trailing zeros
TextNumPadding
The minimum left-zero-padded size of the number (e.g. 4 -> 0001)
TextOffset
Vertical offset of text in measure or % of font height
TextOverline
Show a line over the text
TextPercent
Show numbers as a percentage (e.g. 12.2%)
TextRadix
Radix for integers (e.g. 2 -> binary, 10 -> decimal, 16 -> hexadecimal)
TextScientific
Show numbers in scientific notation (e.g. 3.02x10^23)
TextSignificant
Treat TextDigits as the number of significant figures (e.g. if 3 then 1.2 -> 1.20
and 3124 -> 3120
TextStacked
Stack Nary superscripts and subscripts above and below operators
TextStretch
Horizontal font stretch factor (e.g. 2.0 -> twice as wide)
TextStrike
Text strike-out styles
TextUnderline
Text underline styles
TextValue
Force symbolic numbers (e.g. PI) into their numberic values
TextWeight
Typeface weight options (e.g. normal=400, bold=700)
TextWordSpace
Extra space between words
Tip
Popup tip handler
TipAction
Popup tip and click action handler
TipNoPublish
Do not publish tips
Transform
Transform the contents and border of the object with an affine transform
matrix
TransformFit
Adjust the (X, Y, Width, Height) after transform to fit the object into a minimal
rectange=le
VAlign
Vertical cell and canvas alignment options
VAlignment
Vertical cell and canvas alignment options
VRelative
Vertical frame alignment options
Wrapping
Frame wrapping options
X
Offset of the item relative to its parent
Y
Offset of the item relative to its parent
