ndv.views.bases #

@abstractmethod
def canvas_to_world(
    self, pos_xy: tuple[float, float]
) -> tuple[float, float, float]:
    """Map XY canvas position (pixels) to XYZ coordinate in world space."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def can_select(self) -> bool:
    """Defines whether the element can be selected."""

def cursor_at(self, pos: Sequence[float]) -> CursorType | None:
    """Returns the element's cursor preference at the provided position."""

def move(self, pos: Sequence[float]) -> None:
    """
    Behavior executed throughout a "move" operation.

    In layman's terms, this is the behavior executed during the "drag"
    of a "click-and-drag".
    """

def remove(self) -> None:
    """Removes the element from the canvas."""

@abstractmethod
def selected(self) -> bool:
    """Returns element selection status."""

@abstractmethod
def set_selected(self, selected: bool) -> None:
    """Sets element selection status."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets element visibility."""

def start_move(self, pos: Sequence[float]) -> None:
    """
    Behavior executed at the beginning of a "move" operation.

    In layman's terms, this is the behavior executed during the the "click"
    of a "click-and-drag".
    """

@abstractmethod
def visible(self) -> bool:
    """Defines whether the element is visible on the canvas."""

@abstractmethod
def canvas_to_world(
    self, pos_xy: tuple[float, float]
) -> tuple[float, float, float]:
    """Map XY canvas position (pixels) to XYZ coordinate in world space."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_auto_scale(self, checked: bool) -> None:
    """Set the autoscale button to checked if `checked` is True."""

@abstractmethod
def set_channel_name(self, name: str) -> None:
    """Set the name of the channel to `name`."""

@abstractmethod
def set_channel_visible(self, visible: bool) -> None:
    """Check or uncheck the visibility indicator of the LUT.

    Usually corresponds to a checkbox.
    """

@abstractmethod
def set_clims(self, clims: tuple[float, float]) -> None:
    """Set the (low, high) contrast limits to `clims`.

    Usually this will be a range slider or two text boxes.
    """

@abstractmethod
def set_colormap(self, cmap: cmap.Colormap) -> None:
    """Set the colormap to `cmap`.

    Usually corresponds to a dropdown menu.
    """

def set_data(self, values: np.ndarray, bin_edges: np.ndarray) -> None:
    """Sets the histogram data.

    Properties
    ----------
    values : np.ndarray
        The histogram values.
    bin_edges : np.ndarray
        The bin edges of the histogram.
    """

def set_gamma(self, gamma: float) -> None:
    """Set the gamma value of the LUT."""
    return None

def set_log_base(self, base: float | None) -> None:
    """Sets the axis scale of the range.

    Properties
    ----------
    enabled : bool
        If true, the range will be displayed with a logarithmic (base 10)
        scale. If false, the range will be displayed with a linear scale.
    """

def set_vertical(self, vertical: bool) -> None:
    """If True, orient axes vertically (x-axis on left)."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_auto_scale(self, checked: bool) -> None:
    """Set the autoscale button to checked if `checked` is True."""

@abstractmethod
def set_channel_name(self, name: str) -> None:
    """Set the name of the channel to `name`."""

@abstractmethod
def set_channel_visible(self, visible: bool) -> None:
    """Check or uncheck the visibility indicator of the LUT.

    Usually corresponds to a checkbox.
    """

@abstractmethod
def set_clims(self, clims: tuple[float, float]) -> None:
    """Set the (low, high) contrast limits to `clims`.

    Usually this will be a range slider or two text boxes.
    """

@abstractmethod
def set_colormap(self, cmap: cmap.Colormap) -> None:
    """Set the colormap to `cmap`.

    Usually corresponds to a dropdown menu.
    """

def set_gamma(self, gamma: float) -> None:
    """Set the gamma value of the LUT."""
    return None

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""

@abstractmethod
def close(self) -> None:
    """Close the view/widget."""

@abstractmethod
def frontend_widget(self) -> Any:
    """Return the native object backing the viewable objects."""

@abstractmethod
def set_visible(self, visible: bool) -> None:
    """Sets the visibility of the view/widget itself."""