set_props

pick.set_props(n=None, consecutive_pick=None, pick_relative_to_closest=None, search_radius=None)

Set the picker-properties (number of picked points, max. search radius, etc.).

Only provided arguments will be updated!

Parameters:

  • n (int, optional) – The number of nearest neighbours to pick at each pick-event. The default is 1.

  • consecutive_pick (bool, optional) –

    • If True, pick-callbacks will be executed consecutively for each picked datapoint.

    • if False, pick-callbacks will get lists of all picked values as input-arguments

    The default is False.

  • pick_relative_to_closest (bool, optional) –

    ONLY relevant if n > 1.

    • If True: pick (n) nearest neighbours based on the center of the closest identified datapoint

    • If False: pick (n) nearest neighbours based on the click-position

    The default is True.

  • search_radius (int, float, str or None optional) –

    Set the radius of the area that is used to limit the number of pixels when searching for nearest-neighbours.

    • if int or float, the radius of the circle in units of the plot_crs

    • if str, a multiplication-factor for the estimated data-radius.

      NOTE: The multiplied radius is defined in the plot projection! If the data was provided in a different projection, the radius estimated from the re-projected data is used (might be different from the actual shape radius!)

    The default is β€œ50” (e.g. 50 times the data-radius).