httk.serve.web.widgets.optimade_table
=====================================

.. py:module:: httk.serve.web.widgets.optimade_table

.. autoapi-nested-parse::

   The HTML/configuration boundary for the browser-driven OPTIMADE table.



Attributes
----------

.. autoapisummary::

   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_URL_CHARS
   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_IDENTIFIER_CHARS
   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_TEXT_CHARS
   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_LABEL_CHARS
   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_ORIGINS
   httk.serve.web.widgets.optimade_table.MAX_OPTIMADE_COLUMNS


Exceptions
----------

.. autoapisummary::

   httk.serve.web.widgets.optimade_table.OptimadeTableProtocolError


Functions
---------

.. autoapisummary::

   httk.serve.web.widgets.optimade_table.render


Module Contents
---------------

.. py:data:: MAX_OPTIMADE_URL_CHARS
   :value: 2048


.. py:data:: MAX_OPTIMADE_IDENTIFIER_CHARS
   :value: 128


.. py:data:: MAX_OPTIMADE_TEXT_CHARS
   :value: 4096


.. py:data:: MAX_OPTIMADE_LABEL_CHARS
   :value: 256


.. py:data:: MAX_OPTIMADE_ORIGINS
   :value: 16


.. py:data:: MAX_OPTIMADE_COLUMNS
   :value: 32


.. py:exception:: OptimadeTableProtocolError

   Bases: :py:obj:`ValueError`


   A declared OPTIMADE table shell cannot meet the browser protocol.


.. py:function:: render(context: httk.serve.web.widgets.core.WidgetContext, *, base_url: str, entry_type: str = 'structures', columns: object, page_size: int = 50, caption: str = 'OPTIMADE results', filter: str | None = None, filter_query: str | None = None, sort: str | None = None, allowed_origins: tuple[str, Ellipsis] = (), detail_route: str | None = None, detail_column: str | None = None, detail_query: str = 'id') -> httk.serve.web.widgets.core.WidgetRenderResult

   Render an inert, accessible OPTIMADE table shell and its trusted assets.