RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSFMXSVG > FMX.RS.SVG.Text > Classes

TSVGCustomText Class

Represents the common ancestor for all text elements (text, tref, tspan, text-path). Every svg text element potentially has multiple X, Y, DX, DY, and Rotate values to specify the location and orientation of each character in the text. If a text element does not specify its own X and Y values itself, it uses the FMX.RS.SVG.Text.TSVGCustomText.CurrentTextPosition.

Notes to Implementers
Using default options on desktop platforms, all text elements in the RSCL work by converting the text into paths. First, the text of the parent and all of its text content children are divided into chunks. Each absolute position adjustment defines a new text chunk. A text chunk can span text child elements if they do not define a new absolute position. After the text is divided into chunks, the CreateTextShapes method (implemented in the TSVGText class) creates paths from all the text chunks. Note that the TSVGTextPath class subverts this text chunking to provide an absolute position for every character so that the text aligns along its path. When TSVGDocument.Options includes the soUseFillText option, text is not converted into paths but rendered directly to the canvas using FillText calls. On iOS and Android and when using the FMX GPU Canvas on desktop (FMX.Types.GlobalUseGPUCanvas), text is always filled. The following differences exist between the two text rendering paths: • Fill Text does not use the Pen and so cannot both fill and stroke text • Fill Text cannot use gradients for filling (FMX) • Fill Text uses less memory • Fill Text generates better text at small sizes • Fill Text does not do center and right alignment for complex text (i.e., text that has dx, dy, rotate, vertical writing mode, etc style properties defined) • Fill Text has better compatibility with non-Western fonts • Path-based text can both fill and stroke text (however, on non-Windows platforms gradients are not used in stroking text) • Path-based text caches its shapes so subsequent draw calls are faster, even faster than fill text calls in many cases • Path-based text allows pixel level selection of text; Fill Text can only be selected as a text bounding box • Path-based text renders decorative fonts (underline, overline, and strike-out) using an extra path for the decoration (FMX will not generate paths with the decoration when converting text to paths). Surprisingly, this means that compatibility is higher with path-based text as the decoration gets its rendering configuration from the parent text element (e.g., strike-out text should use the parent text's font size and not vary as the size of child text span's font size changes). •ShapeRendering affects the smoothness of text when filling path-based text (as text are shapes); TextRendering affects the smoothness of text when filling text

alert_note Notes to Implementers

Using default options on desktop platforms, all text elements in the RSCL work by converting the text into paths. First, the text of the parent and all of its text content children are divided into chunks. Each absolute position adjustment defines a new text chunk. A text chunk can span text child elements if they do not define a new absolute position. After the text is divided into chunks, the CreateTextShapes method (implemented in the TSVGText class) creates paths from all the text chunks.

Note that the TSVGTextPath class subverts this text chunking to provide an absolute position for every character so that the text aligns along its path.

When TSVGDocument.Options includes the soUseFillText option, text is not converted into paths but rendered directly to the canvas using FillText calls. On iOS and Android and when using the FMX GPU Canvas on desktop (FMX.Types.GlobalUseGPUCanvas), text is always filled.

The following differences exist between the two text rendering paths:

• Fill Text does not use the Pen and so cannot both fill and stroke text

• Fill Text cannot use gradients for filling (FMX)

• Fill Text uses less memory

• Fill Text generates better text at small sizes

• Fill Text does not do center and right alignment for complex text (i.e., text that has dx, dy, rotate, vertical writing mode, etc style properties defined)

• Fill Text has better compatibility with non-Western fonts

• Path-based text can both fill and stroke text (however, on non-Windows platforms gradients are not used in stroking text)

• Path-based text caches its shapes so subsequent draw calls are faster, even faster than fill text calls in many cases

• Path-based text allows pixel level selection of text; Fill Text can only be selected as a text bounding box

• Path-based text renders decorative fonts (underline, overline, and strike-out) using an extra path for the decoration (FMX will not generate paths with the decoration when converting text to paths). Surprisingly, this means that compatibility is higher with path-based text as the decoration gets its rendering configuration from the parent text element (e.g., strike-out text should use the parent text's font size and not vary as the size of child text span's font size changes).

•ShapeRendering affects the smoothness of text when filling path-based text (as text are shapes); TextRendering affects the smoothness of text when filling text

Namespace: FMX.RS.SVG.Text

	Name	Description
	Create(TSVGDocument)	Initializes a new instance of the TSVGCustomText class. (Overrides FMX.RS.SVG.TSVGGraphicElement.Create(TSVGDocument).)
	Destroy	Represents the destructor of the TSVGCustomText class. (Overrides FMX.RS.SVG.TSVGGraphicElement.Destroy.)

Top

Name

Description

published property

AlignmentBaseline

Specifies how an object is aligned with respect to its parent. This property specifies which baseline of this element is to be aligned with the corresponding baseline of the parent. For example, this allows alphabetic baselines in Roman text to stay aligned across font size changes. It defaults to the baseline with the same name as the computed value of the alignment-baseline property. That is, the position of "ideographic" alignment-point in the block-progression-direction is the position of the "ideographic" baseline in the baseline-table of the object being aligned.

Note
Currently, only auto/baseline is supported

public property

Attributes

Returns the valid style properties of the svg element (Inherited from FMX.RS.SVG.TSVGElement.)

published property

BaselineShift

Allows repositioning of the dominant-baseline relative to the dominant-baseline of the parent text content element. The shifted object might be a sub- or superscript. Within the shifted object, the whole baseline-table is offset; not just a single baseline. The amount of the shift is determined from information from the parent text content element, the sub- or superscript offset from the nominal font of the parent text content element, percent of the "line-height" of the parent text content element or an absolute value.

Note
‘baseline-shift’ properties can nest. Each nested ‘baseline-shift’ is added to previous baseline shift values.

public property

BoundsRect

Specifies the bounding rectangle (X, Y, X+Width, Y+Height) for the SVG element unmodified by any transformations in the current coordinate system.

The X, Y, Width, and Height properties specify coordinates in virtual pixels of the nearest viewbox, or coordinate system. For example, a TSVGDocument may specify a ViewBox of 0, 0, 100, 100. Specifying an element's X and Y as 50, 50 will always position the element to start in the exact center of the view box. If the TSVGDocument is then drawn to a true pixel rectangle of 1000 pixel width and 500 pixel height, the element would draw at 500, 250 pixels.

To retrieve the "true" bounding rectangle which has been modified by any transformations, use the GetBoundsRect method

The BoundsRect and X/Y/Width/Height properties specify coordinates in virtual pixels of the nearest viewbox, or coordinate system. For example, a TSVGDocument may specify a ViewBox of 0, 0, 100, 100. Specifying an element's X and Y as 50, 50 will always position the element to start in the exact center of the view box. If the TSVGDocument is then drawn to a true pixel rectangle of 1000 pixel width and 500 pixel height, the element would draw at 500, 250 pixels.

Note
Note that this property is before any transformation (i.e., Matrix property) is applied

published property

Brush

Brush used for drawing the fill portions of the SVG element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

BrushChanged

Specifies whether the Brush has been changed and needs to be reinitializated by the GetBrush method. Set this property to true to force initialization of the Brush for the current SVG element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

Classes

Specifies the 'classes' that the SVG element belongs to. The classes property assigns one or more class names to an element. The element may be said to belong to these classes. A class name may be shared by several element instances. (Inherited from FMX.RS.SVG.TSVGElement.)

protected property

ClippingChanged

Specifies whether the Clipping has been changed and needs to be reinitializated by the GetClipping method. Set this property to false to force initialization of the Clipping for the current SVG element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

ClipRect

Returns the clipping rectangle for the element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

ClipRule

Clipping rule for how this element adds to the clipping path (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

ClipURI

ID of the SVG element that provides the clipping region (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

ClipURIElement

Returns the SVG element that provides the clipping region for the current element.

The ClipURI property specifies the ID of the SVG element that provides the clipping region

published property

Color

Color used for provide a potential indirect value (currentColor) for the ‘fill’, ‘stroke’, ‘stop-color’, ‘flood-color’ and ‘lighting-color’ properties (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

ColorInterpolation

Color interpolation type, which specifies the color space for gradient interpolations and alpha compositing

VCL Only

published property

ColorRendering

Color rendering type, which provides a hint to the SVG library about how to optimize its color interpolation and compositing operations.

VCL Only

protected property

CurrentTextIndex

Returns the index into the Text property of the current text element and all of its childrens' text together.

protected property

CurrentTextPosition

Returns the current position to place the next character in the text

published property

Cursor

Cursor to use when over this element type (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

Description

Specifies a non-visual Description for the SVG element. When generating FMX controls, the FMX control's Hint property is set to the Description. If the Description is empty, the Hint is set to the Title (Inherited from FMX.RS.SVG.TSVGElement.)

published property

Direction

Specifies the base writing direction of text.

The ‘direction’ property applies only to glyphs oriented perpendicular to the inline-progression-direction, which includes the usual case of horizontally-oriented Latin or Arabic text and the case of narrow-cell Latin or Arabic characters rotated 90 degrees clockwise relative to a top-to-bottom inline-progression-direction.

Within text content elements, the alignment of text with regards to the ‘text-anchor’ property is determined by the value of the ‘direction’ property. For example, given a ‘text’ element with a ‘text-anchor’ value of "end", for a ‘direction’ value of "ltr", the text will extend to the left of the position of the ‘text’ element's ‘x’ attribute value, while for ‘direction’ value of "rtl", the text will extend to the right of the position of the ‘text’ element's ‘x’ attribute value.

published property

DominantBaseline

Determine or re-determine a scaled-baseline-table. A scaled-baseline-table is a compound value with three components: a baseline-identifier for the dominant-baseline, a baseline-table and a baseline-table font-size. Some values of the property re-determine all three values; other only re-establish the baseline-table font-size. When the initial value, auto, would give an undesired result, this property can be used to explicitly set the desire scaled-baseline-table.

Note
Not supported

public property

Specifies the list of relative x-axis coordinates for each character in the text.

If a single <length> is provided, this value represents the new relative X coordinate for the current text position for rendering the glyphs corresponding to the first character within this element or any of its descendants. The current text position is shifted along the x-axis of the current user coordinate system by <length> before the first character's glyphs are rendered.

If a comma- or space-separated list of n <length>s is provided, then the values represent incremental shifts along the x-axis for the current text position before rendering the glyphs corresponding to the first n characters within this element or any of its descendants. Thus, before the glyphs are rendered corresponding to each character, the current text position resulting from drawing the glyphs for the previous character within the current ‘text’ element is shifted along the X axis of the current user coordinate system by <length>.

If more <length>s are provided than characters, then any extra <length>s will have no effect on glyph positioning.

If more characters exist than <length>s, then for each of these extra characters: (a) if an ancestor ‘text’ or ‘tspan’ element specifies a relative X coordinate for the given character via a ‘dx’ attribute, then the current text position is shifted along the x-axis of the current user coordinate system by that amount (nearest ancestor has precedence), else (b) no extra shift along the x-axis occurs.

If the attribute is not specified: (a) if an ancestor ‘text’ or ‘tspan’ element specifies a relative X coordinate for a given character via a ‘dx’ attribute, then the current text position is shifted along the x-axis of the current user coordinate system by that amount (nearest ancestor has precedence), else (b) no extra shift along the x-axis occurs.

public property

DXStr

Provides a string representation of the FMX.RS.SVG.Text.TSVGCustomText.DX array property

public property

Specifies the list of relative y-axis coordinates for each character in the text.

The processing rules for the DY property parallel the processing rules for the FMX.RS.SVG.Text.TSVGCustomText.DY property.

public property

DYStr

Provides a string representation of the FMX.RS.SVG.Text.TSVGCustomText.DY array property

public property

ElementState

Returns the state of the element. Use this property to correctly update the element when it is in a certain state. (Inherited from FMX.RS.SVG.TSVGElement.)

published property

Enabled

Specifies whether the element is enabled or disabled. By default, disabled elements are not exported or detected by the FMX.RS.SVG.TSVGElement.ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions) method.

Disabled elements are shown using a grayscale version of the element, which may be overridden with the OnDisableAppearance event.

published property

FillRule

Indicates the algorithm which is to be used to determine what parts of the canvas are included inside the element shape. For a simple, non-intersecting path, it is intuitively clear what region lies "inside"; however, for a more complex path, such as a path that intersects itself or where one subpath encloses another, the interpretation of "inside" is not so obvious. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

Font

Font used for drawing the Text portions of the SVG element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

FontChanged

Specifies whether the Font has been changed and needs to be reinitializated by the GetFont method. Set this property to false to force initialization of the Font for the current SVG element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

GlyphOrientationHorizontal

In some cases, it is required to alter the orientation of a sequence of characters relative to the inline-progression-direction. The requirement is particularly applicable to vertical layouts of East Asian documents, where sometimes narrow-cell Latin text is to be displayed horizontally and other times vertically.

Two properties control the glyph orientation relative to the reference orientation for each of the two possible inline-progression-directions. ‘glyph-orientation-vertical’ controls glyph orientation when the inline-progression-direction is vertical. ‘glyph-orientation-horizontal’ controls glyph orientation when the inline-progression-direction is horizontal.

This property is applied only to text written in a horizontal FMX.RS.SVG.TSVGGraphicElement.WritingMode .

published property

GlyphOrientationVertical

This property is applied only to text written in a vertical FMX.RS.SVG.TSVGGraphicElement.WritingMode

public property

Height

Height of the element in the current user coordinate system

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

public property

HeightU

Height of the element in the current user coordinate system.

The property is a length with raw measurement value and its units (e.g., 1 inch, 2.5 centimeters, etc). When the element needs to get the x-axis coordinate in pixels, this property converts the raw measurement value using the FMX.RS.SVG.TSVGGraphicElement.GetUnitFactors (e.g., 1 inch = 96 pixels) .

The Xu, Yu, WidthU, and HeightU properties specify coordinates in virtual pixels of the nearest viewbox, or coordinate system. For example, a TSVGDocument may specify a ViewBox of 0, 0, 100, 100. Specifying an element's X and Y as 50, 50 will always position the element to start in the exact center of the view box. If the TSVGDocument is then drawn to a true pixel rectangle of 1000 pixel width and 500 pixel height, the element would draw at 500, 250 pixels.

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

published property

Unique name for the SVG element. The SVG document's AllItems property uses the ID as the unique hash for returning SVG elements (Inherited from FMX.RS.SVG.TSVGElement.)

published property

Inherits

Style properties or attributes which inherits their values from the Parent. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

InlineProgressionDirection

Returns the inline progression direction, i.e., what direction should the characters go as they are being drawn: left to right, right to left, or top to bottom?

public property

Items

The child SVG Items of the current element. The Parent and Items properties define the hierarchy of a SVG document fragment. (Inherited from FMX.RS.SVG.TSVGElement.)

published property

Kerning

Specifies whether inter-glyph spacing should be adjusted based on behavior kerning tables that are included in the relevant font (i.e., enable auto-kerning) or instead disable auto-kerning and instead set inter-character spacing to a specific length (typically, zero).

note Note

Three properties affect the space between characters and words:

• ‘kerning’ indicates whether the user agent should adjust inter-glyph spacing based on kerning tables that are included in the relevant font (i.e., enable auto-kerning) or instead disable auto-kerning and instead set inter-character spacing to a specific length (typically, zero).

• ‘letter-spacing’ indicates an amount of space that is to be added between text characters supplemental to any spacing due to the ‘kerning’ property.

• ‘word-spacing’ indicates the spacing behavior between words.

published property

Language

Specifies the Language of the SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

published property

LetterSpacing

Specifies spacing between text characters supplemental to any spacing due to the FMX.RS.SVG.TSVGGraphicElement.Kerning property

note Note

Three properties affect the space between characters and words:

• ‘letter-spacing’ indicates an amount of space that is to be added between text characters supplemental to any spacing due to the ‘kerning’ property.

• ‘word-spacing’ indicates the spacing behavior between words.

public property

LineText

Returns a string of the FMX.RS.SVG.Text.TSVGCustomText.Text of the current text element and all child text content elements

protected property

Listeners

Maintains the list of elements that need to be notified when this element changes or is being destroyed

When the current element changes, it will call the FMX.RS.SVG.TSVGElement.NotifyListener(TSVGElement) method of every element on this list

published property

MarkerEndURI

ID of the SVG element that defines arrowhead or polymarker that shall be drawn at the final vertex of the given path element or basic shape (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

MarkerMidURI

ID of the SVG element that defines arrowhead or polymarker that shall be drawn at the every other vertex (i.e., every vertex except the first and last) of the given path element or basic shape (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

MarkerStartURI

ID of the SVG element that defines arrowhead or polymarker that shall be drawn at the first vertex of the given path element or basic shape (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

Matrix

Local Transformation matrix for the element

Note that the final transformation of the element depends on its Parents' transformation matrices

published property

Opacity

Uniform opacity setting to be applied across an entire object, as a . Any values outside the range 0.0 (fully transparent) to 1.0 (fully opaque) will be clamped to this range. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

OpacityPreferredUnit

Provides the unit type (e.g., mm, px, etc) to use when displaying the Opacity (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

Options

Defines options for reading, displaying, and writing the svg.

The most important option as far as compatibility is the soUseFillText option. When this option is present, the RSCL uses FillText calls to directly render the text to the canvas. When this option is not present (default), the RSCL converts text into paths that are then filled and stroked. Converting text to paths provides the highest compatibility but slower performance. If you use the FMX GPU Canvas (FMX.Types.GlobalUseGPUCanvas), text is always filled and not converted to paths.

The following differences exist between the two text rendering paths:

• Fill Text does not use the Pen and so cannot both fill and stroke text

• Fill Text cannot use gradients for filling (FMX)

•ShapeRendering affects the smoothness of text when filling path-based text (as text are shapes); TextRendering affects the smoothness of text when filling text

• Fill Text uses less memory

• Fill Text generates better text at small sizes

• Path-based text caches its shapes so subsequent draw calls are faster, even faster than fill text calls in many cases

• Path-based text allows pixel level selection of text; Fill Text can only be selected as a text bounding box

(Inherited from FMX.RS.SVG.TSVGElement.)

published property

Overflow

Specifies whether the content of a block-level element is clipped when it overflows the element's box (which is acting as a containing block for the content) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

Owner

Returns the Owner SVG document for the SVG element. (Inherited from FMX.RS.SVG.TSVGElement.)

public property

Parent

The Parent SVG Element of the current element. The Parent and Items properties define the hierarchy of a SVG document fragment. (Inherited from FMX.RS.SVG.TSVGElement.)

published property

ParentPreferredStyles

Specifies whether to use the current element's Preferred Styles property or use its graphic parent (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

Pen

Pen used for drawing the stroke portions of the SVG element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

PenChanged

Specifies whether the Pen has been changed and needs to be reinitializated by the GetPen method. Set this property to false to force initialization of the Pen for the current SVG element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

PreferredStyles

Defines which style properties should be exported as a style (e.g., style=" fill:red; fill-opacity:1;" or as an attribute (e.g., fill="red").

Include style properties in this property to have the style property output as part of the style="" attribute.

published property

RequiredExtensions

Specifies a list of required language extensions. Language extensions are capabilities within a user agent that go beyond the feature set defined in this specification. Each extension is identified by an IRI reference.

The RSCL supports no extensions.

published property

RequiredFeatures

Defines a list of feature strings. Determines whether all of the named features are supported by the RSCL. (Inherited from FMX.RS.SVG.TSVGElement.)

public property

Rotate

Specifies the list of supplemental rotations to perform for each character in the text.

If a comma- or space-separated list of <number>s is provided, then the first <number> represents the supplemental rotation for the glyphs corresponding to the first character within this element or any of its descendants, the second <number> represents the supplemental rotation for the glyphs that correspond to the second character, and so on.

If more <number>s are provided than there are characters, then the extra <number>s will be ignored.
If more characters are provided than <number>s, then for each of these extra characters the rotation value specified by the last number must be used.

If the attribute is not specified and if an ancestor ‘text’ or ‘tspan’ element specifies a supplemental rotation for a given character via a ‘rotate’ attribute, then the given supplemental rotation is applied to the given character (nearest ancestor has precedence). If there are more characters than <number>s specified in the ancestor's ‘rotate’ attribute, then for each of these extra characters the rotation value specified by the last number must be used.

This supplemental rotation has no impact on the rules by which current text position is modified as glyphs get rendered and is supplemental to any rotation due to text on a path and to ‘glyph-orientation-horizontal’ or ‘glyph-orientation-vertical’.

public property

RotateStr

Provides a string representation of the FMX.RS.SVG.Text.TSVGCustomText.Rotate array property

protected property

Shape

Returns a path defining the shape of the current svg element. This option can speed up redraws by using this cached shape instead of redrawing the svg element from scratch.

Note
Not all elements define a path shape

protected property

ShapeCacheChanged

Specifies whether the Shape has been changed and needs to be reinitializated by the GetShape method. Set this property to false to force initialization of the ShapeCache for the current SVG element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

ShapeRendering

Shape rendering type, which provides a hint to the SVG library about what tradeoffs to make as it renders vector graphics elements such as path elements and basic shapes such as circles and rectangles.

VCL Only

published property

Style

Style for the element, the properties or attributes explicitly set by the element and not inherited or set by another style (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

SystemLanguages

Specifies a list of language names as defined in BCP 47 (Inherited from FMX.RS.SVG.TSVGElement.)

published property

Tag

Represents property Tag. (Inherited from FMX.RS.SVG.TSVGElement.)

public property

Text

Text or caption of the text element

published property

TextAlign

Defines the Text alignment, which is used to align (start-, middle- or end-alignment) a string of text relative to a given point (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

TextHeight

Specifies the height of the text based on the current Font .

Note
The TextWidth and TextHeight properties are used for quick calculation of the BoundsRect property. There are set the first time the text element is drawn. If the TextWidth = -1, the TextWidth and TextHeight need to be recalculated because the text element has changed.

published property

TextRendering

Text rendering type, which provides a hint to the SVG library about what tradeoffs to make as it renders text

VCL Only

protected property

TextWidth

Specifies the width of the text based on the current Font .

Note
The TextWidth and TextHeight properties are used for quick calculation of the BoundsRect property. There are set the first time the text element is drawn. If the TextWidth = -1, the TextWidth and TextHeight need to be recalculated because the text element has changed.

published property

Title

Specifies a non-visual Title of the SVG element. When generating FMX controls, the FMX control's Hint property is set to Title if the Description property is empty (Inherited from FMX.RS.SVG.TSVGElement.)

published property

TransformMatrix

Specifies the local transformation FMX.RS.SVG.TSVGGraphicElement.Matrix as a string (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected property

UpdateCount

Maintains the number of times BeginUpdate has been called without a corresponding EndUpdate. When the UpdateCount is greater than 0, no change events occur. (Inherited from FMX.RS.SVG.TSVGElement.)

published property

VectorEffect

Modifies the way an object is stroked. Sometimes it is of interest to let the outline of an object keep its original width no matter which transforms are applied to it. For example, in a map with a 2px wide line representing roads it is of interest to keep the roads 2px wide even when the user zooms into the map. To achieve this, SVG Tiny 1.2 introduces the 'vector-effect' property. Future versions of the SVG language may allow for more powerful vector effects through this property. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

published property

Visible

Visibility of the element, whether it should be painted or not (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

Width

Width of the element in the current user coordinate system

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

public property

WidthU

Width of the element in the current user coordinate system.

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

published property

WordSpacing

Specifies spacing behavior between words

note Note

Three properties affect the space between characters and words:

• ‘letter-spacing’ indicates an amount of space that is to be added between text characters supplemental to any spacing due to the ‘kerning’ property.

• ‘word-spacing’ indicates the spacing behavior between words.

published property

WritingMode

Specifies whether the initial inline-progression-direction for a ‘text’ element shall be left-to-right, right-to-left, or top-to-bottom. The ‘writing-mode’ property applies only to ‘text’ elements; the property is ignored for ‘tspan’, ‘tref’, ‘altGlyph’ and ‘textPath’ sub-elements. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public property

Specifies the list of absolute x-axis coordinates for each character in the text.

If a single <coordinate> is provided, then the value represents the new absolute X coordinate for the current text position for rendering the glyphs that correspond to the first character within this element or any of its descendants.

If a comma- or space-separated list of n <coordinate>s is provided, then the values represent new absolute X coordinates for the current text position for rendering the glyphs corresponding to each of the first n characters within this element or any of its descendants.

If more <coordinate>s are provided than characters, then the extra <coordinate>s will have no effect on glyph positioning.

If more characters exist than <coordinate>s, then for each of these extra characters: (a) if an ancestor ‘text’ or ‘tspan’ element specifies an absolute X coordinate for the given character via an ‘x’ attribute, then that absolute X coordinate is used as the starting X coordinate for that character (nearest ancestor has precedence), else (b) the starting X coordinate for rendering the glyphs corresponding to the given character is the X coordinate of the resulting current text position from the most recently rendered glyph for the current ‘text’ element.

If the attribute is not specified: (a) if an ancestor ‘text’ or ‘tspan’ element specifies an absolute X coordinate for a given character via an ‘x’ attribute, then that absolute X coordinate is used (nearest ancestor has precedence), else (b) the starting X coordinate for rendering the glyphs corresponding to a given character is the X coordinate of the resulting current text position from the most recently rendered glyph for the current ‘text’ element.

public property

XStr

Provides a string representation of the FMX.RS.SVG.Text.TSVGCustomText.X array property

public property

x-axis coordinate of the element which has the smaller x-axis coordinate value in the current user coordinate system.

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

public property

Specifies the list of absolute y-axis coordinates for each character in the text.

The processing rules for the Y property parallel the processing rules for the FMX.RS.SVG.Text.TSVGCustomText.X property.

public property

YStr

Provides a string representation of the FMX.RS.SVG.Text.TSVGCustomText.Y array property

public property

y-axis coordinate of the element which has the smaller y-axis coordinate value in the current user coordinate system.

Note
Note that this property is before any transformation (i.e., FMX.RS.SVG.TSVGGraphicElement.Matrix property) is applied

Top

Name

Description

protected method

AlignText(TSVGCustomText,TSVGShapePath,TSVGRect,TSVGPoint)

Aligns (start, middle, end) the text shape in the Line parameter (a string of character shapes) within the TextR rectangle. The TextPadding parameter controls the amount of padding, or margin, to leave within the TextR rectangle.

The alignment is based on the GetTextAlign method as well as the inline progression direction.

public method

ApplyStyle(TSVGStyle)

Applies the input style to the SVG element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

ApplyStyles

Applies all styles that match the element to the element. All child elements also have their styles applied. (Overrides FMX.RS.SVG.TSVGElement.ApplyStyles.)

public method

Assign(TPersistent)

Represents method Assign(TPersistent). (Inherited from FMX.RS.SVG.TSVGElement.)

public method

AssignProperties(TPersistent)

Copies the properties of source to the current element (but not children) (Overrides FMX.RS.SVG.TSVGGraphicElement.AssignProperties(TPersistent).)

protected method

AssignTo(TPersistent)

Represents method AssignTo(TPersistent). (Overrides FMX.RS.SVG.TSVGElement.AssignTo(TPersistent).)

public method

BakeTransformation(TSVGMatrix)

Represents method BakeTransformation(TSVGMatrix). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

BakeTransformationChildren(TSVGMatrix)

Represents method BakeTransformationChildren(TSVGMatrix). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

BeforeDestruction

Represents method BeforeDestruction. (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

BeginDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

Initializes the canvas with the current element's Brush, Pen, Font, and Clipping information to prepare the canvas for drawing the svg element.

The state of the input canvas is saved so that it may be restored after drawing the current element.

Note
This function returns True if the current element should be drawn. If the function returns False, the current element will not be drawn though all setup (clipping rectangles, fonts, etc) will still be done. Its children's draw methods will also still be called.

public method

BeginUpdate

Marks the start of an update session of the element and its children.

No change events occur after the BeginUpdate call. A call to BeginUpdate must be complemented by calls to EndUpdate after the update is finished.

(Inherited from FMX.RS.SVG.TSVGElement.)

protected method

BuildClipRegion(TSVGClipRegion,TSVGMatrix,TSVGRect)

Build a clip region or path that represents the combined shape of the current Element and all of its visible children (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

Change(TSVGElement)

Called when any property of the element changes (Overrides FMX.RS.SVG.TSVGElement.Change(TSVGElement).)

public method

ChangeNotification(TSVGElement)

Ensures that aListener is notified that the element is going to be changed or destroyed. When the current element changes, it will call the aListener.NotifyListener method.

Use ChangeNotification when the aListener element must be notified when the current element changes. For example, the TSVGUse element uses this mechanism to know when to redraw because its Reference element has changed

public method Class member

ChildSVGTypes

Returns the set of allowable child SVG element types (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

ChunkChildrenText(TSVGCanvas,TSVGMatrix,TSVGTextChunks)

Chunks the children of the current text element

protected method

ChunkText(TSVGCanvas,TSVGMatrix,TSVGTextChunks)

Chunks the current text element. If the TextChunks parameter already holds chunks, it appends onto the end.

Chunking means to divide text up into segments. Each absolute position adjustment defines a new text chunk. A text chunk can span text child elements if they do not define a new absolute position.

The Text field holds the text. The Chars array holds the position and formatting information for each character in the text.

public method

Clear

Clears the SVG element and resets its properties back to their defaults (Overrides FMX.RS.SVG.TSVGGraphicElement.Clear.)

protected method

ClearShapes(Boolean)

Clear the current Shape property and all children

public method

Clone(TSVGDocument)

Clones the element and all of its child elements. The aOwner parameter should be a different document (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

ConvertToPath(TSVGShapePath,TSVGCanvas,String,Single,Single,TSVGTextAlign)

Overloaded. Convert text to path in one text chunk (no using X, Y, dx, dy, rotate, kerning, etc)

fast but inaccurate

protected method

CreateControl(TControl)

Creates a TControl that best represents the svg element (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

CreateLength(TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a TSVGLength object and initializes its events to the parameter events (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

CreateLengths

Creates a TSVGLengths object list (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

CreateStylePropertyAutoLength(TSVGStyleProperty,TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a FMX.RS.SVGTypes.TSVGStylePropertyAutoLength object and initialize it (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

CreateStylePropertyLength(TSVGStylePropertyLengthClass,TSVGStyleProperty,TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a FMX.RS.SVGTypes.TSVGStylePropertyLength object and initialize it (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

CreateTextShapes(TSVGCanvas,TSVGMatrix)

Create text shapes, i.e., create path representations of the glyphs in the FMX.RS.SVG.Text.TSVGCustomText.Text property.

protected method

CreateXLength(Single)

Represents method CreateXLength(Single).

protected method

CreateYLength(Single)

Represents method CreateYLength(Single).

protected method

DefineProperties(TFiler)

Represents method DefineProperties(TFiler). (Overrides FMX.RS.SVG.TSVGElement.DefineProperties(TFiler).)

protected method

DisableAppearance(TSVGMatrix,TSVGCanvas,TSVGRect)

Changes the canvas fill and stroke values for disabled elements (Enabled = False) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DoBakeTransformation(TSVGMatrix)

Represents method DoBakeTransformation(TSVGMatrix). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DoDisableAppearance(TObject,TSVGMatrix,TSVGCanvas,TSVGRect)

The method returns true if the appearance of disabled elements (Enabled = False) should be changed.

The FMX.RS.SVG.TSVGGraphicElement.DisableAppearance(TSVGMatrix,TSVGCanvas,TSVGRect) method does the actual modification of the element's appearance.

protected method

DoDrawing(TObject,TSVGMatrix,TSVGCanvas,TSVGRect)

This method is called just before drawing the current element and its children. The method is called after the canvas brush, pen, font, clipping, etc are set up but before the actual drawing.

It exposes the OnDrawing event.

Note
This function returns True if the current element should be drawn. If the function returns False, the current element will not be drawn. However, its children's draw methods will still be called.

protected method

DoDrawn(TObject,TSVGMatrix,TSVGCanvas,TSVGRect)

This method is called just after drawing the current element and its children. The method is called after drawing the current element and its children but before the canvas is returned to its initial state.

It exposes the OnDraw event.

protected method

DoFillTextChunks(TSVGMatrix,TSVGCanvas,TSVGRect,TSVGTextChunks)

Draw the text chunks to the canvas using FillText calls

protected method

DoInternalDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

Draw the current SVG element only (not its children) to the specified canvas inside the specified rectangle. The matrix parameter specifies the cumulative transformations from the Parent element (and its Parents) to apply when drawing the element.

This method is overridden by descendant classes for svg element specific drawing.

Note
If the Shape property returns a path, this method will draw the path

protected method

DoInternalElementAtPos(TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

Returns the SVG element located at the specified position in the SVG. The method assumes the size and location of the current element is the rectangle specified by aRect. The DoInternalElementAtPos method does the actual detection for the current element (and not its children).

If no SVG element is found at the specified location, the function returns nil.

protected method

DoLoadFromXML(IXMLNode)

This method sets the properties of the svg element from the node when loading the svg from XML

This method does the work for the current svg element only.

protected method

DoMeasureText(TSVGCanvas)

Measures the width and height of the current element's FMX.RS.SVG.Text.TSVGCustomText.Text and all children. This is a quick measurement of the text using its font; the method does not factor in per-character placement, rotations, etc.

protected method

DoModifyControl(TControl,TSVGMatrix,TRectF,TSVGControlElementEvent)

Represents method DoModifyControl(TControl,TSVGMatrix,TRectF,TSVGControlElementEvent). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DoOnElementFound(TSVGGraphicElement)

This method is called when an SVG element is found at the specified position during an FMX.RS.SVG.TSVGElement.ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions) method call.

The method fires the OnElementFound event.

protected method

DoOnParsedNode(TSVGElement)

Called when an OnParsedNode event should fire (i.e., just after the node is parsed to set the properties of the svg element) (Overrides FMX.RS.SVG.TSVGElement.DoOnParsedNode(TSVGElement).)

protected method

DoOnParsingNode(TSVGElement,IXMLNode)

Called when an OnParsingNode event should fire (i.e., just before the node is parsed to set the properties of the svg element) (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

DoOnSavedElement(TSVGElement,IXMLNode)

Called when an OnSavingElement event should fire (i.e., just after the svg element's properties are written to the node) (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

DoOnSavingElement(TSVGElement,IXMLNode)

Called when an OnSavingElement event should fire (i.e., just before the svg element's properties are written to the node) (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

DoSaveToXML(IXMLNode)

This method saves the properties of the svg element to the xml node.

This method does the work for the current svg element only.

protected method

DoShouldDraw

Represents method DoShouldDraw. (Overrides FMX.RS.SVG.TSVGElement.DoShouldDraw.)

public method

Draw(TSVGCanvas,TSVGRect)

Draw the SVG to the specified canvas inside the specified rectangle (Overrides FMX.RS.SVG.TSVGElement.Draw(TSVGCanvas,TSVGRect).)

public method

Draw(TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draw the SVG to the specified canvas inside the specified rectangle. The matrix parameter specifies the cumulative transformations from the Parent element (and its Parents) to apply when drawing the element. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DrawChildren(TSVGMatrix,TSVGCanvas,TSVGRect)

Draws all of the current element's children to the canvas (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

DrawElement(TSVGMatrix,TSVGCanvas,TSVGRect)

Draw the svg element and its children to the specified canvas inside the specified rectangle.

No ancestors or siblings are drawn. The svg element is drawn where it would be if the entire SVG was drawn.

protected method

DrawElementParent(TSVGMatrix,TSVGCanvas,TSVGRect)

Sets up parent transformation and clipping so that current element can draw itself properly (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DrawMarkers(TRSPathData,TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draws all of the current element's markers (start, middle, and end) to the canvas along the specified path. The method uses the points of the path to calculate where to draw the markers and in what orientation. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DrawMarkers(TRSPoints,TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draws all of the current element's markers (start, middle, and end) to the canvas at the specified points. The method uses the points to calculate where to draw the markers and in what orientation. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

DrawPath(TRSPathData,TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draws a path shape to the canvas (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

Overloaded. Returns the SVG element located at the specified position in the SVG. The method assumes the size and location of the current element is the rectangle specified by aRect. Use the ElementAtPos method to determine which SVG element is at the specified location in the current element.

If no SVG element is found at the specified location, the function returns nil

Note
The method searches the children first in reverse order and then the current element. This ensures the visually top-most element is found

public method

ElementAtPos(TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

If no SVG element is found at the specified location, the function returns nil

Note
The method searches the children first in reverse order and then the current element. This ensures the visually top-most element is found

protected method

ElementNotification(TObject,TSVGElement,TCollectionNotification)

This method is called when an element is added or removed from the FMX.RS.SVG.TSVGElement.Items property (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

EnableChange

Called when the FMX.RS.SVG.TSVGElement.Enabled property changes (Overrides FMX.RS.SVG.TSVGElement.EnableChange.)

protected method

EndDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

Restores the canvas to its state before the current svg element and its children were drawn (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

EndUpdate

Marks the end of an update session of the element and its children.

The update session must be started first by calling BeginUpdate.

EndUpdate decreases a updating semaphore. If all update sessions end and the semaphore is 0, EndUpdate signals a OnChange event.
(Inherited from FMX.RS.SVG.TSVGElement.)

protected method

FillChildrenTextChunks(TSVGMatrix,TSVGCanvas,TSVGRect,TSVGTextChunks)

Draw the child elements' text chunks to the canvas using FillText calls

protected method

FillPolygons(TSVGMatrix,TSVGCanvas)

Experimental method to use the Clipper library to create properly filled (based on FillRule) and clipped (GetClipPath) polygons (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

FillText(TSVGMatrix,TSVGCanvas,TSVGRect,String,Single,Single,TSVGTextAlign)

Draws the text to the canvas by filling the text (traditional way) versus generating text shapes and drawing those. This method is provided for backwards compatibility with RSCL v1.0 and for the FMX GPU Canvas (which cannot convert text to paths)

public method

FitToRect(TSVGRect)

Overloaded. Returns a transformation matrix that will properly scale and translate the SVG element's BoundsRect so that it fits within the input rectangle (Inherited from FMX.RS.SVG.TSVGElement.)

public method

FitToRect(TSVGRect,TSVGRect)

Overloaded. Returns a transformation matrix that will properly scale and translate the TargetRect so that it fits within the input rectangle (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GenerateChildControls(TControl,TSVGMatrix,TRSRect,TSVGControlElementEvent)

Generates the child controls for the current svg element based on the FMX.RS.SVG.TSVGElement.Items property (Inherited from FMX.RS.SVG.TSVGElement.)

public method

GenerateControls(TControl,TRSRect,TSVGControlElementEvent)

Overloaded. Generates VCL/FMX controls to represent this SVG element and its children. The Parent parameter specifies the parent control for the generated VCL/FMX control.

The FMX control is transformed by a matrix returned from the GetViewMatrix function

public method

GenerateControls(TControl,TSVGMatrix,TRSRect,TSVGControlElementEvent)

Overloaded. Generates VCL/FMX controls to represent this SVG element and its children. The Parent parameter specifies the parent control for the generated VCL/FMX control. (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GenerateMarkers(TControl,TRSPathData,TSVGMatrix,TSVGRect,TSVGControlElementEvent)

Overloaded. Generates the VCL/FMX controls to correctly display all of the current element's markers (start, middle, and end) along the specified path. The method uses the points of the path to calculate where to create the markers and their orientation. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GenerateMarkers(TControl,TRSPoints,TSVGMatrix,TSVGRect,TSVGControlElementEvent)

Overloaded. Generates the VCL/FMX controls to correctly display all of the current element's markers (start, middle, and end) at the specified points. The method uses the points to calculate where to create the markers and their orientation. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

GetAbsoluteOpacity

Returns the opacity of the SVG element modified with its Parents' opacities (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetBaseline(TSVGCustomText,TSVGCanvas,Char,TSVGShapePath)

Returns the baseline of the character based on the element's Font property. The baseline refers to the alignment point for the characters in a string of text. In horizontal writing-modes, the glyphs of a given script are positioned so that a particular point on each glyph, the alignment-point, is aligned with the alignment-points of the other glyphs in that script. The glyphs of different scripts, for example, Western, Northern Indic and Far-Eastern scripts, are typically aligned at different points on the glyph. For example, Western glyphs are aligned on the bottoms of the capital letters, northern indic glyphs are aligned at the top of a horizontal stroke near the top of the glyphs and far-eastern glyphs are aligned either at the bottom or center of the glyph.

All text elements and their children share the same baseline, even if the font or font size change.

protected method

GetBaselineFont(TSVGCanvas)

Returns the font for the calculating baseline points.

All text elements and their children share the same baseline, even if the font or font size change.

protected method

GetBoundsRect

Gets the Bounding Rectangle (in pixels) of the element. This value is the bounding rectangle before any transformations are applied. (Overrides FMX.RS.SVG.TSVGElement.GetBoundsRect.)

public method

GetBoundsRect(TSVGMatrix)

Returns the "true" BoundsRect where the boundaries of the element are modified by the input matrix plus (for graphic elements) its transformation Matrix (Overrides FMX.RS.SVG.TSVGElement.GetBoundsRect(TSVGMatrix).)

protected method

GetBrush

Overloaded. Returns the Brush for the current element modified by any inherited properties (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

GetBrush(TSVGMatrix,TSVGRect)

Overloaded. Returns the Brush for the element, configured for the transformation and rectangle. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

GetClipPath(TSVGCanvas)

Returns the clipping region of the current element based on its shape and its children's shape (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetClipRect

Returns the clipping rectangle for the element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetDecorationPoint(TSVGPoint)

Returns the decoration point, or baseline, for a decoration (i.e., underline, strike-out, or overline). The decoration point depends on the Font and the FMX.RS.SVG.Text.TSVGCustomText.InlineProgressionDirection properties.

protected method

GetDX(Cardinal)

Returns the delta x-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.DX property length, it returns its parent text element's DX property.

protected method

GetDY(Cardinal)

Returns the delta y-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.DY property length, it returns its parent text element's DY property.

protected method

GetFont

Returns the Font for the current element modified by any inherited properties (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetFormatStr

Returns a format string for formatting floating point numbers (Inherited from FMX.RS.SVG.TSVGElement.)

public method

GetGlyphOrientation(Char)

Returns the orientation of the character glyph

protected method

GetGlyphRotationMatrix(Char,Single,TSVGPoint)

Calculates the rotation matrix necessary for rotating the character based on its baseline and rotation angle

protected method

GetGlyphSpacing(Char,TSVGCanvas,TSVGFont)

Returns the spacing to use between this character and the next character. This spacing excludes any extra spacing introduced by the Kerning or LetterSpacing properties.

public method

GetGraphicParent

Returns the closest ancestor SVG element that is a TSVGGraphicElement class (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetHeight

Returns the Height of the Element.

If the Height property is a percentage, this method returns the Height for the Element by calculating the percentage of the nearest ViewBox's Height

protected method

GetHeightRaw

Returns the Height of the Element in raw measurement units (i.e., 1 inch, 2.5 centimeter).

The GetHeight method returns the height in pixels.

public method

GetNearestViewBox

Returns the nearest ancestor (Parent, or Parent of Parent, or etc) element that is a TSVGCustomViewBox element (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GetOptions

Represents method GetOptions. (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GetOwner

Returns the SVG document that owns this element (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GetPen

Overloaded. Returns the Pen for the current element modified by any inherited properties (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

GetPen(TSVGMatrix,TSVGRect)

Overloaded. Returns the Pen for the element, configured for the transformation and rectangle. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetRotate(Cardinal)

Overloaded. Returns the rotation (in degrees) for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Rotate property length, it returns the last rotation item in the Rotate array.

protected method

GetShape

Returns a path that represents the shape of the current svg element.

This method does not work for all svg element types

public method

GetSVGType

Returns the SVG element type of the class (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GetText

Returns the text to draw

protected method

GetTextAlign

Returns the text alignment for the element ( TextAlign ). If the direction of the text is right to left, this method swaps alignment values for start and end.

protected method

GetUnitFactors

Returns unit factors array, which specifies the unit factors for conversion of different units into pixel units. For example, if the input string contains '1cm', the function uses the UnitFactors variable of this type to know how large a centimeter is. (Overrides FMX.RS.SVG.TSVGElement.GetUnitFactors.)

public method

GetViewMatrix(TRect)

Overloaded. Returns a transformation matrix for viewing this element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

GetViewMatrix(TSVGMatrix,TRect)

Overloaded. Returns a transformation matrix for viewing this element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

GetViewMatrix(TSVGMatrix,TSVGRect)

Overloaded. Returns a transformation matrix for viewing this element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

GetViewMatrix(TSVGRect)

Overloaded. Returns a transformation matrix for viewing this element (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

GetWidth

Returns the Width of the Element.

If the Width property is a percentage, this method returns the Width for the Element by calculating the percentage of the nearest ViewBox's Width

protected method

GetWidthRaw

Returns the Width of the Element in raw measurement units (i.e., 1 inch, 2.5 centimeter).

The GetWidth method returns the width in pixels.

protected method

GetWritingMode

Returns the FMX.RS.SVG.TSVGGraphicElement.WritingMode of the element. If the WritingMode is inherited ( FMX.RS.SVG.TSVGGraphicElement.Inherits property), the writing mode of the parent is returned. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

GetX

Overloaded. Returns the X Coordinate of the Element.

If the X property is a percentage, this method returns the X Coordinate for the Element by calculating the percentage of the nearest ViewBox's Width

protected method

GetX(Cardinal)

Overloaded. Returns the x-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.X property length, it returns its parent text element's X property.

protected method

GetXRaw

Returns the X Coordinate of the Element in raw measurement units (i.e., 1 inch, 2.5 centimeter).

The GetX method returns the X coordinate in pixels.

protected method

GetY

Overloaded. Returns the Y Coordinate of the Element.

If the Y property is a percentage, this method returns the Y Coordinate for the Element by calculating the percentage of the nearest ViewBox's Height

protected method

GetY(Cardinal)

Overloaded. Returns the y-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Y property length, it returns its parent text element's Y property.

protected method

GetYRaw

Returns the Y Coordinate of the Element in raw measurement units (i.e., 1 inch, 2.5 centimeter).

The GetY method returns the Y coordinate in pixels.

public method

HasAncestor(TSVGElement)

Returns true if the input element is an ancestor of the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasChild(TSVGElement)

Returns true if the input element is a direct child of the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasDescendant(TSVGElement)

Returns true if the input element is a descendant of the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasExtensions

Returns true if the required extensions are present. The RSCL supports no extensions at this time, if RequiredExtensions is not empty, this method will return False (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasFeatures

Returns true if the Owner document supports all of the features of the element. If all of the given features are supported, then the function evaluates to true; otherwise, the current element and its children are skipped and thus will not be rendered. (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasFollowing(TSVGElement)

Returns true if the input element follows the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasLanguage(String)

Returns True if the Language property matches the language IDs in the input parameter. Multiple languages can be specified by separating the language IDs with commas and/or spaces. (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasLanguages

Returns True if the Owner SVG document fragment supports the Language property or one of the SystemLanguages (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasPreceding(TSVGElement)

Returns true if the input element precedes the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

public method

HasSibling(TSVGElement)

Returns true if the input element is a sibling (share same Parent) of the current SVG element (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

InternalBakeTransformation(TSVGMatrix)

Represents method InternalBakeTransformation(TSVGMatrix). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

InternalDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

The current element is drawn first and then child elements.

protected method

InternalDraw(TSVGMatrix,TSVGCanvas,TSVGRect,TSVGTextChunks)

Overloaded. Draw the text to the canvas by using TCanvas.FillText calls for all the text chunks

protected method

InternalElementAtPos(TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

Returns the SVG element located at the specified position in the SVG. The method assumes the size and location of the current element is the rectangle specified by aRect. Use the ElementAtPos method to determine which SVG element is at the specified location in the current element.

If no SVG element is found at the specified location, the function returns nil.

The DoInternalElementAtPos method does the actual detection for the current element

Note
The method searches the children first in reverse order and then the current element. This ensures the visually top-most element is found

protected method

IsCharClipped(Cardinal)

Returns true if the character is outside of the boundary of the text element. This method really only applies to text on a path element where text can run off the end of the path.

protected method

IsCompactXML

Returns true if the svg XML should be made as small as possible when exporting the svg element as XML (Inherited from FMX.RS.SVG.TSVGElement.)

public method

IsEnabled

Returns true if the current element and every parent, grandparent, etc are FMX.RS.SVG.TSVGElement.Enabled. (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

IsFillingText

Returns true if the text element should fill text instead of creating text paths

protected method

IsStored(TSVGStyleProperty,String)

Returns True if the style property should be stored when streaming (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

IsXSpecified(Cardinal)

Returns true if there is an x-axis value specified for the character at the index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.X property length, it checks its parent text element's X property.

protected method

IsYSpecified(Cardinal)

Returns true if there is an y-axis value specified for the character at the index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Y property length, it checks its parent text element's Y property.

protected method

LengthGetInherited(TSVGStylePropertyLength,Boolean)

Event handler for FMX.RS.SVGTypes.TSVGStylePropertyLength objects.

TSVGStylePropertyLength objects use this event handler to get the inherited value for a style property.

protected method

LengthParent(TSVGStylePropertyLength,TSVGStylePropertyLength)

Event handler for FMX.RS.SVGTypes.TSVGStylePropertyLength objects.

TSVGStylePropertyLength objects use this event handler to get the inherited value for a style property.

protected method

LengthRangeViewBoxHeight(TSVGLength,Single,Single,Boolean)

Event handler for FMX.RS.SVGTypes.TSVGLength objects.

TSVGLength objects use this event handler to figure out the correct conversion of a percentage value to pixels. This event handler is use for the TSVGLength.OnRange event and uses the nearest viewbox's height to set the Min and Max parameters.

protected method

LengthRangeViewBoxWidth(TSVGLength,Single,Single,Boolean)

Event handler for FMX.RS.SVGTypes.TSVGLength objects.

protected method

LengthSetInherited(TSVGStylePropertyLength,Boolean)

Event handler for FMX.RS.SVGTypes.TSVGStylePropertyLength objects.

TSVGStylePropertyLength objects use this event handler to retrieve the inherited length for a style property.

public method

LoadFromXML(IXMLNode)

Loads the SVG element's attributes and child nodes from the XML node (Overrides FMX.RS.SVG.TSVGElement.LoadFromXML(IXMLNode).)

protected method

MarkersAtPos(TRSPathData,TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

Overloaded. Returns the SVG element of a marker that would be located at the specified position in the SVG. The method assumes the size and location of the current element is the rectangle specified by aRect. The method uses the MarkerStartURI, MarkerMidURI, and MarkerEndURI property to find the markers that would be displayed along the specified path. Then, it finds the element of the marker at that specified position

If no SVG element of a marker is found (or there are no markers) at the specified location, the function returns nil.

protected method

MarkersAtPos(TRSPoints,TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

If no SVG element of a marker is found (or there are no markers) at the specified location, the function returns nil.

public method

Matches(String)

Returns the specificity (>=0) of the match with the selector string or -1 if there is no match.

A selector's specificity is calculated as follows:

• Count the number of ID selectors in the selector (= a)

• Count the number of class selectors, attributes selectors, and pseudo-classes in the selector (= b)

• Count the number of type selectors and pseudo-elements in the selector (= c)

• Ignore the universal selector

• Selectors inside the negation pseudo-class are counted like any other, but the negation itself does not count as a pseudo-class.

Concatenating the three numbers a-b-c (in a number system with a large base) gives the specificity.

public method

MeasureText(TSVGCanvas)

public method

NextTextPosition(TSVGPoint,TSVGPoint,Char,Boolean,Single)

Returns the position of the next character in the text based on last character's position, the char, Kerning, and spacing rules (either LetterSpacing or WordSpacing )

protected method

NotifyListener(TSVGElement)

The NotifyListener method is called when aElement has changed or is being destroyed (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

NotifyListeners

Notifies all listeners that the current element has changed or is being destroyed (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

ObjectPropChange(TObject)

Called when a property that is an object changes. This method does NOT propagate the change to all children. Use this method when children do not need to be notified to recalculate anything (like changing TSVGPreserveAspectRatio) Calls the FMX.RS.SVG.TSVGElement.Change(TSVGElement) method (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

PathAtPos(TSVGMatrix,TSVGCanvas,TSVGPoint,TSVGRect,TSVGShapePath,TSVGFindOptions)

Returns Self if the specified path contains the specified point. The method assumes the size and location of the current element is the rectangle specified by aRect. Use the PathAtPos method to determine if the current SVG element described by the path shape is at the specified location.

If the path does not contain the point, the function returns nil.

protected method

PerformClipping(TSVGMatrix,TSVGCanvas,TSVGRect)

Sets up the clipping region for the Canvas based on the clipping information for the current svg element.

Warning
FMX does not support clipping regions so this method does nothing (nor is clipping performed). However, there is an experimental clipping that can be performed using the Clipper library. Put the clipper.pas in your path and uncomment the {$DEFINE FMX_CLIPPING} statement in RSSVG.pas

protected method

PropagateObjectPropChange(TObject)

Called when a property that is an object (Brush, Pen, Font, Description, etc) changes. This method propagates the change to all children so that they know they need to recalculate stuff. Calls the FMX.RS.SVG.TSVGElement.Change(TSVGElement) method (Overrides FMX.RS.SVG.TSVGGraphicElement.PropagateObjectPropChange(TObject).)

protected method

ReadChild(IXMLNode)

Reads the specified node and sets properties on the current TSVGGraphicElement. This method is meant to read child nodes that do not represent TSVGGraphicElements in the svg hierarchy. For example, it can read a child node that represents the Description property of the current svg element. (Overrides FMX.RS.SVG.TSVGGraphicElement.ReadChild(IXMLNode).)

protected method

ReadChildren(IXMLNode)

Reads the child XML nodes of the specified node and loads them into the svg element as children (Items property) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

ReadItems(TReader)

Represents method ReadItems(TReader). (Inherited from FMX.RS.SVG.TSVGElement.)

public method

RemoveChangeNotification(TSVGElement)

Disables the change notification that was enabled by FMX.RS.SVG.TSVGElement.ChangeNotification(TSVGElement) .

RemoveChangeNotification removes the element specified by the aListener parameter from the internal list of elements to be notified that an element has changed. aListener is added to this list by a previous call to the ChangeNotification method.

Most applications have no need to call RemoveChangeNotification. It is used by TSVGElement to inform other elements when they have been changed or are going to be destroyed. For example, the TSVGUse element uses this mechanism to know when to redraw because its Reference element has changed
(Inherited from FMX.RS.SVG.TSVGElement.)

public method

Reset

Resets the SVG for drawing. This means setting up the svg element to rebuild its Brush, Pen, Font, Shape, etc (Overrides FMX.RS.SVG.TSVGGraphicElement.Reset.)

protected method

ResourceGetInherited(TObject,TSVGStyleProperty,Boolean)

Represents method ResourceGetInherited(TObject,TSVGStyleProperty,Boolean). (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SaveColorStyleProperty(IXMLNode,TSVGStyleProperty,TSVGBrushKind,TSVGColor,String)

Saves a Color property to the XML node as an attribute. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

public method

SaveToXML(IXMLNode)

Saves the SVG element's attributes and children to the XML node

Note
The IXMLNode must already exist and be set to the correct NodeType

public method

ScreenToLocal(TSVGPoint,TSVGRect)

Represents method ScreenToLocal(TSVGPoint,TSVGRect). (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

SetBoundsRect(TSVGRect)

Sets the Bounding rectangle of the current element to the value. The value is assumed to be in pixels (Overrides FMX.RS.SVG.TSVGElement.SetBoundsRect(TSVGRect).)

protected method

SetCanvasPen(TSVGCanvas,TSVGMatrix,Boolean)

Initializes the Canvas with a Pen that contains the correct defined and inherited properties and optionally scaled Thickness according to the Matrix. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetHeight(Single)

Sets the height, in pixels, of the element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetHeightU(TSVGLength)

Sets the Height of the element as a length (with Raw value and Unit) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetParent(TSVGElement)

Changes the parent SVG Element of the current element. The FMX.RS.SVG.TSVGElement.Parent and Items properties define the hierarchy of a SVG document fragment. (Overrides FMX.RS.SVG.TSVGElement.SetParent(TSVGElement).)

protected method

SetText(String)

Sets the Text property

protected method

SetWidth(Single)

Sets the Width, in pixels, of the element (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetWidthU(TSVGLength)

Sets the Width of the element as a length (with Raw value and Unit) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetX(Single)

Overloaded. Sets the X coordinate, in pixels, of the element (Overrides FMX.RS.SVG.TSVGGraphicElement.SetX(Single).)

protected method

SetX(TSVGLengths)

Overloaded. Sets the FMX.RS.SVG.Text.TSVGCustomText.X Array property to a copy of the value arrray.

Note
This is a deep copy. Every item in the value array is cloned.

protected method

SetXu(TSVGLength)

Sets the X coordinate of the element as a length (with Raw value and Unit) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

SetY(Single)

Overloaded. Sets the Y coordinate, in pixels, of the element (Overrides FMX.RS.SVG.TSVGGraphicElement.SetY(Single).)

protected method

SetY(TSVGLengths)

Overloaded. Sets the FMX.RS.SVG.Text.TSVGCustomText.Y Array property to a copy of the value arrray.

Note
This is a deep copy. Every item in the value array is cloned.

protected method

SetYu(TSVGLength)

Sets the Y coordinate of the element as a length (with Raw value and Unit) (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

ShouldDraw

Returns true if the svg element should be drawn directly when the Draw method is called. Most TSVGGraphicElement descendants return true if they are visible and FMX.RS.SVG.TSVGElement.HasFeatures and FMX.RS.SVG.TSVGElement.HasExtensions and FMX.RS.SVG.TSVGElement.HasLanguages. However, elements inside a defs (TSVGDefs class), gradients, symbols, markers are not drawn directly but only when called from a referring element. (Inherited from FMX.RS.SVG.TSVGElement.)

public method

ShouldDrawTextAllAtOnce

Returns true if the text drawing can be optimized and all text can be drawn at once.

Text can be drawn as one unit if there are not multiple X, Y coordinates, or DX, DY changes, and no individual character rotations. Also, the text needs to be left-to-right or right-to-left and the characters need to be facing perpendicular to the text direction (up with Western alphabets).

public method Class member

SVGType

Returns the SVG element type of the class (Inherited from FMX.RS.SVG.TSVGElement.)

public method Class member

SVGTypeName

Returns the SVG element type name (e.g., 'g', 'rect', etc) (Inherited from FMX.RS.SVG.TSVGElement.)

public method

ToString

Returns an XML/SVG representation of the element, including its children (Inherited from FMX.RS.SVG.TSVGElement.)

protected method

UnitFactorsHandler(TObject,TSVGUnitFactors)

Event handler for returning the UnitFactors of the owner or the SVGUnitFactors constant if Owner is nil.

This event handler is used by TSVGLength class and its descendants to convert raw unit measurements (i.e., inch, centimeter, etc) to pixels

protected method

WriteChildren(IXMLNode)

Writes the children (Items property) of the current TSVGGraphicElement as child nodes of the specified node (Inherited from FMX.RS.SVG.TSVGGraphicElement.)

protected method

WriteItems(TWriter)

Represents method WriteItems(TWriter). (Inherited from FMX.RS.SVG.TSVGElement.)

Top

	Name	Description
	ControlConstructor	Represents field ControlConstructor. (Inherited from FMX.RS.SVG.TSVGElement.)
	FAttributes	Represents field FAttributes. (Inherited from FMX.RS.SVG.TSVGElement.)
	FDX	Dynamic array for delta x in the current coordinate system. It represents hifts in the current text position along the x-axis for the characters within this element or any of its descendants.
	FDY	Dynamic array for delta y in the current coordinate system. It represents hifts in the current text position along the y-axis for the characters within this element or any of its descendants.
	FElementState	Represents field FElementState. (Inherited from FMX.RS.SVG.TSVGElement.)
	FHeight	Represents field FHeight. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)
	FRotate	Dynamic Rotation array (in degrees) for characters in a text element. If the length of the Rotate array is less than the text element, the characters after the end use the last element in the array.
	FShape	Represents field FShape. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)
	FWidth	Represents field FWidth. (Inherited from FMX.RS.SVG.TSVGGraphicElement.)
	FX	Dynamic absolute position array for x in the current coordinate system. If the array length is less than the length of the text, the extra characters are appended normally to the end of the text. If a single <coordinate> is provided, then the value represents the new absolute X coordinate for the current text position for rendering the glyphs that correspond to the first character within this element or any of its descendants. If a list of n <coordinate>s is provided, then the values represent new absolute X coordinates for the current text position for rendering the glyphs corresponding to each of the first n characters within this element or any of its descendants.
	FY	Dynamic absolute position array for y in the current coordinate system. If the array length is less than the length of the text, the extra characters are appended normally to the end of the text. If a single <coordinate> is provided, then the value represents the new absolute X coordinate for the current text position for rendering the glyphs that correspond to the first character within this element or any of its descendants. If a list of n <coordinate>s is provided, then the values represent new absolute X coordinates for the current text position for rendering the glyphs corresponding to each of the first n characters within this element or any of its descendants.

Top