Thursday, September 4, 2025
HomeLanguagesPHP | ImagickDraw getTextDecoration() Function

PHP | ImagickDraw getTextDecoration() Function

The ImagickDraw::getTextDecoration() function is an inbuilt function in PHP which is used to get the decoration applied when annotating with text.

Syntax:

int ImagickDraw::getTextDecoration( void )

Parameters: This function doesn’t accept any parameter.

Return Value: This function returns an integer value corresponding to one of DECORATION constants.
List of DECORATION constants are given below:

  • imagick::DECORATION_NO (0)
  • imagick::DECORATION_UNDERLINE (1)
  • imagick::DECORATION_OVERLINE (2)
  • imagick::DECORATION_LINETROUGH (3)

Exceptions: This function throws ImagickException on error.

Below given programs illustrate the ImagickDraw::getTextDecoration() function in PHP:

Program 1:




<?php
  
// Create a new ImagickDraw object
$draw = new ImagickDraw();
  
// Get the text decoration
$textDecoration = $draw->getTextDecoration();
echo $textDecoration;
?>


Output:

1 // which is the default value.

Program 2:




<?php
  
// Create a new ImagickDraw object
$draw = new ImagickDraw();
  
// Set the text decoration
$draw->setTextDecoration(2);
  
// Get the text decoration
$textDecoration = $draw->getTextDecoration();
echo $textDecoration;
?>


Output:

2

Program 3:




<?php
  
// Create a new imagick object
$imagick = new Imagick();
  
// Create a image on imagick object
$imagick->newImage(800, 250, 'grey');
  
// Create a new ImagickDraw object
$draw = new ImagickDraw();
  
// Set the fill color
$draw->setFillColor('purple');
  
// Set the font size
$draw->setFontSize(40);
  
// Get the text decoration
$textDecoration = $draw->getTextDecoration();
  
// Annotate a text
$draw->annotation(50, 100, 'The text decoration here is ' 
                                       . $textDecoration);
  
// Set the text decoration
$draw->setTextDecoration(2);
  
// Get the text decoration
$textDecoration = $draw->getTextDecoration();
  
// Annotate a text
$draw->annotation(50, 200, 'The text decoration here is ' 
                                       . $textDecoration);
  
// Render the draw commands
$imagick->drawImage($draw);
  
// Show the output
$imagick->setImageFormat('png');
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>


Output:

Reference: https://www.php.net/manual/en/imagickdraw.gettextdecoration.php

RELATED ARTICLES

Most Popular

Dominic
32263 POSTS0 COMMENTS
Milvus
81 POSTS0 COMMENTS
Nango Kala
6626 POSTS0 COMMENTS
Nicole Veronica
11799 POSTS0 COMMENTS
Nokonwaba Nkukhwana
11857 POSTS0 COMMENTS
Shaida Kate Naidoo
6749 POSTS0 COMMENTS
Ted Musemwa
7025 POSTS0 COMMENTS
Thapelo Manthata
6696 POSTS0 COMMENTS
Umr Jansen
6716 POSTS0 COMMENTS