PHP | ImagickDraw getStrokeDashOffset() Function

The ImagickDraw::getStrokeDashOffset() function is an inbuilt function in PHP which is used to get the offset into the dash pattern to start the dash. This offset is nothing but the spacing to give before starting the dashing set by setStrokeDashArray().

Syntax:

float ImagickDraw::getStrokeDashOffset( void )

Parameters: This function doesn’t accepts any parameters.

Return Value: This function returns an float value containing the offset.

Exceptions: This function throws ImagickException on error.

Below programs illustrate the ImagickDraw::getStrokeDashOffset() function in PHP:

Program 1:

<?php

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Get the stroke dash offset
$offset = $draw->getStrokeDashOffset();
echo $offset;
?>

Output:

0 // Which is the default value

Program 2:

<?php

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Set the stroke dash offset
$draw->setStrokeDashOffset(50);

// Get the stroke dash offset
$offset = $draw->getStrokeDashOffset();
echo $offset;
?>

Output:

50

Program 3:

<?php

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Create a new imagick object
$imagick = new Imagick();

// Create a image on imagick object
$imagick->newImage(800, 250, 'black');

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Set the fill color
$draw->setFillColor('black');

// Set the color of stroke
$draw->setStrokeColor('white');

// Set the font size
$draw->setFontSize(15);

 // Set the stroke dash array
$draw->setStrokeDashArray([20, 5, 19, 15, 5, 15]);

// Draw a rectangle
$draw->rectangle(100, 50, 225, 175);

// Annotate a text
$draw->annotation(50, 200, 'The strokeDashOffset here is '
           . $draw->getStrokeDashOffset());

// Set the stroke dash offset
$draw->setStrokeDashOffset(20);

// Draw a rectangle
$draw->rectangle(500, 50, 625, 175);

// Get the stroke dash array
$strokeDashArray = $draw->getStrokeDashArray();

// Annotate a text
$draw->annotation(450, 200, 'The strokeDashOffset here is '
           . $draw->getStrokeDashOffset());

// 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.getstrokedashoffset.php