Skip to content

Latest commit

 

History

History
78 lines (46 loc) · 1.62 KB

api.rst

File metadata and controls

78 lines (46 loc) · 1.62 KB
Raw

App reference

Functions related to the event loop

.. autofunction:: flexx.app.start


.. autofunction:: flexx.app.run


.. autofunction:: flexx.app.stop


.. autofunction:: flexx.app.init_notebook


.. autofunction:: flexx.app.create_server


.. autofunction:: flexx.app.current_server

Wrapping a Component into an Application

.. autoclass:: flexx.app.App
    :members:


.. autofunction:: flexx.app.serve


.. autofunction:: flexx.app.launch


.. autofunction:: flexx.app.export

The Component classes

.. autoclass:: flexx.app.BaseAppComponent
    :members:


.. autoclass:: flexx.app.PyComponent
    :members:


.. autoclass:: flexx.app.JsComponent
    :members:


.. autoclass:: flexx.app.StubComponent
    :members:


.. autofunction:: flexx.app.get_component_classes



.. autoclass:: flexx.app.LocalProperty
    :members:

Session and Assets

An asset is represented using an Asset object that defines its sources, dependencies, etc. Assets can be specific to the session or shared across sessions. The AssetStore provides all shared assets for clients connected to the current process. The global store is at flexx.app.assets. The session object handles the connection between Python and JavaScript, and it allows adding client-side assets, which for instance makes it easy to create extensions based on existing JS libraries.

.. autoclass:: flexx.app.Asset
    :members:



.. autoclass:: flexx.app._assetstore.AssetStore
    :members:


.. autoclass:: flexx.app.Session
    :inherited-members:
    :members: