openflexure_microscope_server.things.gallery.GalleryThing

class documentation

class GalleryThing(lt.Thing): (source)

View In Hierarchy

A Thing for communicating with the front end gallery.

Method __enter__ Check for all gallery providing things on server startup.
Class Variable all_ofm_things Undocumented
Property gallery_providing_things All Things that provide data to the gallery.
Property list_data List the data from all registered things.
Method _set_gallery_providers Set the mapping of gallery providing things.
Instance Variable _gallery_providing_things Undocumented
def __enter__(self) -> Self: (source)

Check for all gallery providing things on server startup.

all_ofm_things: Mapping[str, OFMThing] = (source)

Undocumented

@property
gallery_providing_things: Mapping[str, GalleryCompatibleThing] = (source)

All Things that provide data to the gallery.

@lt.property
list_data: list[dict[str, Any]] = (source)

List the data from all registered things.

Currently only works with smart_scan as the UI cards are not customisable.

This will change to an action (or another type of endpoint) at a later date to enable filtering, and returning only a specific page.

def _set_gallery_providers(self): (source)

Set the mapping of gallery providing things.

This is called on __enter__ when the server starts.

_gallery_providing_things: Mapping[str, GalleryCompatibleThing] | None = (source)

Undocumented