RiverSoftAVG Products Help

ApplyStyle(TSVGStyle)

Applies the input style to the SVG element

ApplyStyles

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

AssignProperties(TPersistent)

Copies the properties of source to the current element (but not children) (Overrides RSSVG.TSVGElement.AssignProperties(TPersistent).)

AssignTo(TPersistent)

Represents method AssignTo(TPersistent). (Overrides RSSVG.TSVGElement.AssignTo(TPersistent).)

BakeTransformation(TSVGMatrix)

Represents method BakeTransformation(TSVGMatrix).

BakeTransformationChildren(TSVGMatrix)

Represents method BakeTransformationChildren(TSVGMatrix).

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.

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

Change(TSVGElement)

Called when any property of the element changes (Overrides RSSVG.TSVGElement.Change(TSVGElement).)

Clear

Clears the SVG element and resets its properties back to their defaults (Overrides RSSVG.TSVGElement.Clear.)

CreateStylePropertyAutoLength(TSVGStyleProperty,TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a RSSVGTypes.TSVGStylePropertyAutoLength object and initialize it

CreateStylePropertyLength(TSVGStylePropertyLengthClass,TSVGStyleProperty,TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a RSSVGTypes.TSVGStylePropertyLength object and initialize it

DefineProperties(TFiler)

Represents method DefineProperties(TFiler). (Overrides RSSVG.TSVGElement.DefineProperties(TFiler).)

DisableAppearance(TSVGMatrix,TSVGCanvas,TSVGRect)

Changes the canvas fill and stroke values for disabled elements (Enabled = False)

DoBakeTransformation(TSVGMatrix)

Represents method DoBakeTransformation(TSVGMatrix).

DoDisableAppearance(TObject,TSVGMatrix,TSVGCanvas,TSVGRect)

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

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

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.

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.

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.

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.

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.

DoModifyControl(TControl,TSVGMatrix,TRectF,TSVGControlElementEvent)

Represents method DoModifyControl(TControl,TSVGMatrix,TRectF,TSVGControlElementEvent).

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.

DoShouldDraw

Represents method DoShouldDraw. (Overrides RSSVG.TSVGElement.DoShouldDraw.)

Draw(TSVGCanvas,TSVGRect)

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

Draw(TSVGMatrix,TCanvas,TRect)

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.

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.

DrawChildren(TSVGMatrix,TSVGCanvas,TSVGRect)

Draws all of the current element's children to the canvas

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.

DrawElementParent(TSVGMatrix,TSVGCanvas,TSVGRect)

Sets up parent transformation and clipping so that current element can draw itself properly

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.

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.

DrawPath(TRSPathData,TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draws a path shape to the canvas

DrawPath(TSVGShapePath,TSVGMatrix,TSVGCanvas,TSVGRect)

Overloaded. Draws a path shape to the canvas

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

ElementAtPos(TSVGMatrix,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

EnableChange

Called when the RSSVG.TSVGElement.Enabled property changes (Overrides RSSVG.TSVGElement.EnableChange.)

EndDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

Restores the canvas to its state before the current svg element and its children were drawn

FillPolygons(TSVGMatrix,TSVGCanvas)

Experimental method to use the Clipper library to create properly filled (based on FillRule) and clipped (GetClipPath) polygons

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.

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.

GetAbsoluteOpacity

Returns the opacity of the SVG element modified with its Parents' opacities

GetBoundsRect

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

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 RSSVG.TSVGElement.GetBoundsRect(TSVGMatrix).)

GetBrush

Overloaded. Returns the Brush for the current element modified by any inherited properties

GetBrush(TSVGMatrix,TSVGRect)

Overloaded. Returns the Brush for the element, configured for the transformation and rectangle.

GetClipPath(TSVGCanvas)

Returns the clipping region of the current element based on its shape and its children's shape

GetClipRect

Returns the clipping rectangle for the element

GetCompositingQuality(TSVGColorRendering,TSVGColorInterpolation)

Represents method GetCompositingQuality(TSVGColorRendering,TSVGColorInterpolation).

GetFont

Returns the Font for the current element modified by any inherited properties

GetGraphicParent

Returns the closest ancestor SVG element that is a TSVGGraphicElement class

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

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.

GetPen

Overloaded. Returns the Pen for the current element modified by any inherited properties

GetPen(TSVGMatrix,TSVGRect)

Overloaded. Returns the Pen for the element, configured for the transformation and rectangle.

GetShape

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

This method does not work for all svg element types

GetSmoothingMode(TSVGShapeRendering)

Represents method GetSmoothingMode(TSVGShapeRendering).

GetTextRenderingHint(TSVGTextRendering)

Represents method GetTextRenderingHint(TSVGTextRendering).

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 RSSVG.TSVGElement.GetUnitFactors.)

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

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.

GetWritingMode

Returns the RSSVG.TSVGGraphicElement.WritingMode of the element. If the WritingMode is inherited ( RSSVG.TSVGGraphicElement.Inherits property), the writing mode of the parent is returned.

GetX

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

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.

GetY

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

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.

InternalBakeTransformation(TSVGMatrix)

Represents method InternalBakeTransformation(TSVGMatrix).

InternalDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

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.

The current element is drawn first and then child elements.

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

IsStored(TSVGStyleProperty,String)

Returns True if the style property should be stored when streaming

LengthGetInherited(TSVGStylePropertyLength,Boolean)

Event handler for RSSVGTypes.TSVGStylePropertyLength objects.

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

LengthParent(TSVGStylePropertyLength,TSVGStylePropertyLength)

Event handler for RSSVGTypes.TSVGStylePropertyLength objects.

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

LengthRangeViewBoxHeight(TSVGLength,Single,Single,Boolean)

Event handler for RSSVGTypes.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.

LengthRangeViewBoxWidth(TSVGLength,Single,Single,Boolean)

Event handler for RSSVGTypes.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 width to set the Min and Max parameters.

LengthSetInherited(TSVGStylePropertyLength,Boolean)

Event handler for RSSVGTypes.TSVGStylePropertyLength objects.

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

LoadFromXML(IXMLNode)

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

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.

MarkersAtPos(TRSPoints,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.

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.