whitecanvas.tools

Built-in tools.

lasso_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a Lasso selector tool with given settings.

A Lasso selector emits a XYData object by freehand drawing. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = lasso_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = lasso_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def lasso_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> LassoSelectionTool:
    """
    Create a Lasso selector tool with given settings.

    A Lasso selector emits a XYData object by freehand drawing.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = lasso_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = lasso_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return LassoSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)

line_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a line selector tool with given settings.

A line selector emits a LineSelection object when a line is drawn. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = line_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = line_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def line_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> LineSelectionTool:
    """
    Create a line selector tool with given settings.

    A line selector emits a LineSelection object when a line is drawn.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = line_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = line_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return LineSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)

polygon_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a polygon selector tool with given settings.

A polygon selector emits a XYData object by freehand drawing. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = polygon_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = polygon_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def polygon_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> LassoSelectionTool:
    """
    Create a polygon selector tool with given settings.

    A polygon selector emits a XYData object by freehand drawing.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = polygon_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = polygon_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return PolygonSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)

rect_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a rectangle selector tool with given settings.

A rectangle selector emits a Rect object when a rectangle is drawn. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = rect_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = rect_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def rect_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> RectSelectionTool:
    """
    Create a rectangle selector tool with given settings.

    A rectangle selector emits a Rect object when a rectangle is drawn.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = rect_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = rect_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return RectSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)

xspan_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a x-span selector tool with given settings.

A x-span selector emits a SpanSelection object (tuple of start and end) when a span is drawn. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = xspan_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = line_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def xspan_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> XSpanSelectionTool:
    """
    Create a x-span selector tool with given settings.

    A x-span selector emits a SpanSelection object (tuple of start and end) when a span
    is drawn.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = xspan_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = line_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return XSpanSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)

yspan_selector(canvas, buttons='left', modifiers=None, *, tracking=False)

Create a line selector tool with given settings.

A y-span selector emits a SpanSelection object (tuple of start and end) when a span is drawn. A selection tool is constructed by specifying the canvas to attach the tool.

canvas = new_canvas("matplotlib:qt") tool = yspan_selector(canvas)

Use buttons and modifiers to specify how to trigger the tool.

tool = line_selector(canvas, buttons="right", modifiers="ctrl")

Parameters:

Name	Type	Description	Default
canvas	CanvasBase	The canvas to which the tool is attached.	required
buttons	MouseButton or Sequence[MouseButton]	The mouse buttons that can trigger the tool.	"left"
modifiers	Modifier or Sequence[Modifier]	The modifier keys that must be pressed to trigger the tool.	None
tracking	bool	If True, the tool emits the changed signal while dragging. Otherwise, it emits the signal only when dragging is finished.	False

Source code in whitecanvas\tools\_selection.py

def yspan_selector(
    canvas: CanvasBase,
    buttons: _MouseButton | Sequence[_MouseButton] = "left",
    modifiers: _Modifier | Sequence[_Modifier] | None = None,
    *,
    tracking: bool = False,
) -> YSpanSelectionTool:
    """
    Create a line selector tool with given settings.

    A y-span selector emits a SpanSelection object (tuple of start and end) when a span
    is drawn.
    A selection tool is constructed by specifying the canvas to attach the tool.

    >>> canvas = new_canvas("matplotlib:qt")
    >>> tool = yspan_selector(canvas)

    Use `buttons` and `modifiers` to specify how to trigger the tool.

    >>> tool = line_selector(canvas, buttons="right", modifiers="ctrl")

    Parameters
    ----------
    canvas : CanvasBase
        The canvas to which the tool is attached.
    buttons : MouseButton or Sequence[MouseButton], default "left"
        The mouse buttons that can trigger the tool.
    modifiers : Modifier or Sequence[Modifier], optional
        The modifier keys that must be pressed to trigger the tool.
    tracking : bool, default False
        If True, the tool emits the changed signal while dragging. Otherwise, it emits
        the signal only when dragging is finished.
    """
    _buttons, _modifiers = _norm_input(buttons, modifiers)
    return YSpanSelectionTool(canvas, _buttons, _modifiers, tracking=tracking)