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 > RSVclSVG > RSSVGCtrls > Classes

TRSSVGImage Class

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.

Tip
With the VCL, the TRSSVGImage class can flicker. Use the RSSVGCtrls.TRSSVGScreen control to display an SVG with reduced flicker.

Namespace: RSSVGCtrls

Name

Description

public property

AbsoluteMatrix

Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices.

published property

Align

Represents property Align.

published property

Anchors

Represents property Anchors.

published property

AutoSize

Represents property AutoSize.

public property

Bitmap

Represents property Bitmap.

published property

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

published property

Constraints

Represents property Constraints.

published property

Cursor

Represents property Cursor.

published property

CursorTracking

Represents property CursorTracking.

protected property

DefaultCursor

Represents property DefaultCursor.

published property

DragCursor

Represents property DragCursor.

published property

DragKind

Represents property DragKind.

published property

DragMode

Represents property DragMode.

published property

Enabled

Represents property Enabled.

published property

FindOptions

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

public property

Matrix

Returns the transformation matrix of the control

protected property

NeedBitmapUpdate

Represents property NeedBitmapUpdate.

published property

OnClick

Represents property OnClick.

published property

OnContextPopup

Represents property OnContextPopup.

published property

OnDblClick

Represents property OnDblClick.

published property

OnDragDrop

Represents property OnDragDrop.

published property

OnDragOver

Represents property OnDragOver.

published property

OnEndDock

Represents property OnEndDock.

published property

OnEndDrag

Represents property OnEndDrag.

published property

OnGesture

Represents property OnGesture.

published property

OnMouseActivate

Represents property OnMouseActivate.

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

OnPaint

Represents property OnPaint.

published property

OnPainting

Represents property OnPainting.

published property

OnStartDock

Represents property OnStartDock.

published property

OnStartDrag

Represents property OnStartDrag.

published property

Opacity

Specifies the opacity or transparency of the SVG image. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.

published property

ParentShowHint

Represents property ParentShowHint.

published property

PopupMenu

Represents property PopupMenu.

published property

Quality

Controls the quality of the RSSVGCtrls.TRSSVGImage.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

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

published property

ShowHint

Represents property ShowHint.

published property

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.

protected property

SVGRoot

Represents property SVGRoot.

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 SVGDocument .

published property

Touch

Represents property Touch.

published property

Transform

Specifies the overall transformation to apply to the SVG image. For no transformation, set the Matrix to the RSIdentityMatrix

published property

Visible

Represents property Visible.

published property

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
	DoElementClick(TSVGPoint)	Represents method DoElementClick(TSVGPoint).
	DoPaint	Represents method DoPaint.
	DoSVGChanged(TObject)	Represents method DoSVGChanged(TObject).
	GetAbsoluteMatrix	Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices.
	GetMatrix	Returns the transformation matrix of the control
	GetOpacity	Returns the Opacity of the control
	GetShapeRect(TObject,TRSRect)	Represents method GetShapeRect(TObject,TRSRect).
	GetSVGRoot	Represents method GetSVGRoot.
	IsBuffered	Returns True if the SVG should be drawn to a offscreen bitmap
	MouseMove(TShiftState,Integer,Integer)	Represents method MouseMove(TShiftState,Integer,Integer).
	MouseUp(TMouseButton,TShiftState,Integer,Integer)	Represents method MouseUp(TMouseButton,TShiftState,Integer,Integer).
	Notification(TComponent,TOperation)	Represents method Notification(TComponent,TOperation).
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Resize	Represents method Resize.
	SetCursorFromSVG(TSVGPoint)	Represents method SetCursorFromSVG(TSVGPoint).
	SetOpacity(Single)	Sets the opacity of the control. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.
	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 RSSVGCtrls.TRSSVGImage.FindOptions property specifies how the control determines which svg element is under the mouse cursor.

Top

Tip
The TRSSVGImage always loads and draws the SVG image from the TRSSVGDocument 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 := TRSSVGDocument.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) SelectComponentVcl

• 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) SelectSVGDocVcl

• 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.

RiverSoftAVG Products Help

Reference