diff --git a/dev/index.html b/dev/index.html index 2464de2..4f1f443 100644 --- a/dev/index.html +++ b/dev/index.html @@ -11,9 +11,9 @@ ) fig = Figure() -cs = CanvasSelect(fig[2, 1]; layers)source
MakieDraw.GeometryCanvas — Type
GeometryCanvas{T<:GeometryBasics.Geometry} <: AbstractCanvas
+cs = CanvasSelect(fig[2, 1]; layers)
source
MakieDraw.GeometryCanvas — Type
GeometryCanvas{T<:GeometryBasics.Geometry} <: AbstractCanvas
 
-GeometryCanvas{T}(; kw...)

A canvas for drawing GeometryBasics.jl geometries onto a Makie.jl Axis.

T must be Point, LineString or Polygon.

Mouse and Key commands

  • Left click select point, or add point with property 1 if click_property is set.
  • Rick click select point, or add point with property 2 if click_property is set.
  • Middle click select point, or add point with property 3 if click_property is set.
  • Alt+click: delete points, dragging will click is held will continue deleting.
  • Shift+click: start new polygons and linstrings on Polygon and LineString canvas. Has no effect for Point.
  • Delete: delete selected points.
  • Shift+Delete: delete selected linestring/polygon.

Keywords

  • dragging: an Observable{Bool}(false) to track mouse dragging.
  • active: an Observable{Bool}(true) to set if the canvas is active.
  • accuracy_scale: control how accurate selection needs to be. 1.0 by default.
  • name: A Symbol: name for the canvas. Will appear in a CanvasSelect.
  • propertynames: names for feaure properties to create.
  • properties: an existin table of properties.
  • click_property: which property is set with left and right click, shold be a Bool.
  • figure: a figure to plot on.
  • axis: an axis to plot on.
  • current_point: an observable to track the currently focused point index.
  • scatter_kw: keywords to pass to scatter.
  • lines_kw: keywords to pass to lines.
  • poly_kw: keywords to pass to poly.
  • current_point_kw: keywords for the current point scatter.
  • show_current_point: whether to show the current point differently to the other.
  • text_input: wether to add text input boxes for property input.
source
MakieDraw.PaintCanvas — Type
PaintCanvas <: AbstractCanvas
+GeometryCanvas{T}(; kw...)

A canvas for drawing GeometryBasics.jl geometries onto a Makie.jl Axis.

T must be Point, LineString or Polygon.

Mouse and Key commands

  • Left click select point, or add point with property 1 if click_property is set.
  • Rick click select point, or add point with property 2 if click_property is set.
  • Middle click select point, or add point with property 3 if click_property is set.
  • Alt+click: delete points, dragging will click is held will continue deleting.
  • Shift+click: start new polygons and linstrings on Polygon and LineString canvas. Has no effect for Point.
  • Delete: delete selected points.
  • Shift+Delete: delete selected linestring/polygon.

Keywords

  • dragging: an Observable{Bool}(false) to track mouse dragging.
  • active: an Observable{Bool}(true) to set if the canvas is active.
  • accuracy_scale: control how accurate selection needs to be. 1.0 by default.
  • name: A Symbol: name for the canvas. Will appear in a CanvasSelect.
  • propertynames: names for feaure properties to create.
  • properties: an existin table of properties.
  • click_property: which property is set with left and right click, shold be a Bool.
  • figure: a figure to plot on.
  • axis: an axis to plot on.
  • current_point: an observable to track the currently focused point index.
  • scatter_kw: keywords to pass to scatter.
  • lines_kw: keywords to pass to lines.
  • poly_kw: keywords to pass to poly.
  • current_point_kw: keywords for the current point scatter.
  • show_current_point: whether to show the current point differently to the other.
  • text_input: wether to add text input boxes for property input.
source
MakieDraw.PaintCanvas — Type
PaintCanvas <: AbstractCanvas
 
 PaintCanvas(; kw...)
-PaintCanvas(f, data; kw...)

A canvas for painting into a Matrix Real numbers or colors.

Arguments

  • data: an AbstractMatrix that will plot with Makie.image!, or your function f
  • f: a function, like image! or heatmap!, that will plot f(axis, dimsions..., data) onto axis.

Keywords

  • dimension: the dimesion ticks of data. axes(data) by default.
  • drawing: an Observable{Bool}(false) to track if drawing is occuring.
  • drawbutton: the currently clicked mouse button while drawing, e.g. Mouse.left.
  • active: an Observable{Bool}(true) to set if the canvas is active.
  • name: A Symbol: name for the canvas. Will appear in a CanvasSelect.
  • figure: a figure to plot on.
  • axis: an axis to plot on.
  • fill_left: Observable value for left click drawing.
  • fill_right: Observable value for right click drawing.
  • fill_middle: Observable value for middle click drawing.

Mouse and Key commands

  • Left click/drag: draw with value of fill_left
  • Right click/drag: draw with value of fill_right
  • Middle click/drag: draw with value of fill_middle
source
MakieDraw.arrow_key_navigation — Method
arrow_key_navigation(fig, axis)

Allow moving the axis with keyboard arrow keys.

source
+PaintCanvas(f, data; kw...)

A canvas for painting into a Matrix Real numbers or colors.

Arguments

Keywords

Mouse and Key commands

source
MakieDraw.arrow_key_navigation — Method
arrow_key_navigation(fig, axis)

Allow moving the axis with keyboard arrow keys.

source
diff --git a/dev/search/index.html b/dev/search/index.html index 2f4aa8c..2287e90 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · MakieDraw.jl

Loading search...

    +Search · MakieDraw.jl

    Loading search...