Skip to content

Commit be8e0c8

Browse files
kushalkolarkushalkolar
authored
more event docs, make some things public (#773)
* more docs on events * add some events examples * make features public * make subplot public * update w.r.t. feature being public * update tables * update generate_api.py * update guide * rename: FeatureEvent -> PropertyEvent * expose Graphic * update legend * tests, rename: FeatureEvent -> PropertyEvent * edit * update * deleted: events_more.rst * Lingering _featuees * rename in api docs * rename * more examples * update, and key event example * black * type annotations for event instances in examples * update faq * add hover example * Update examples * add example * add drag example * update exmpales * fix get_nearest * update utils for docs * update doc * fix * black * update drag_points * update * fix * update * better LinearRegionSelector example, fix calc center * add moving label example * add to conf * add readme * update docs conf.py * add paint_image example * add controller examples * fix * ipywidget example, update guide * update iw rgb arg * add ipywidgets webp to guide * update linear_region_selectors_match_offsets.png after fix * forgot to add non imgui screenshot * update ipywidget examples * docstring * plot helpers API docs should work now * update switcher * update switcher * docstring * start turning event tables to list of dicts instead of hard-coded rst tables * update common features with table spec * spelling * add code for list of dicts -> rst table, not yet tested * needs to be writeable * replace == with npt.assert_almost_equal() * rename FeatureEvent -> GraphicFeatureEvent * GraphicFeatureEvent as top level import * black * graphic feature event tables * stupid * forgot to add things * remove space * black
1 parent 8ef6581 commit be8e0c8

File tree

97 files changed

+3058
-472
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+3058
-472
lines changed

‎docs/source/_static/guide_ipywidgets.webp‎

1.7 MB
Loading

‎docs/source/_static/switcher.json‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
[
2+
{
3+
"name": "release",
4+
"version": "v0.4.0",
5+
"url": "http://www.fastplotlib.org/"
6+
},
27
{
38
"name": "dev/main",
49
"version": "dev",
5-
"url": "http://www.fastplotlib.org/versions/dev"
10+
"url": "http://www.fastplotlib.org/ver/dev"
11+
},
12+
{
13+
"name": "v0.3.0",
14+
"version": "v0.3.0",
15+
"url": "http://www.fastplotlib.org/ver/0.3.0"
16+
},
17+
{
18+
"name": "v0.4.0",
19+
"version": "v0.4.0",
20+
"url": "http://www.fastplotlib.org/ver/0.4.0"
621
}
722
]

‎docs/source/api/graphic_features/Deleted.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Deleted
66
=======
77
Deleted
88
=======
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/FontSize.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FontSize
66
========
77
FontSize
88
========
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/GraphicFeatureEvent.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _api.GraphicFeatureEvent:
2+
3+
GraphicFeatureEvent
4+
*******************
5+
6+
===================
7+
GraphicFeatureEvent
8+
===================
9+
.. currentmodule:: fastplotlib.graphics.features
10+
11+
Constructor
12+
~~~~~~~~~~~
13+
.. autosummary::
14+
:toctree: GraphicFeatureEvent_api
15+
16+
GraphicFeatureEvent
17+
18+
Properties
19+
~~~~~~~~~~
20+
.. autosummary::
21+
:toctree: GraphicFeatureEvent_api
22+
23+
GraphicFeatureEvent.bubbles
24+
GraphicFeatureEvent.cancelled
25+
GraphicFeatureEvent.current_target
26+
GraphicFeatureEvent.root
27+
GraphicFeatureEvent.target
28+
GraphicFeatureEvent.time_stamp
29+
GraphicFeatureEvent.type
30+
31+
Methods
32+
~~~~~~~
33+
.. autosummary::
34+
:toctree: GraphicFeatureEvent_api
35+
36+
GraphicFeatureEvent.cancel
37+
GraphicFeatureEvent.stop_propagation
38+

‎docs/source/api/graphic_features/ImageCmap.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ImageCmap
66
=========
77
ImageCmap
88
=========
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/ImageCmapInterpolation.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ImageCmapInterpolation
66
======================
77
ImageCmapInterpolation
88
======================
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/ImageInterpolation.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ImageInterpolation
66
==================
77
ImageInterpolation
88
==================
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/ImageVmax.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ImageVmax
66
=========
77
ImageVmax
88
=========
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

‎docs/source/api/graphic_features/ImageVmin.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ImageVmin
66
=========
77
ImageVmin
88
=========
9-
.. currentmodule:: fastplotlib.graphics._features
9+
.. currentmodule:: fastplotlib.graphics.features
1010

1111
Constructor
1212
~~~~~~~~~~~

0 commit comments

Comments
 (0)