Overview
KB
Technical FAQ
PHP Manual
CSS2 Manual
HTML Manual
JS Guide
JS Reference
PhpDock Manual
Nu-Coder Manual
PhpExpress Manual
PHP Joomla
Development
Learn PHP
 
<Imagick::setInterlaceSchemeImagick::setLastIterator>
^ImagickLast updated: Mon, 26 Oct 2026

Imagick::setIteratorIndex

(PECL imagick 2, PECL imagick 3)

Imagick::setIteratorIndex — Set the iterator position

Description

public function Imagick::setIteratorIndex(int $index): bool

Set the iterator to the position in the image list specified with the index parameter. This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.

Parameters

index

The position to set the iterator to

Return Values

Returns true on success.

Examples

Example #1 Using Imagick::setIteratorIndex():

Create images, set and get the iterator index 

<?php
$im = new Imagick();
$im->newImage(100, 100, new ImagickPixel("red"));
$im->newImage(100, 100, new ImagickPixel("green"));
$im->newImage(100, 100, new ImagickPixel("blue"));

$im->setIteratorIndex(1);
echo $im->getIteratorIndex();
?>

See Also


<Imagick::setInterlaceSchemeImagick::setLastIterator>
^ImagickLast updated: Mon, 26 Oct 2026