<< Click here to display Table of Contents >> Navigation: Code Documentation > RSFMXSVG > FMX.RS.SVGCtrls > Classes:

TRSSVGImage Class

Contents

Comments (0)

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

Use TRSSVGImage to display a graphical image of a SVG on a form. Use the SVGDocument and SVGRootID properties to control which SVG is displayed in the image. TRSSVGImage introduces several properties to determine how the SVG is displayed within the boundaries of the TRSSVGImage object.

Namespace: FMX.RS.SVGCtrls

TControl
FMX.RS.SVGCtrls.TRSSVGImage

Delphi

type
TRSSVGImage = class(TControl, ISVGViewer)
end;

	Name	Description
	Create(TComponent)	Initializes a new instance of the TRSSVGImage class.
	Destroy	Represents the destructor of the TRSSVGImage class.

Top

	Name	Description
	Align	Represents property Align.
	Anchors	Represents property Anchors.
	Bitmap	Represents property Bitmap.
	Buffered	Specifies whether to draw the SVG to a backbuffer and then copy that image to the canvas (default) or to draw directly on the canvas Set the Buffered property to false to draw directly on the image canvas. This is generally not recommended, however, it may look better on mobile devices
	ClipChildren	Represents property ClipChildren.
	ClipParent	Represents property ClipParent.
	Cursor	Represents property Cursor.
	DesignVisible	Represents property DesignVisible.
	DisableInterpolation	Enables or disables the interpolation of the SVG bitmap displayed by this TRSSVGImage component. The DisableInterpolation property specifies whether the interpolation is used while rendering the SVG bitmap onto the canvas displayed by this TRSSVGImage component. By default, DisableInterpolation is set to False.
	DragMode	Represents property DragMode.
	Enabled	Represents property Enabled.
	EnableDragHighlight	Represents property EnableDragHighlight.
	Height	Represents property Height.
	HitTest	Represents property HitTest.
	Locked	Represents property Locked.
	Margins	Represents property Margins.
	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 TRSSVGImage. By default the margins are stretched to fill the entire TRSSVGImage. If SVGMargins property is not set, then MarginWrapMode has no effect over the image.
	OnClick	Represents property OnClick.
	OnDblClick	Represents property OnDblClick.
	OnDragDrop	Represents property OnDragDrop.
	OnDragEnd	Represents property OnDragEnd.
	OnDragEnter	Represents property OnDragEnter.
	OnDragLeave	Represents property OnDragLeave.
	OnDragOver	Represents property OnDragOver.
	OnMouseDown	Represents property OnMouseDown.
	OnMouseEnter	Represents property OnMouseEnter.
	OnMouseLeave	Represents property OnMouseLeave.
	OnMouseMove	Represents property OnMouseMove.
	OnMouseUp	Represents property OnMouseUp.
	OnMouseWheel	Represents property OnMouseWheel.
	OnPaint	Represents property OnPaint.
	OnPainting	Represents property OnPainting.
	OnResize	Represents property OnResize.
	Opacity	Represents property Opacity.
	Padding	Represents property Padding.
	PopupMenu	Represents property PopupMenu.
	Position	Represents property Position.
	RotationAngle	Represents property RotationAngle.
	RotationCenter	Represents property RotationCenter.
	Scale	Represents property Scale.
	ScaleOriginal	Specifies the scale factor for drawing the SVG. Use the ScaleOriginal property to scale the SVG larger or smaller within the TRSSVGImage component. This is useful for controlling the tiling the SVG or zooming in or out of the SVG
	SVGDocument	Specifies the SVG document to display in the control. The SVGDocument and SVGRootID properties control exactly which SVG document and which branch of the SVG document hierarchy to display.
	SVGMargins	Specifies the margins of the SVG displayed by this TRSSVGImage component. Set or read the SVGMargins property in order to affect the margins of the SVG that is displayed by this TRSSVGImage component
	SVGRoot	Represents property SVGRoot.
	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 SVGDocument .
	Visible	Represents property Visible.
	Width	Represents property Width.
	WrapMode	Specifies whether and how to resize, replicate, and position the SVG image for rendering the TRSSVGImage 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 TRSSVGImage rectangle. Default. iwStretch--stretches the SVG to fill the entire rectangle of this TRSSVGImage component. iwTile--tiles the TRSSVGImage image to cover the entire rectangle of the TRSSVGImage component. iwCenter-- center the SVG inside the TRSSVGImage component

Top

	Name	Description
	DoSVGChanged(TObject)	Represents method DoSVGChanged(TObject).
	GetBitmap	Represents method GetBitmap.
	GetSVGRoot	Represents method GetSVGRoot.
	IsBuffered	Returns True if the SVG should be drawn to a offscreen bitmap
	Notification(TComponent,TOperation)	Represents method Notification(TComponent,TOperation).
	Paint	Represents method Paint.
	Resize	Represents method Resize.
	UpdateBitmap	Represents method UpdateBitmap.

Top

Tip
By default, TRSSVGImage draws the SVG to a offscreen bitmap and then draws that bitmap to the control's canvas as needed. This is recommended as it is faster. However, on mobile devices, you may see some aliasing. If you set the Buffered property to false, the TRSSVGImage class will draw the SVG directly to the control's canvas which will reduce aliasing.

Tip
The TRSSVGImage always loads and draws the SVG image from the TRSFmxSVGDocument in the context of the main GUI thread. For more complex SVG documents, you may want to use the TRSSVGThreadImage control to load and draw a SVG within a background thread.

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

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

Delphi

SVGDoc := TRSFmxSVGDocument.Create(Self);
SVGDoc.Filename := 'c:\MySVG.svg';
SVGImage := TRSSVGImage.Create(Self);
SVGImage.Parent := Self;
SVGImage.SVGDocument := SVGDoc;

At design-time, you would:

•	Drop an SVG document component on your form ( RSSVGCtrls\|TRSSVGDocument for VCL, TRSFMXSVGDocument for FMX)

•	Set the TRS[FMX]SVGDocument.Filename property to the SVG file. Alternatively, you can directly paste the SVG into the Lines property (warning: Delphi's TStrings editor will truncate long lines causing problems with some SVG text)

•	Drop a TRSSVGImage component on the form

•	Connect the TRSSVGImage.SVGDocument to the RSSVGDocument1 (VCL) or RSFMXSVGDocument1 (FMX)

•	Optionally, if you only want to display one branch of the SVG document, you can set the TRSSVGImage.SVGRoot property to the SVG element you want to display. If the SVGRoot is not empty and it does not equal any SVG element in the document, nothing is displayed.

Reference

•	FMX.RS.SVGCtrls.TRSFmxSVGDocument

•	FMX.RS.SVGCtrls.TRSSVGThreadImage

•	FMX.RS.SVGCtrls

Comments (0)