docstrings

fastplotlib · kushalkolar · Feb 4, 2026 · Jan 13, 2026 · Jan 13, 2026 · Jan 13, 2026
commit 500426df70fbb895e21b21f7ffdecfbd04867112
@@ -20,7 +20,15 @@ class PositionsGraphic(Graphic):
 
     @property
     def data(self) -> VertexPositions:
-        """Get or set the graphic's data"""
+        """
+        Get or set the graphic's data.
+
+        Note that if the number of datapoints does not match the number of
+        current datapoints a new buffer is automatically allocated. This can
+        have performance drawbacks when you have a very large number of datapoints.
+        This is usually fine as long as you don't need to do it hundreds of times
+        per second.
+        """
         return self._data
 
     @data.setter

@@ -217,7 +217,15 @@ def _create_tiles(self) -> list[_ImageTile]:
 
     @property
     def data(self) -> TextureArray:
-        """Get or set the image data"""
+        """
+        Get or set the image data.
+
+        Note that if the shape of the new data array does not equal the shape of
+        current data array, a new set of GPU Textures are automatically created.
+        This can have performance drawbacks when you have a ver large images.
+        This is usually fine as long as you don't need to do it hundreds of times
+        per second.
+        """
         return self._data
 
     @data.setter

@@ -66,6 +66,14 @@ def __init__(
             overrides any argument passed to "colors". For supported colormaps see the
             ``cmap`` library catalogue: https://cmap-docs.readthedocs.io/en/stable/catalog/
 
+        color_mode: one of "auto", "uniform", "vertex", default "auto"
+            "uniform" restricts to a single color for all line datapoints.
+            "vertex" allows independent colors per vertex.
+            For most cases you can keep it as "auto" and the `color_mode` is determineed automatically based on the
+            argument passed to `colors`. if `colors` represents a single color, then the mode is set to "uniform".
+            If `colors` represents a unique color per-datapoint, or if a cmap is provided, then `color_mode` is set to
+            "vertex". You can switch between "uniform" and "vertex" `color_mode` after creating the graphic.
+
         cmap_transform: 1D array-like of numerical values, optional
             if provided, these values are used to map the colors from the cmap
 

@@ -169,6 +169,9 @@ def __init__(
         cmap_transform: 1D array-like of numerical values, optional
             if provided, these values are used to map the colors from the cmap
 
+        color_mode: one of "auto", "uniform", "vertex", default "auto"
+            The color mode for each line in the collection. See `color_mode` in :class:`.LineGraphic` for details.
+
         name: str, optional
             name of the line collection as a whole
 

@@ -80,6 +80,14 @@ def __init__(
         cmap_transform: 1D array-like or list of numerical values, optional
             if provided, these values are used to map the colors from the cmap
 
+        color_mode: one of "auto", "uniform", "vertex", default "auto"
+            "uniform" restricts to a single color for all line datapoints.
+            "vertex" allows independent colors per vertex.
+            For most cases you can keep it as "auto" and the `color_mode` is determineed automatically based on the
+            argument passed to `colors`. if `colors` represents a single color, then the mode is set to "uniform".
+            If `colors` represents a unique color per-datapoint, or if a cmap is provided, then `color_mode` is set to
+            "vertex". You can switch between "uniform" and "vertex" `color_mode` after creating the graphic.
+
         mode: one of: "markers", "simple", "gaussian", "image", default "markers"
             The scatter points mode, cannot be changed after the graphic has been created.