Module datapane.client.api.report.core

Datapane Reports Object

Describes the Report object

Classes

class App (*arg_blocks: Union[ForwardRef('Page'), ForwardRef('Group'), ForwardRef('Select'), ForwardRef('DataBlock'), ForwardRef('Empty'), Any], blocks: List[Union[ForwardRef('Page'), ForwardRef('Group'), ForwardRef('Select'), ForwardRef('DataBlock'), ForwardRef('Empty'), Any]] = None, layout: Optional[datapane.client.api.report.core.PageLayout] = None, **kwargs)

App documents collate plots, text, tables, and files into an interactive document that can be analysed and shared by users in their Browser

Args

*arg_blocks
Group to add to document
blocks
Allows providing the document blocks as a single list

Returns

A App document object that can be uploaded, saved, etc.

Tip: Blocks can be passed using either arg parameters or the blocks kwarg, e.g.

dp.App(plot, table) or dp.App(blocks=[plot, table])

Tip: Create a list first to hold your blocks to edit them dynamically, for instance when using Jupyter, and use the blocks parameter

Ancestors

Subclasses

  • datapane.client.api.report.core.Report

Class variables

var pages : List[Page]
var page_layout : Optional[datapane.client.api.report.core.PageLayout]
var list_fields : List[str]

Static methods

def get(name: str, project: Optional[str] = None) ‑> ~U

Inherited from: DPObjectRef.get

Lookup and retrieve an object from the Datapane Server by its name …

def by_id(id_or_url: str) ‑> ~U

Inherited from: DPObjectRef.by_id

Lookup and retrieve an object from the Datapane Server by its id …

def list() ‑> Iterable[Dict[str, Any]]

Inherited from: DPObjectRef.list

Returns: A list of the Datapane objects of this type that are owned by the user

Methods

def upload(self, name: str, description: str = '', source_url: str = '', publicly_visible: bool = False, tags: List[str] = None, project: Optional[str] = None, open: bool = False, formatting: Optional[datapane.client.api.report.core.AppFormatting] = None, overwrite: bool = False, **kwargs) ‑> None
def save(self, path: str, open: bool = False, standalone: bool = False, name: Optional[str] = None, author: Optional[str] = None, formatting: Optional[datapane.client.api.report.core.AppFormatting] = None, cdn_base: str = 'https://datapane-cdn.com/v0.15.4') ‑> None
def stringify(self, standalone: bool = False, name: Optional[str] = None, author: Optional[str] = None, formatting: Optional[datapane.client.api.report.core.AppFormatting] = None, cdn_base: str = 'https://datapane-cdn.com/v0.15.4', template_name: str = 'template.html') ‑> str
def refresh(self)

Inherited from: DPObjectRef.refresh

Refresh the object with the latest data from the Datapane Server - override to pull updated fields from dto to top-level

def delete(self)

Inherited from: DPObjectRef.delete

Delete the object on the server

class AppWidth (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Ancestors

  • enum.Enum

Class variables

var NARROW
var MEDIUM
var FULL