SVG_Set_description

Home

4D v20

SVG_Set_description


SVG_Set_description ( parentSVGObject ; description ) -> Function result

Parameter	Type	Description
parentSVGObject	SVG_Ref	Reference of parent element
description	String	Text of comments
Function result	SVG_Ref	Reference of description

Description

The SVG_Set_description command sets a text for the SVG element designated by parentSVGObject and returns its reference. If parentSVGObject is not an SVG element, an error is generated.

A description is often used to insert a comment or explanatory text in the SVG code.

Example

 $SVG:=SVG_New

 $g:=SVG_group($SVG)

 SVG_Set_title($g;"Company sales per region")

 SVG_Set_description($g;"Bar diagram of company sales per region.")