build based on aef26ab

dev/index.html

@@ -11,9 +11,9 @@
 )
 
 fig = Figure()
-cs = CanvasSelect(fig[2, 1]; layers)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/1cdcd8aa296754dce077d2a48d6b08d381ec0a55/src/canvas_select.jl#L5-L37">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.GeometryCanvas" href="#MakieDraw.GeometryCanvas"><code>MakieDraw.GeometryCanvas</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">GeometryCanvas{T&lt;:GeometryBasics.Geometry} &lt;: AbstractCanvas
+cs = CanvasSelect(fig[2, 1]; layers)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/aef26aba94ed7a2019d3f5c7c9c7f0acf1074f4b/src/canvas_select.jl#L5-L37">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.GeometryCanvas" href="#MakieDraw.GeometryCanvas"><code>MakieDraw.GeometryCanvas</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">GeometryCanvas{T&lt;:GeometryBasics.Geometry} &lt;: AbstractCanvas
 
-GeometryCanvas{T}(; kw...)</code></pre><p>A canvas for drawing GeometryBasics.jl geometries onto a Makie.jl <code>Axis</code>.</p><p><code>T</code> must be <code>Point</code>, <code>LineString</code> or <code>Polygon</code>.</p><p><strong>Mouse and Key commands</strong></p><ul><li>Left click select point, or add point with property 1 if <code>click_property</code> is set.</li><li>Rick click select point, or add point with property 2 if <code>click_property</code> is set.</li><li>Middle click select point, or add point with property 3 if <code>click_property</code> is set.</li><li>Alt+click: delete points, dragging will click is held will continue deleting.</li><li>Shift+click: start new polygons and linstrings on <code>Polygon</code> and <code>LineString</code> canvas. Has no effect for <code>Point</code>.</li><li>Delete: delete selected points.</li><li>Shift+Delete: delete selected linestring/polygon.</li></ul><p><strong>Keywords</strong></p><ul><li><code>dragging</code>: an Observable{Bool}(false) to track mouse dragging.</li><li><code>active</code>: an Observable{Bool}(true) to set if the canvas is active.</li><li><code>accuracy_scale</code>: control how accurate selection needs to be. <code>1.0</code> by default.</li><li><code>name</code>: A <code>Symbol</code>: name for the canvas. Will appear in a <a href="#MakieDraw.CanvasSelect"><code>CanvasSelect</code></a>.</li><li><code>propertynames</code>: names for feaure properties to create.</li><li><code>properties</code>: an existin table of properties.</li><li><code>click_property</code>: which property is set with left and right click, shold be a <code>Bool</code>.</li><li><code>figure</code>: a figure to plot on.</li><li><code>axis</code>: an axis to plot on.</li><li><code>current_point</code>: an observable to track the currently focused point index.</li><li><code>scatter_kw</code>: keywords to pass to <code>scatter</code>.</li><li><code>lines_kw</code>: keywords to pass to <code>lines</code>.</li><li><code>poly_kw</code>: keywords to pass to <code>poly</code>.</li><li><code>current_point_kw</code>: keywords for the current point <code>scatter</code>.</li><li><code>show_current_point</code>: whether to show the current point differently to the other.</li><li><code>text_input</code>: wether to add text input boxes for property input.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/1cdcd8aa296754dce077d2a48d6b08d381ec0a55/src/geometry_canvas.jl#L1-L38">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.PaintCanvas" href="#MakieDraw.PaintCanvas"><code>MakieDraw.PaintCanvas</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PaintCanvas &lt;: AbstractCanvas
+GeometryCanvas{T}(; kw...)</code></pre><p>A canvas for drawing GeometryBasics.jl geometries onto a Makie.jl <code>Axis</code>.</p><p><code>T</code> must be <code>Point</code>, <code>LineString</code> or <code>Polygon</code>.</p><p><strong>Mouse and Key commands</strong></p><ul><li>Left click select point, or add point with property 1 if <code>click_property</code> is set.</li><li>Rick click select point, or add point with property 2 if <code>click_property</code> is set.</li><li>Middle click select point, or add point with property 3 if <code>click_property</code> is set.</li><li>Alt+click: delete points, dragging will click is held will continue deleting.</li><li>Shift+click: start new polygons and linstrings on <code>Polygon</code> and <code>LineString</code> canvas. Has no effect for <code>Point</code>.</li><li>Delete: delete selected points.</li><li>Shift+Delete: delete selected linestring/polygon.</li></ul><p><strong>Keywords</strong></p><ul><li><code>dragging</code>: an Observable{Bool}(false) to track mouse dragging.</li><li><code>active</code>: an Observable{Bool}(true) to set if the canvas is active.</li><li><code>accuracy_scale</code>: control how accurate selection needs to be. <code>1.0</code> by default.</li><li><code>name</code>: A <code>Symbol</code>: name for the canvas. Will appear in a <a href="#MakieDraw.CanvasSelect"><code>CanvasSelect</code></a>.</li><li><code>propertynames</code>: names for feaure properties to create.</li><li><code>properties</code>: an existin table of properties.</li><li><code>click_property</code>: which property is set with left and right click, shold be a <code>Bool</code>.</li><li><code>figure</code>: a figure to plot on.</li><li><code>axis</code>: an axis to plot on.</li><li><code>current_point</code>: an observable to track the currently focused point index.</li><li><code>scatter_kw</code>: keywords to pass to <code>scatter</code>.</li><li><code>lines_kw</code>: keywords to pass to <code>lines</code>.</li><li><code>poly_kw</code>: keywords to pass to <code>poly</code>.</li><li><code>current_point_kw</code>: keywords for the current point <code>scatter</code>.</li><li><code>show_current_point</code>: whether to show the current point differently to the other.</li><li><code>text_input</code>: wether to add text input boxes for property input.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/aef26aba94ed7a2019d3f5c7c9c7f0acf1074f4b/src/geometry_canvas.jl#L1-L38">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.PaintCanvas" href="#MakieDraw.PaintCanvas"><code>MakieDraw.PaintCanvas</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PaintCanvas &lt;: AbstractCanvas
 
 PaintCanvas(; kw...)
-PaintCanvas(f, data; kw...)</code></pre><p>A canvas for painting into a Matrix Real numbers or colors.</p><p><strong>Arguments</strong></p><ul><li><code>data</code>: an <code>AbstractMatrix</code> that will plot with <code>Makie.image!</code>, or your function <code>f</code></li><li><code>f</code>: a function, like <code>image!</code> or <code>heatmap!,</code> that will plot <code>f(axis, dimsions..., data)</code> onto <code>axis</code>.</li></ul><p><strong>Keywords</strong></p><ul><li><code>dimension</code>: the dimesion ticks of data. <code>axes(data)</code> by default.</li><li><code>drawing</code>: an Observable{Bool}(false) to track if drawing is occuring.</li><li><code>drawbutton</code>: the currently clicked mouse button while drawing, e.g. Mouse.left.</li><li><code>active</code>: an Observable{Bool}(true) to set if the canvas is active.</li><li><code>name</code>: A <code>Symbol</code>: name for the canvas. Will appear in a <a href="#MakieDraw.CanvasSelect"><code>CanvasSelect</code></a>.</li><li><code>figure</code>: a figure to plot on.</li><li><code>axis</code>: an axis to plot on.</li><li><code>fill_left</code>: Observable value for left click drawing.</li><li><code>fill_right</code>: Observable value for right click drawing.</li><li><code>fill_middle</code>: Observable value for middle click drawing.</li></ul><p><strong>Mouse and Key commands</strong></p><ul><li>Left click/drag: draw with value of <code>fill_left</code></li><li>Right click/drag: draw with value of <code>fill_right</code></li><li>Middle click/drag: draw with value of <code>fill_middle</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/1cdcd8aa296754dce077d2a48d6b08d381ec0a55/src/paint_canvas.jl#L1-L32">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.arrow_key_navigation-Tuple{Any, Any}" href="#MakieDraw.arrow_key_navigation-Tuple{Any, Any}"><code>MakieDraw.arrow_key_navigation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">arrow_key_navigation(fig, axis)</code></pre><p>Allow moving the axis with keyboard arrow keys.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/1cdcd8aa296754dce077d2a48d6b08d381ec0a55/src/utils.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 27 August 2024 00:39">Tuesday 27 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+PaintCanvas(f, data; kw...)</code></pre><p>A canvas for painting into a Matrix Real numbers or colors.</p><p><strong>Arguments</strong></p><ul><li><code>data</code>: an <code>AbstractMatrix</code> that will plot with <code>Makie.image!</code>, or your function <code>f</code></li><li><code>f</code>: a function, like <code>image!</code> or <code>heatmap!,</code> that will plot <code>f(axis, dimsions..., data)</code> onto <code>axis</code>.</li></ul><p><strong>Keywords</strong></p><ul><li><code>dimension</code>: the dimesion ticks of data. <code>axes(data)</code> by default.</li><li><code>drawing</code>: an Observable{Bool}(false) to track if drawing is occuring.</li><li><code>drawbutton</code>: the currently clicked mouse button while drawing, e.g. Mouse.left.</li><li><code>active</code>: an Observable{Bool}(true) to set if the canvas is active.</li><li><code>name</code>: A <code>Symbol</code>: name for the canvas. Will appear in a <a href="#MakieDraw.CanvasSelect"><code>CanvasSelect</code></a>.</li><li><code>figure</code>: a figure to plot on.</li><li><code>axis</code>: an axis to plot on.</li><li><code>fill_left</code>: Observable value for left click drawing.</li><li><code>fill_right</code>: Observable value for right click drawing.</li><li><code>fill_middle</code>: Observable value for middle click drawing.</li></ul><p><strong>Mouse and Key commands</strong></p><ul><li>Left click/drag: draw with value of <code>fill_left</code></li><li>Right click/drag: draw with value of <code>fill_right</code></li><li>Middle click/drag: draw with value of <code>fill_middle</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/aef26aba94ed7a2019d3f5c7c9c7f0acf1074f4b/src/paint_canvas.jl#L1-L32">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MakieDraw.arrow_key_navigation-Tuple{Any, Any}" href="#MakieDraw.arrow_key_navigation-Tuple{Any, Any}"><code>MakieDraw.arrow_key_navigation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">arrow_key_navigation(fig, axis)</code></pre><p>Allow moving the axis with keyboard arrow keys.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MakieOrg/MakieDraw.jl/blob/aef26aba94ed7a2019d3f5c7c9c7f0acf1074f4b/src/utils.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 27 August 2024 00:49">Tuesday 27 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>