Imagick::setIteratorIndex

(PECL imagick 2, PECL imagick 3)

Imagick::setIteratorIndex — Establece la posición del iterador

Descripción

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

Establece el iterador a la posición en la lista de imágenes definida por el parámtro index. Este método solo está disponible si Imagick ha sido compilado con ImageMagick versión 6.2.9 o superior.

Parámetros

index: La posición donde se va a establecer el iterador

Valores devueltos

Devuelve true en caso de éxito.

Ejemplos

Ejemplo #1 Usar Imagick::setIteratorIndex():

Crear imágenes, establecer y obtener el índice del iterador

<?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();
?>

Véase también

Imagick::getIteratorIndex() - Lee el índice de la imagen activa actual
Imagick::getImageIndex() - Obtiene el índice de la imagen actual
Imagick::setImageIndex() - Establece la posición del iterador

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

wilcobeekhuizen at gmail dot com ¶

15 years ago

This function returns true on success but setting the iterator to an invalid index throws an exception instead of returning false:
Fatal error: Uncaught exception 'ImagickException' with message 'Unable to set iterator index'

This can happen when counting images inside a gif file, because the iterator count starts at zero and not one. If you count the number of images in a gif file be sure to use iterator 0 for the first image, like this:

<?php
$image = new Imagick('simple.gif');
$image->setIteratorIndex(0);
?>

down

mgreest at yahoo dot co dot uk ¶

2 days ago

On a pdf document this function sets the object to the page requested in the parameter, with page numbers starting at zero. So, select the first page in a pdf like this:

 <?php
  $image = new Imagick('simple.pdf');
  $image->setIteratorIndex(0);
?>

＋add a note