fastplotlib · kushalkolar · Nov 4, 2025 · Oct 21, 2025 · Oct 21, 2025 · Oct 21, 2025
@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/sg_execution_times.rst
 
 # PyBuilder
 target/
@@ -134,5 +135,6 @@ dmypy.json
 # vs code
 .vscode/
 
+# diffs from visual regression tests
 examples/desktop/diffs/*.png
 docs/source/_gallery/
@@ -0,0 +1,35 @@
+.. _api.VectorDirections:
+
+VectorDirections
+****************
+
+================
+VectorDirections
+================
+.. currentmodule:: fastplotlib.graphics.features
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorDirections_api
+
+    VectorDirections
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorDirections_api
+
+    VectorDirections.value
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: VectorDirections_api
+
+    VectorDirections.add_event_handler
+    VectorDirections.block_events
+    VectorDirections.clear_event_handlers
+    VectorDirections.remove_event_handler
+    VectorDirections.set_value
+
@@ -0,0 +1,35 @@
+.. _api.VectorPositions:
+
+VectorPositions
+***************
+
+===============
+VectorPositions
+===============
+.. currentmodule:: fastplotlib.graphics.features
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorPositions_api
+
+    VectorPositions
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorPositions_api
+
+    VectorPositions.value
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: VectorPositions_api
+
+    VectorPositions.add_event_handler
+    VectorPositions.block_events
+    VectorPositions.clear_event_handlers
+    VectorPositions.remove_event_handler
+    VectorPositions.set_value
+
@@ -32,6 +32,8 @@ Graphic Features
     VolumeIsoEmissive
     VolumeIsoShininess
     VolumeSlicePlane
+    VectorPositions
+    VectorDirections
     TextData
     FontSize
     TextFaceColor

@@ -0,0 +1,49 @@
+.. _api.VectorsGraphic:
+
+VectorsGraphic
+**************
+
+==============
+VectorsGraphic
+==============
+.. currentmodule:: fastplotlib
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorsGraphic_api
+
+    VectorsGraphic
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: VectorsGraphic_api
+
+    VectorsGraphic.alpha
+    VectorsGraphic.alpha_mode
+    VectorsGraphic.axes
+    VectorsGraphic.block_events
+    VectorsGraphic.deleted
+    VectorsGraphic.directions
+    VectorsGraphic.event_handlers
+    VectorsGraphic.name
+    VectorsGraphic.offset
+    VectorsGraphic.positions
+    VectorsGraphic.right_click_menu
+    VectorsGraphic.rotation
+    VectorsGraphic.supported_events
+    VectorsGraphic.visible
+    VectorsGraphic.world_object
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: VectorsGraphic_api
+
+    VectorsGraphic.add_axes
+    VectorsGraphic.add_event_handler
+    VectorsGraphic.clear_event_handlers
+    VectorsGraphic.remove_event_handler
+    VectorsGraphic.rotate
+
@@ -9,6 +9,7 @@ Graphics
     ScatterGraphic
     ImageGraphic
     ImageVolumeGraphic
+    VectorsGraphic
     TextGraphic
     LineCollection
     LineStack
@@ -54,6 +54,7 @@ Methods
     Subplot.add_line_stack
     Subplot.add_scatter
     Subplot.add_text
+    Subplot.add_vectors
     Subplot.auto_scale
     Subplot.center_graphic
     Subplot.center_scene

@@ -66,6 +66,7 @@
             "../../examples/line",
             "../../examples/line_collection",
             "../../examples/scatter",
+            "../../examples/vectors",
             "../../examples/text",
             "../../examples/events",
             "../../examples/selection_tools",

@@ -795,6 +795,108 @@ deleted
 | value    | bool | True when graphic was deleted |
 +----------+------+-------------------------------+
 
+VectorsGraphic
+--------------
+
+positions
+^^^^^^^^^
+
+**event info dict**
+
++----------+------------+----------------------+
+| dict key | type       | description          |
++==========+============+======================+
+| value    | np.ndarray | new vector positions |
++----------+------------+----------------------+
+
+directions
+^^^^^^^^^^
+
+**event info dict**
+
++----------+------------+-----------------------+
+| dict key | type       | description           |
++==========+============+=======================+
+| value    | np.ndarray | new vector directions |
++----------+------------+-----------------------+
+
+name
+^^^^
+
+**event info dict**
+
++----------+------+--------------------+
+| dict key | type | description        |
++==========+======+====================+
+| value    | str  | user provided name |
++----------+------+--------------------+
+
+offset
+^^^^^^
+
+**event info dict**
+
++----------+---------------------------------+----------------------+
+| dict key | type                            | description          |
++==========+=================================+======================+
+| value    | np.ndarray[float, float, float] | new offset (x, y, z) |
++----------+---------------------------------+----------------------+
+
+rotation
+^^^^^^^^
+
+**event info dict**
+
++----------+----------------------------------------+-------------------------+
+| dict key | type                                   | description             |
++==========+========================================+=========================+
+| value    | np.ndarray[float, float, float, float] | new rotation quaternion |
++----------+----------------------------------------+-------------------------+
+
+alpha
+^^^^^
+
+**event info dict**
+
++----------+-------+-----------------+
+| dict key | type  | description     |
++==========+=======+=================+
+| value    | float | new alpha value |
++----------+-------+-----------------+
+
+alpha_mode
+^^^^^^^^^^
+
+**event info dict**
+
++----------+------+----------------+
+| dict key | type | description    |
++==========+======+================+
+| value    | str  | new alpha mode |
++----------+------+----------------+
+
+visible
+^^^^^^^
+
+**event info dict**
+
++----------+------+---------------------+
+| dict key | type | description         |
++==========+======+=====================+
+| value    | bool | new visibility bool |
++----------+------+---------------------+
+
+deleted
+^^^^^^^
+
+**event info dict**
+
++----------+------+-------------------------------+
+| dict key | type | description                   |
++==========+======+===============================+
+| value    | bool | True when graphic was deleted |
++----------+------+-------------------------------+
+
 TextGraphic
 -----------
 

@@ -5,8 +5,9 @@
 Example with multi-channel volume images. Use alpha_mode "add" for additive blending.
 """
 
-# test_example = true
-# sphinx_gallery_pygfx_docs = 'screenshot'
+# test_example = false
+# run_example = false
+# sphinx_gallery_pygfx_docs = 'code'
 
 import fastplotlib as fpl
 from ome_zarr.io import parse_url
@@ -18,10 +19,8 @@
 
 # read the image data
 reader = Reader(parse_url(url))
-# nodes may include images, labels etc
-nodes = list(reader())
-# first node will be the image pixel data
-image_node = nodes[0]
+# first node is image data
+image_node = next(reader())
 
 dask_data = image_node.data
 

@@ -24,6 +24,7 @@
     "scatter/*.py",
     "line/*.py",
     "line_collection/*.py",
+    "vectors/*.py"
     "gridplot/*.py",
     "window_layouts/*.py",
     "events/*.py",

@@ -0,0 +1,2 @@
+Vector Examples
+===============