/usr/share/gtk-doc/html/pygoocanvas/class-canvas-polyline-model.html

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>goocanvas.PolylineModel</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="PyGooCanvas Reference Manual"><link rel="up" href="pygoocanvas-model-items.html" title="PyGooCanvas Canvas Item Models Reference"><link rel="prev" href="class-canvas-path-model.html" title="goocanvas.PathModel"><link rel="next" href="class-canvas-rect-model.html" title="goocanvas.RectModel"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">goocanvas.PolylineModel</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-canvas-path-model.html">Prev</a> </td><th width="60%" align="center">PyGooCanvas Canvas Item Models Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-canvas-rect-model.html">Next</a></td></tr></table><hr></div><div class="refentry" title="goocanvas.PolylineModel"><a name="class-canvas-polyline-model"></a><div class="titlepage"></div><div class="refnamediv"><h2>goocanvas.PolylineModel</h2><p>goocanvas.PolylineModel — A model for polyline items (a series of lines with optional arrows).</p></div><div class="refsect1" title="Synopsis"><a name="idp3138032"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">goocanvas.PolylineModel</span></span>(<span class="ooclass"><span class="classname">goocanvas.ItemModelModelSimple</span></span>):
<code class="constructorsynopsis">    <span class="methodname">goocanvas.PolylineModel</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>properties</code></strong></span><span class="initializer">=None</span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis">    def <span class="methodname">goocanvas.polyline_model_new_line</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x1</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y1</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x2</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y2</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>properties</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="idp3151248"></a><h2>Ancestry</h2><pre class="synopsis">+-- <a
href="../pygobject/class-gobject.html"
>gobject.GObject</a>
	+-- goocanvas.ItemModelModelSimple
		+-- goocanvas.PolylineModel
</pre></div><div class="refsect1" title="goocanvas.PolylineModel Properties"><a name="properties-goocanvaspolyline-model"></a><h2>goocanvas.PolylineModel Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"arrow-length"</td><td valign="top">Read/Write</td><td valign="top">The length of the arrows, as a multiple of the line width. Allowed values: &gt;= 0. Default value: 5.</td></tr><tr valign="top"><td valign="top">"arrow-tip-length"</td><td valign="top">Read/Write</td><td valign="top">The length of the arrow tip, as a multiple of the line width. Allowed values: &gt;= 0. Default value: 4.</td></tr><tr valign="top"><td valign="top">"arrow-width"</td><td valign="top">Read/Write</td><td valign="top">The width of the arrows, as a multiple of the line width. Allowed values: &gt;= 0. Default value: 4.</td></tr><tr valign="top"><td valign="top">"close-path"</td><td valign="top">Read/Write</td><td valign="top">If the last point should be connected to the first. Default value: False.</td></tr><tr valign="top"><td valign="top">"end-arrow"</td><td valign="top">Read/Write</td><td valign="top">If an arrow should be displayed at the end of the polyline. Default value: False.</td></tr><tr valign="top"><td valign="top">"points"</td><td valign="top">Read/Write</td><td valign="top">The array of points.</td></tr><tr valign="top"><td valign="top">"start-arrow"</td><td valign="top">Read/Write</td><td valign="top">If an arrow should be displayed at the start of the polyline. Default value: False.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Implemented Interfaces"><a name="idp3175968"></a><h2>Implemented Interfaces</h2><p>
			<code class="classname">goocanvas.PolylineModel</code>
			implements 
			<code class="classname">goocanvas.ItemModel</code>
		</p></div><div class="refsect1" title="Description"><a name="idp3179024"></a><h2>Description</h2><code class="classname">goocanvas.PolylineModel</code> 
			represents a model for polyline items, which is a series of one or more lines, with optional arrows at either end.

			It is a subclass of 
			<code class="classname">goocanvas.ItemModelModelSimple</code> 
			and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width".

			It also implements the <code class="classname">goocanvas.ItemModel</code> 
			interface, so you can use the <code class="classname">goocanvas.ItemModel</code> 
			functions such as <code class="methodname">goocanvas.ItemModel.raise_()</code> 
			and <code class="methodname">goocanvas.ItemModel.rotate()</code></div><div class="refsect1" title="Constructor"><a name="constructor-canvas-polyline-model"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">goocanvas.PolylineModel</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>properties</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>properties</code></strong>:</span></p></td><td>A comma separated list of properties.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A new 
						<code class="classname">goocanvas.PolylineModel</code>
					</td></tr></tbody></table><p>
			Creates a new canvas polyline item.
		</p><p>
			Here's an example showing how to create a filled triangle with vertices at (100,100), (300,100), and (200,300).
		</p><pre class="programlisting">
	p_points = goocanvas.Points([(100.0, 100.0), (300.0, 100.0), (200.0, 300.0)])
	polyline = goocanvas.PolylineModel(parent = root,
                                       points=p_points,
                                       close_path=True,
                                       stroke_color="red",
                                       fill_color="blue")
</pre></div><div class="refsect1" title="Functions"><a name="idp3196192"></a><h2>Functions</h2><div class="refsect2" title="goocanvas.polyline_model_new_line"><a name="function-goocanvas--polyline-model-new-line"></a><h3>goocanvas.polyline_model_new_line</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">goocanvas.polyline_model_new_line</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>parent</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x1</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y1</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x2</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y2</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>properties</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>parent</code></strong>:</span></p></td><td>The parent item, or None.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>x1</code></strong>:</span></p></td><td>The x coordinate of the start of the line.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y1</code></strong>:</span></p></td><td>The y coordinate of the start of the line.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>x2</code></strong>:</span></p></td><td>The x coordinate of the end of the line.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y2</code></strong>:</span></p></td><td>The y coordinate of the end of the line.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>properties</code></strong>:</span></p></td><td>A comma separated list of properties.</td></tr></tbody></table><p>
				Creates a new polyline model item with a single line.
			</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-canvas-path-model.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pygoocanvas-model-items.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-canvas-rect-model.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">goocanvas.PathModel </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> goocanvas.RectModel</td></tr></table></div></body></html>
python-pygoocanvas 0.14.1-1ubuntu6 / usr / share / gtk-doc / html / pygoocanvas / class-canvas-polyline-model.html
