<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Annotates an image with text</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.animateimages.html">Imagick::animateImages</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.appendimages.html">Imagick::appendImages</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.annotateimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::annotateImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::annotateImage</span> — <span class="dc-title">Annotates an image with text</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.annotateimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::annotateImage</strong></span>
( <span class="methodparam"><span class="type"><a href="class.imagickdraw.html" class="type ImagickDraw">ImagickDraw</a></span> <code class="parameter">$draw_settings</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$x</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$y</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$angle</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
)</div>
<p class="para rdfs-comment">
Annotates an image with text.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.annotateimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">draw_settings</code></em></span>
<dd>
<p class="para">
The ImagickDraw object that contains settings for drawing the text
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">x</code></em></span>
<dd>
<p class="para">
Horizontal offset in pixels to the left of text
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y</code></em></span>
<dd>
<p class="para">
Vertical offset in pixels to the baseline of text
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">angle</code></em></span>
<dd>
<p class="para">
The angle at which to write the text
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The string to draw
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.annotateimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.annotateimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3309">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::annotateImage()</strong></span>:</strong></p>
<div class="example-contents"><p>
Annotate text on an empty image
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Create some objects */<br /></span><span style="color: #0000BB">$image </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$draw </span><span style="color: #007700">= new </span><span style="color: #0000BB">ImagickDraw</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$pixel </span><span style="color: #007700">= new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">( </span><span style="color: #DD0000">'gray' </span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* New image */<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">800</span><span style="color: #007700">, </span><span style="color: #0000BB">75</span><span style="color: #007700">, </span><span style="color: #0000BB">$pixel</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Black text */<br /></span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFillColor</span><span style="color: #007700">(</span><span style="color: #DD0000">'black'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Font properties */<br /></span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFont</span><span style="color: #007700">(</span><span style="color: #DD0000">'Bookman-DemiItalic'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFontSize</span><span style="color: #007700">( </span><span style="color: #0000BB">30 </span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Create text */<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-></span><span style="color: #0000BB">annotateImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$draw</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">45</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'The quick brown fox jumps over the lazy dog'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Give image a format */<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">'png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Output the image with headers */<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-type: image/png'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$image</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.annotateimage-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="imagickdraw.annotation.html" class="function" rel="rdfs-seeAlso">ImagickDraw::annotation()</a> - Draws text on the image</span></li>
<li class="member"> <span class="function"><a href="imagickdraw.setfont.html" class="function" rel="rdfs-seeAlso">ImagickDraw::setFont()</a> - Sets the fully-specified font to use when annotating with text</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.animateimages.html">Imagick::animateImages</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.appendimages.html">Imagick::appendImages</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
