holonote.app Package#
app
Package#
- class holonote.app.AnnotatorTable(annotator, **params)[source]#
Bases:
Viewer
annotator
= param.Parameter(allow_None=True, allow_refs=False, label=’Annotator’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d101390>)tabulator
= param.Parameter(allow_None=True, allow_refs=False, label=’Tabulator’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d101a10>)dataframe
= param.DataFrame(allow_None=True, allow_refs=False, class_=<class ‘pandas.core.frame.DataFrame’>, label=’Dataframe’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d1019d0>)tabulator_kwargs
= param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Tabulator kwargs’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d101b50>)kwargs to pass to tabulator
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) Viewable [source]#
Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
- Parameters:
title (str) – A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The Panel object itself
- show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) threading.Thread | 'Server' [source]#
Starts a Bokeh server and displays the Viewable in a new tab.
- Parameters:
title (str | None) – A string title to give the Document (if served as an app)
port (int (optional, default=0)) – Allows specifying a specific port
address (str) – The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) – A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded (boolean (optional, default=False)) – Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) – Whether to print the address and port
open (boolean (optional, default=True)) – Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
- Returns:
server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread
- class holonote.app.PanelWidgets(annotator: Annotator, field_values: dict[str, Any] | None = None, as_popup: bool = False, **params)[source]#
Bases:
Viewer
reset_on_apply
= param.Boolean(allow_refs=False, default=True, label=’Reset on apply’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d001a10>)Reset fields widgets on apply
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) Viewable [source]#
Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
- Parameters:
title (str) – A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The Panel object itself
- show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) threading.Thread | 'Server' [source]#
Starts a Bokeh server and displays the Viewable in a new tab.
- Parameters:
title (str | None) – A string title to give the Document (if served as an app)
port (int (optional, default=0)) – Allows specifying a specific port
address (str) – The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) – A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded (boolean (optional, default=False)) – Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) – Whether to print the address and port
open (boolean (optional, default=True)) – Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
- Returns:
server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread
panel
Module#
digraph inheritancee261014633 {
bgcolor=transparent;
fontsize=18;
rankdir=LR;
size="12.0, 12.0";
"holonote.app.panel.PanelWidgets" [URL="#holonote.app.panel.PanelWidgets",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
"panel.viewable.Viewer" -> "holonote.app.panel.PanelWidgets" [arrowsize=0.5,style="setlinewidth(0.5)"];
"panel.viewable.Viewer" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A baseclass for custom components that behave like a Panel object."];
"param.parameterized.Parameterized" -> "panel.viewable.Viewer" [arrowsize=0.5,style="setlinewidth(0.5)"];
"param.parameterized.Parameterized" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for named objects that support Parameters and message"];
}
- class holonote.app.panel.PanelWidgets(annotator: Annotator, field_values: dict[str, Any] | None = None, as_popup: bool = False, **params)[source]#
Bases:
Viewer
reset_on_apply
= param.Boolean(allow_refs=False, default=True, label=’Reset on apply’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908cb4b910>)Reset fields widgets on apply
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) Viewable [source]#
Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
- Parameters:
title (str) – A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The Panel object itself
- show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) threading.Thread | 'Server' [source]#
Starts a Bokeh server and displays the Viewable in a new tab.
- Parameters:
title (str | None) – A string title to give the Document (if served as an app)
port (int (optional, default=0)) – Allows specifying a specific port
address (str) – The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) – A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded (boolean (optional, default=False)) – Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) – Whether to print the address and port
open (boolean (optional, default=True)) – Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
- Returns:
server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread
tabulator
Module#
digraph inheritance733ff8682f {
bgcolor=transparent;
fontsize=18;
rankdir=LR;
size="12.0, 12.0";
"holonote.app.tabulator.AnnotatorTable" [URL="#holonote.app.tabulator.AnnotatorTable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
"panel.viewable.Viewer" -> "holonote.app.tabulator.AnnotatorTable" [arrowsize=0.5,style="setlinewidth(0.5)"];
"panel.viewable.Viewer" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A baseclass for custom components that behave like a Panel object."];
"param.parameterized.Parameterized" -> "panel.viewable.Viewer" [arrowsize=0.5,style="setlinewidth(0.5)"];
"param.parameterized.Parameterized" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for named objects that support Parameters and message"];
}
- class holonote.app.tabulator.AnnotatorTable(annotator, **params)[source]#
Bases:
Viewer
annotator
= param.Parameter(allow_None=True, allow_refs=False, label=’Annotator’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908d0153d0>)tabulator
= param.Parameter(allow_None=True, allow_refs=False, label=’Tabulator’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908cbe5ed0>)dataframe
= param.DataFrame(allow_None=True, allow_refs=False, class_=<class ‘pandas.core.frame.DataFrame’>, label=’Dataframe’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908cff4550>)tabulator_kwargs
= param.Dict(allow_refs=True, class_=<class ‘dict’>, default={}, label=’Tabulator kwargs’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x7f908cbe6050>)kwargs to pass to tabulator
- servable(title: str | None = None, location: bool | 'Location' = True, area: str = 'main', target: str | None = None) Viewable [source]#
Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
- Parameters:
title (str) – A string title to give the Document (if served as an app)
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.
target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.
- Return type:
The Panel object itself
- show(title: str | None = None, port: int = 0, address: str | None = None, websocket_origin: str | None = None, threaded: bool = False, verbose: bool = True, open: bool = True, location: bool | 'Location' = True, **kwargs) threading.Thread | 'Server' [source]#
Starts a Bokeh server and displays the Viewable in a new tab.
- Parameters:
title (str | None) – A string title to give the Document (if served as an app)
port (int (optional, default=0)) – Allows specifying a specific port
address (str) – The address the server should listen on for HTTP requests.
websocket_origin (str or list(str) (optional)) – A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.
threaded (boolean (optional, default=False)) – Whether to launch the Server on a separate thread, allowing interactive use.
verbose (boolean (optional, default=True)) – Whether to print the address and port
open (boolean (optional, default=True)) – Whether to open the server in a new browser tab
location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.
- Returns:
server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)
- Return type:
bokeh.server.Server or panel.io.server.StoppableThread