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.SVGCtrls > Classes

TRSSVGThreadImage Class

TRSSVGThreadImage displays a graphical image of a SVG. The control ensures that the image is always of the highest resolution by redrawing the SVG when the control is rescaled.

Use TRSSVGThreadImage to display a graphical image of a SVG on a form. Use the Filename or Lines properties to control which SVG is displayed in the image. TRSSVGThreadImage introduces several properties to determine how the SVG is displayed within the boundaries of the TRSSVGThreadImage object.

Namespace: FMX.RS.SVGCtrls

Name

Description

published property

Align

Represents property Align.

published property

Anchors

Represents property Anchors.

public property

Bitmap

Represents property Bitmap.

published property

ClipChildren

Represents property ClipChildren.

published property

ClipParent

Represents property ClipParent.

published property

Cursor

Represents property Cursor.

published property

CursorTracking

Represents property CursorTracking.

published property

DefaultAspectRatio

Defines the default aspect ratio for the SVG. If the SVG does not specify a preserveAspectRatio attribute, the SVG will use this default instead.

protected property

DefaultCursor

Represents property DefaultCursor.

published property

DesignVisible

Represents property DesignVisible.

published property

DisableInterpolation

Enables or disables the interpolation of the SVG bitmap displayed by this TRSSVGThreadImage component.

The DisableInterpolation property specifies whether the interpolation is used while rendering the SVG bitmap onto the canvas displayed by this TRSSVGThreadImage component. By default, DisableInterpolation is set to False.

published property

DPI

Dots per inch used in calculating the unit factors for conversion of string lengths into actual values. The DPI should be set before loading a SVG.

For example, if the input string contains '1cm', the DPI helps the SVG library figure out how large a centimeter is.

published property

DragMode

Represents property DragMode.

published property

Enabled

Represents property Enabled.

published property

EnableDragHighlight

Represents property EnableDragHighlight.

published property

Filename

Defines the filename of the SVG document to load

published property

FindOptions

Specifies how the control determines which svg element is at the mouse cursor

published property

Height

Represents property Height.

published property

HitTest

Represents property HitTest.

published property

Lines

Defines the text of a SVG to load. The Lines property is useful for when you don't want to load a SVG from a file with the Filename property.

published property

Locked

Represents property Locked.

published property

Margins

Represents property Margins.

published property

MarginWrapMode

Specifies how the margins of the SVG are resized, replicated, and positioned.

Use MarginWrapMode property to set and get how the margins of the SVG are displayed within the TRSSVGThreadImage. By default the margins are stretched to fill the entire TRSSVGThreadImage.

If SVGMargins property is not set, then MarginWrapMode has no effect over the image.

published property

OnClick

Represents property OnClick.

published property

OnDblClick

Represents property OnDblClick.

published property

OnDragDrop

Represents property OnDragDrop.

published property

OnDragEnd

Represents property OnDragEnd.

published property

OnDragEnter

Represents property OnDragEnter.

published property

OnDragLeave

Represents property OnDragLeave.

published property

OnDragOver

Represents property OnDragOver.

published property

OnMouseDown

Represents property OnMouseDown.

published property

OnMouseEnter

Represents property OnMouseEnter.

published property

OnMouseLeave

Represents property OnMouseLeave.

published property

OnMouseMove

Represents property OnMouseMove.

published property

OnMouseUp

Represents property OnMouseUp.

published property

OnMouseWheel

Represents property OnMouseWheel.

published property

OnPaint

Represents property OnPaint.

published property

OnPainting

Represents property OnPainting.

published property

OnResize

Represents property OnResize.

published property

Opacity

Represents property Opacity.

published property

Options

Defines options for reading, displaying, and writing the document

published property

Padding

Represents property Padding.

published property

PopupMenu

Represents property PopupMenu.

published property

Position

Represents property Position.

published property

Quality

Controls the quality of the Buffered painting of the SVG image. The value of quality can vary between 1 (low quality) to 8 (very high quality).

note Note

This property controls the amount of oversampling performed in the buffered drawing. The offscreen buffers' dimensions are multiplied by the Quality value. Then, the offscreen buffers are downsampled when painting the control, providing anti-aliasing of the buffered drawing.
This property is intended for mobile applications. The quality on desktop FMX applications is already high and requires no extra memory.

Warning
Occasionally, oversampling can cause different output compared to the unbuffered output. The extra size of the buffers requires more triangles to output gradients and other elements. If this exceeds Embarcadero's limits, the element is not drawn.

published property

RotationAngle

Represents property RotationAngle.

published property

RotationCenter

Represents property RotationCenter.

published property

Scale

Represents property Scale.

published property

ScaleOriginal

Specifies the scale factor for drawing the SVG.

Use the ScaleOriginal property to scale the SVG larger or smaller within the TRSSVGThreadImage component. This is useful for controlling the tiling the SVG or zooming in or out of the SVG

protected property

SVG

Represents property SVG.

published property

SVGMargins

Specifies the margins of the SVG displayed by this TRSSVGThreadImage component.

Set or read the SVGMargins property in order to affect the margins of the SVG that is displayed by this TRSSVGThreadImage component

published property

SVGRootID

Specifies which node of the SVGDocument to draw as the top- level SVG document.

Use the SVGRootID property to display only a portion of the SVG Document .

protected property

Thread

Represents property Thread.

published property

Visible

Represents property Visible.

published property

Width

Represents property Width.

published property

WrapMode

Specifies whether and how to resize, replicate, and position the SVG image for rendering the TRSSVGThreadImage surface.

The WrapMode property should be one of the constants defined in the TSVGImageWrapMode type:

iwOriginal-- displays the SVG with its original dimensions.

iwFit-- best fit (keeping SVG proportions--the ratio between the width and height) for the TRSSVGThreadImage rectangle. Default.

iwStretch--stretches the SVG to fill the entire rectangle of this TRSSVGThreadImage component.

iwTile--tiles the TRSSVGThreadImage image to cover the entire rectangle of the TRSSVGThreadImage component.

iwCenter-- center the SVG inside the TRSSVGThreadImage component

Top

	Name	Description
	ClearPendingJobs(TSVGServerJob)	Represents method ClearPendingJobs(TSVGServerJob).
	CreateServerThread	Represents method CreateServerThread.
	DisplayPropertyChange	Represents method DisplayPropertyChange.
	DoElementClick(TSVGPoint)	Represents method DoElementClick(TSVGPoint).
	GetBitmap	Represents method GetBitmap.
	JobComplete(TObject)	Represents method JobComplete(TObject).
	LoadSVG	Represents method LoadSVG.
	MouseMove(TShiftState,Single,Single)	Represents method MouseMove(TShiftState,Single,Single).
	MouseUp(TMouseButton,TShiftState,Single,Single)	Represents method MouseUp(TMouseButton,TShiftState,Single,Single).
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Paint	Represents method Paint.
	Resize	Represents method Resize.
	SetCursorFromSVG(TSVGPoint)	Represents method SetCursorFromSVG(TSVGPoint).
	UpdateBitmap	Represents method UpdateBitmap.

Top

Name

Description

published event

OnClickElement

Occurs when the clicks the mouse in the control. The Element parameter specifies the element that was under the mouse cursor, or nil if no element was under the mouse.

The FMX.RS.SVGCtrls.TRSSVGThreadImage.FindOptions property specifies how the control determines which svg element is under the mouse cursor.

Top

Important Note
The TRSSVGThreadImage is very dependant on the thread-safety of the implementation of TBitmap/TCanvas. Unlike the VCL, there are known issues with TBitmap thread safety (at least as of XE5), even on Windows (DirectX2D implementation compared to GDI+ implementation). It is not recommended to use TRSSVGThreadImage in FMX - use TRSSVGImage and TRSSVGDocument instead.

Tip
The TRSSVGThreadImage always loads and draws the SVG image in a background thread. As such, it cannot share a TRSSVGDocument and must contain its own SVG. If you want or can share SVG documents amongst multiple image components (and don't mind using the GUI main thread), you may want to use the TRSSVGImage component.

Warning
If the SVGRootID property is not empty, the ID must exist in the SVG document or nothing is displayed.

Important Note
On non-Windows systems, the TRSSVGThreadImage loads the SVG in the main thread and only does the painting in the background thread. This is because the ADOM XML parser, which is used on non-Windows system, crashes when used in background threads.

To load and draw a SVG at run-time, create the SVG document and the SVG Image:

Delphi
SVGImage := TRSSVGThreadImage.Create(Self); SVGImage.Parent := Self; SVGImage.Filename := 'c:\MySVG.svg';

RiverSoftAVG Products Help

Reference