Commitbbbe173

authored

Merge pull request#128 from dstansby/selection-api

Clean up layer selection API

2 parents20bc846 +edef35c commitbbbe173Copy full SHA for bbbe173

File tree

5 files changed

+20

-10

lines changed

docs
- changelog.rst
src/napari_matplotlib

5 files changed

+20

-10

lines changed

`‎docs/changelog.rst`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ Changes`
`23`	`23`	`you would be interested in please open an issue at https://github.com/matplotlib/napari-matplotlib.`
`24`	`24`	`- Labels plotting with the features scatter widget no longer have underscores`
`25`	`25`	`replaced with spaces.`
	`26`	+- ``NapariMPLWidget.update_layers()`` has been removed as it is intended to be
	`27`	+ private API. Use `NapariMPLWidget.on_update_layers` instead to implement
	`28`	`+ funcitonality when layer selection is changed.`
`26`	`29`
`27`	`30`	`Bug fixes`
`28`	`31`	`~~~~~~~~~`

`‎src/napari_matplotlib/base.py`

Lines changed: 13 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,12 @@ class NapariMPLWidget(MPLWidget):`
`108`	`108`	`is changed in the napari viewer. To take advantage of this sub-classes`
`109`	`109`	should implement the ``clear()`` and ``draw()`` methods.
`110`	`110`
	`111`	+ When both the z-step and layer selection is changed, ``clear()`` is called
	`112`	`+ and if the number a type of selected layers are valid for the widget`
	`113`	+ ``draw()`` is then called. When layer selection is changed ``on_update_layers()``
	`114`	`+ is also called, which can be useful e.g. for updating a layer list in a`
	`115`	`+ selection widget.`
	`116`	`+`
`111`	`117`	`Attributes`
`112`	`118`	`----------`
`113`	`119`	viewer : `napari.Viewer`
`@@ -157,14 +163,16 @@ def _setup_callbacks(self) -> None:`
`157`	`163`	`# z-step changed in viewer`
`158`	`164`	`self.viewer.dims.events.current_step.connect(self._draw)`
`159`	`165`	`# Layer selection changed in viewer`
`160`		`-self.viewer.layers.selection.events.changed.connect(self.update_layers)`
	`166`	`+self.viewer.layers.selection.events.changed.connect(`
	`167`	`+self._update_layers`
	`168`	`+ )`
`161`	`169`
`162`		`-defupdate_layers(self,event:napari.utils.events.Event)->None:`
	`170`	`+def_update_layers(self,event:napari.utils.events.Event)->None:`
`163`	`171`	`"""`
`164`	`172`	Update the ``layers`` attribute with currently selected layers and re-draw.
`165`	`173`	`"""`
`166`	`174`	`self.layers=list(self.viewer.layers.selection)`
`167`		`-self._on_update_layers()`
	`175`	`+self.on_update_layers()`
`168`	`176`	`self._draw()`
`169`	`177`
`170`	`178`	`def_draw(self)->None:`
`@@ -193,10 +201,9 @@ def draw(self) -> None:`
`193`	`201`	`This is a no-op, and is intended for derived classes to override.`
`194`	`202`	`"""`
`195`	`203`
`196`		`-def_on_update_layers(self)->None:`
	`204`	`+defon_update_layers(self)->None:`
`197`	`205`	`"""`
`198`		`- Function is called when self.layers is updated via`
`199`		- ``self.update_layers()``.
	`206`	`+ Called when the selected layers are updated.`
`200`	`207`
`201`	`208`	`This is a no-op, and is intended for derived classes to override.`
`202`	`209`	`"""`

`‎src/napari_matplotlib/histogram.py`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ def __init__(`
`27`	`27`	`):`
`28`	`28`	`super().__init__(napari_viewer,parent=parent)`
`29`	`29`	`self.add_single_axes()`
`30`		`-self.update_layers(None)`
	`30`	`+self._update_layers(None)`
`31`	`31`
`32`	`32`	`defclear(self)->None:`
`33`	`33`	`"""`

`‎src/napari_matplotlib/scatter.py`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ def __init__(`
`132`	`132`	`self.layout().addWidget(QLabel(f"{dim}-axis:"))`
`133`	`133`	`self.layout().addWidget(self._selectors[dim])`
`134`	`134`
`135`		`-self.update_layers(None)`
	`135`	`+self._update_layers(None)`
`136`	`136`
`137`	`137`	`@property`
`138`	`138`	`defx_axis_key(self)->Union[str,None]:`
`@@ -230,7 +230,7 @@ def _get_data(self) -> Tuple[npt.NDArray[Any], npt.NDArray[Any], str, str]:`
`230`	`230`
`231`	`231`	`returnx,y,x_axis_name,y_axis_name`
`232`	`232`
`233`		`-def_on_update_layers(self)->None:`
	`233`	`+defon_update_layers(self)->None:`
`234`	`234`	`"""`
`235`	`235`	Called when the layer selection changes by ``self.update_layers()``.
`236`	`236`	`"""`

`‎src/napari_matplotlib/slice.py`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ def __init__(`
`51`	`51`	`fordin_dims_sel:`
`52`	`52`	`self.slice_selectors[d].textChanged.connect(self._draw)`
`53`	`53`
`54`		`-self.update_layers(None)`
	`54`	`+self._update_layers(None)`
`55`	`55`
`56`	`56`	`@property`
`57`	`57`	`def_layer(self)->napari.layers.Layer:`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitbbbe173

File tree

5 files changed

5 files changed

`‎docs/changelog.rst`

`‎src/napari_matplotlib/base.py`

`‎src/napari_matplotlib/histogram.py`

`‎src/napari_matplotlib/scatter.py`

`‎src/napari_matplotlib/slice.py`

0 commit comments