Skip to content

more event docs, make some things public #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 70 commits into from
Apr 7, 2025
Merged

more event docs, make some things public #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
50cf305
more docs on events
kushalkolar Mar 17, 2025
b07c4d3
add some events examples
kushalkolar Mar 24, 2025
ac98b83
make features public
kushalkolar Mar 24, 2025
bdd40ad
make subplot public
kushalkolar Mar 24, 2025
f5d0981
update w.r.t. feature being public
kushalkolar Mar 24, 2025
d2c3514
update tables
kushalkolar Mar 24, 2025
bd78247
update generate_api.py
kushalkolar Mar 24, 2025
e008c87
update guide
kushalkolar Mar 24, 2025
9ffba55
rename: FeatureEvent -> PropertyEvent
kushalkolar Mar 24, 2025
8919c59
expose Graphic
kushalkolar Mar 24, 2025
4d26b67
update legend
kushalkolar Mar 24, 2025
9999a56
tests, rename: FeatureEvent -> PropertyEvent
kushalkolar Mar 24, 2025
d6184e0
edit
kushalkolar Mar 24, 2025
8a0baa2
update
kushalkolar Mar 24, 2025
e9cae50
deleted: events_more.rst
kushalkolar Mar 24, 2025
58325f7
Lingering _featuees
kushalkolar Mar 24, 2025
adf096d
rename in api docs
kushalkolar Mar 25, 2025
f7433a6
rename
kushalkolar Mar 25, 2025
6911606
more examples
kushalkolar Mar 26, 2025
1451d14
update, and key event example
kushalkolar Mar 26, 2025
deb9411
black
kushalkolar Mar 26, 2025
d85028a
type annotations for event instances in examples
kushalkolar Mar 26, 2025
9e83f84
update faq
kushalkolar Mar 26, 2025
d0b86cb
add hover example
kushalkolar Mar 27, 2025
0225f15
Update examples
kushalkolar Mar 27, 2025
a0b24f2
add example
kushalkolar Mar 27, 2025
4ae7a4d
add drag example
kushalkolar Mar 27, 2025
0c20e73
update exmpales
kushalkolar Mar 27, 2025
1c9b74d
fix get_nearest
kushalkolar Mar 27, 2025
b3c14fb
update utils for docs
kushalkolar Mar 27, 2025
841a0ab
update doc
kushalkolar Mar 27, 2025
48202f0
fix
kushalkolar Mar 27, 2025
e8ad960
black
kushalkolar Mar 27, 2025
500704c
update drag_points
kushalkolar Mar 27, 2025
ab5f3c7
update
kushalkolar Mar 27, 2025
c2bd6bb
fix
kushalkolar Mar 27, 2025
3796c20
update
kushalkolar Mar 27, 2025
f43dcbe
better LinearRegionSelector example, fix calc center
kushalkolar Mar 29, 2025
1391103
add moving label example
kushalkolar Mar 31, 2025
8b113e3
add to conf
kushalkolar Mar 31, 2025
a109879
add readme
kushalkolar Mar 31, 2025
a52595d
update docs conf.py
kushalkolar Mar 31, 2025
d5c57ff
add paint_image example
kushalkolar Mar 31, 2025
15f0585
add controller examples
kushalkolar Mar 31, 2025
389fcff
fix
kushalkolar Mar 31, 2025
5b342e9
ipywidget example, update guide
kushalkolar Mar 31, 2025
9d9357e
update iw rgb arg
kushalkolar Mar 31, 2025
c6a13f1
add ipywidgets webp to guide
kushalkolar Mar 31, 2025
c0f8cb3
update linear_region_selectors_match_offsets.png after fix
kushalkolar Mar 31, 2025
ac8b95b
forgot to add non imgui screenshot
kushalkolar Mar 31, 2025
0d61ef3
update ipywidget examples
kushalkolar Apr 1, 2025
e53eb7f
docstring
kushalkolar Apr 1, 2025
543a028
plot helpers API docs should work now
kushalkolar Apr 1, 2025
8ce37f2
update switcher
kushalkolar Apr 1, 2025
df265e2
update switcher
kushalkolar Apr 1, 2025
e31a684
docstring
kushalkolar Apr 1, 2025
aab160d
start turning event tables to list of dicts instead of hard-coded rst…
kushalkolar Apr 1, 2025
b1efab1
update common features with table spec
kushalkolar Apr 1, 2025
bcdebc6
spelling
kushalkolar Apr 1, 2025
c0bb9b8
add code for list of dicts -> rst table, not yet tested
kushalkolar Apr 1, 2025
94bc92e
needs to be writeable
kushalkolar Apr 1, 2025
cc2b8da
replace == with npt.assert_almost_equal()
kushalkolar Apr 1, 2025
2bdf170
rename FeatureEvent -> GraphicFeatureEvent
kushalkolar Apr 7, 2025
1b80f29
GraphicFeatureEvent as top level import
kushalkolar Apr 7, 2025
1911eed
black
kushalkolar Apr 7, 2025
cd6f58c
graphic feature event tables
kushalkolar Apr 7, 2025
2c7bd84
stupid
kushalkolar Apr 7, 2025
fcf58f5
forgot to add things
kushalkolar Apr 7, 2025
9db6a5d
remove space
kushalkolar Apr 7, 2025
0fbaf42
black
kushalkolar Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/_static/guide_ipywidgets.webp
View file
Open in desktop
Binary file not shown.
17 changes: 16 additions & 1 deletion docs/source/_static/switcher.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
[
{
"name": "release",
"version": "v0.4.0",
"url": "http://www.fastplotlib.org/"
},
{
"name": "dev/main",
"version": "dev",
"url": "http://www.fastplotlib.org/versions/dev"
"url": "http://www.fastplotlib.org/ver/dev"
},
{
"name": "v0.3.0",
"version": "v0.3.0",
"url": "http://www.fastplotlib.org/ver/0.3.0"
},
{
"name": "v0.4.0",
"version": "v0.4.0",
"url": "http://www.fastplotlib.org/ver/0.4.0"
}
]
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Deleted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Deleted
=======
Deleted
=======
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/FontSize.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ FontSize
========
FontSize
========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
38 changes: 38 additions & 0 deletions docs/source/api/graphic_features/GraphicFeatureEvent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. _api.GraphicFeatureEvent:

GraphicFeatureEvent
*******************

===================
GraphicFeatureEvent
===================
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeatureEvent_api

GraphicFeatureEvent

Properties
~~~~~~~~~~
.. autosummary::
:toctree: GraphicFeatureEvent_api

GraphicFeatureEvent.bubbles
GraphicFeatureEvent.cancelled
GraphicFeatureEvent.current_target
GraphicFeatureEvent.root
GraphicFeatureEvent.target
GraphicFeatureEvent.time_stamp
GraphicFeatureEvent.type

Methods
~~~~~~~
.. autosummary::
:toctree: GraphicFeatureEvent_api

GraphicFeatureEvent.cancel
GraphicFeatureEvent.stop_propagation

2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/ImageCmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ImageCmap
=========
ImageCmap
=========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/ImageCmapInterpolation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ImageCmapInterpolation
======================
ImageCmapInterpolation
======================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/ImageInterpolation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ImageInterpolation
==================
ImageInterpolation
==================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/ImageVmax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ImageVmax
=========
ImageVmax
=========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/ImageVmin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ImageVmin
=========
ImageVmin
=========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/LinearRegionSelectionFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LinearRegionSelectionFeature
============================
LinearRegionSelectionFeature
============================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/LinearSelectionFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LinearSelectionFeature
======================
LinearSelectionFeature
======================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Name.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name
====
Name
====
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Offset.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Offset
======
Offset
======
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/PointsSizesFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ PointsSizesFeature
==================
PointsSizesFeature
==================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/RectangleSelectionFeature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ RectangleSelectionFeature
=========================
RectangleSelectionFeature
=========================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Rotation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Rotation
========
Rotation
========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/SizeSpace.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SizeSpace
=========
SizeSpace
=========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/TextData.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TextData
========
TextData
========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/TextFaceColor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TextFaceColor
=============
TextFaceColor
=============
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/TextOutlineColor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TextOutlineColor
================
TextOutlineColor
================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/TextOutlineThickness.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TextOutlineThickness
====================
TextOutlineThickness
====================
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/TextureArray.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TextureArray
============
TextureArray
============
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Thickness.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Thickness
=========
Thickness
=========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/UniformColor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ UniformColor
============
UniformColor
============
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/UniformSize.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ UniformSize
===========
UniformSize
===========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/VertexCmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ VertexCmap
==========
VertexCmap
==========
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/VertexColors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ VertexColors
============
VertexColors
============
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/VertexPositions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ VertexPositions
===============
VertexPositions
===============
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/graphic_features/Visible.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Visible
=======
Visible
=======
.. currentmodule:: fastplotlib.graphics._features
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/graphic_features/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ Graphic Features
Rotation
Visible
Deleted
GraphicFeatureEvent
2 changes: 1 addition & 1 deletion docs/source/api/graphics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Graphics
:maxdepth: 1

LineGraphic
ImageGraphic
ScatterGraphic
ImageGraphic
TextGraphic
LineCollection
LineStack
4 changes: 4 additions & 0 deletions docs/source/api/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ fastplotlib.utils
.. currentmodule:: fastplotlib.utils
.. automodule:: fastplotlib.utils.functions
:members:

.. currentmodule:: fastplotlib.utils
.. automodule:: fastplotlib.utils._plot_helpers
:members:
4 changes: 4 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,16 @@
"../../examples/image_widget",
"../../examples/gridplot",
"../../examples/window_layouts",
"../../examples/controllers",
"../../examples/line",
"../../examples/line_collection",
"../../examples/scatter",
"../../examples/text",
"../../examples/events",
"../../examples/selection_tools",
"../../examples/machine_learning",
"../../examples/guis",
"../../examples/ipywidgets",
"../../examples/misc",
"../../examples/qt",
]
Expand Down
Loading
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy