4D v12

SVG_New_text

Home

 
4D v12
SVG_New_text

 

SVG_New_text 


 

SVG_New_text ( parentSVGObject ; text {; x {; y {; font {; size {; style {; alignment {; color {; rotation {; lineSpacing {; stretching}}}}}}}}}} ) -> Function result 
Parameter Type   Description
parentSVGObject  SVG_Ref in Reference of parent element
text  Text in Text to insert
Real in Coordinate on X axis
Real in Coordinate on Y axis
font  String in Font name
size  Longint in Size of characters in points
style  Longint in Style of characters
alignment  Longint in Alignment
color  String in Text color
rotation  Real in Angle of rotation of text
lineSpacing  Real in Line spacing in points
stretching  Real in Horizontal stretch factor
Function result  SVG_Ref in Reference of SVG text object

The SVG_New_text command inserts the text in text in the SVG container designated by parentSVGObject and returns its reference. If parentSVGObject is not an SVG document, an error is generated.

The optional x and y parameters can be used to specify the position on the X and Y axis of the upper corner of the first character of text. This point is situated differently according to the alignment value: to the left for a left alignment, to the right for a right alignment or in the center when the text is centered.

The optional font and size parameters can be used to specify the font and its size, in points, to be used. When these parameters are not passed, the text will be written in Times New Roman 12 pt.

The optional style parameter gives the character style used. In this parameter, you must pass one of the following styles, or a combination of several of these values:

0 = Plain
1 = Bold
2 = Italic
4 = Underline
8 = Strikethrough

The optional alignment parameter can be used to set the type of alignment applied to the text drawn. You can pass one of the following values:

2 = Align left
3 = Center
4 = Align right

The optional color parameter contains the name of the font color. (For more information about colors, please refer to the ”Colors and gradients” section).

The optional rotation parameter can be used to specify the rotation to be applied to the text.

The optional lineSpacing parameter can be used to specify the value of the line spacing if the text has more than one line. Default value = 1.

The optional stretching parameter can be used to specify a horizontal stretching (value >1) or condensing (value included between 0 and 1) factor of the text.

Simple text using default text properties:

 $SVG:=SVG_New
 $textID:=SVG_New_text($SVG;"Hello world!")

Text that is blue, italic, underlined and aligned to the right:

 $SVG:=SVG_New
 $text:="Hello world!\rBonjour le monde!\rHola Mundo!"
 $size:=48
 $font:="helvetica"
 $textID:=SVG_New_text($SVG;$text;400;10;$font;$size;Italic+Underline;Align right;"blue")

Vertical text:

 $SVG:=SVG_New
 $textID:=SVG_New_text($SVG;$text;-250;0;"";48;-1;-1;"red";-90)

Condensed or expanded text:

 $SVG:=SVG_New
 $textID:=SVG_New_text($SVG;"Hello world (condensed)";0;0;"";-1;-1;-1;"blue";0;1;0,8)
 $textID:=SVG_New_text($SVG;"Hello world (normal)";0;24)
 $textID:=SVG_New_text($SVG;"Hello world (stretched)";0;48;"";-1;-1;-1;"red";0;1;2)

 
PROPERTIES 

Product: 4D
Theme: Text
Number: 65958

 
HISTORY 

Created: Composant 4D SVG v11.3

 
SEE ALSO 

SVG_New_textArea
SVG_New_tspan
SVG_New_vertical_text