Reference

Config

Config provides high-level configuration options for the

Variable

Variable components declare values that can be referenced from other components.

Constant type: constant

Constant declares a constant value that can be referenced.

variable/Constant.html

EnvVariable type: env

EnvVariable fetches an environment variable that can be referenced.

variable/EnvVariable.html

Widget type: widget

Widget variables dynamically reflect the current widget value.

variable/Widget.html

Parameter type: param

Parameter variables reflect the current value of a parameter.

variable/Parameter.html

URLQuery type: url

URLQuery variables reflect the value of a URL query parameter.

variable/URLQuery.html

Cookie type: cookie

Cookie variables reflect the value of a cookie in the request.

variable/Cookie.html

UserInfo type: user

UserInfo variables reflect a value in the user info returned by an OAuth provider.

variable/UserInfo.html

Header type: header

Header variables reflect the value of a request header.

variable/Header.html

Pipeline

Pipeline encapsulates filters and transformations applied to a

Source

Source components provide allow querying all kinds of data.

RESTSource type: rest

RESTSource allows querying REST endpoints conforming to the Lumen REST specification.

source/RESTSource.html

FileSource type: file

FileSource loads CSV, Excel and Parquet files using pandas and dask read_* functions.

source/FileSource.html

WebsiteSource type: live

WebsiteSource queries whether a website responds with a 400 status code.

source/WebsiteSource.html

PanelSessionSource type: session_info

PanelSessionSource queries the session_info endpoint of a Panel application.

source/PanelSessionSource.html

JoinedSource type: join

JoinedSource performs a join on tables from one or more sources.

source/JoinedSource.html

DerivedSource type: derived

DerivedSource applies filtering and transforms to tables from other sources.

source/DerivedSource.html

JSONSource type: json

The JSONSource is very similar to the FileSource but loads json files.

source/JSONSource.html

IntakeSource type: intake

An IntakeSource loads data from an Intake catalog.

source/IntakeSource.html

IntakeSQLSource type: intake_sql

IntakeSQLSource extends the IntakeSource with support for SQL data.

source/IntakeSQLSource.html

Filter

Filter components supply the filter values used by Source components to query data. .

ConstantFilter type: constant

The ConstantFilter allows requesting a constant value from the

filter/ConstantFilter.html

FacetFilter type: facet

The FacetFilter allows faceting the data along some dimension to

filter/FacetFilter.html

ParamFilter type: param

ParamFilter reflects the value of a parameter declared on a View.

filter/ParamFilter.html

WidgetFilter type: widget

WidgetFilter generates a Widget from the table schema provided by a Source.

filter/WidgetFilter.html

BinFilter type: bins

BinFilter is a special WidgetFilter that allows selecting from a set of bins.

filter/BinFilter.html

DateFilter type: date

DateFilter is a WidgetFilter specialized to select calendar dates.

filter/DateFilter.html

DatetimeFilter type: datetime

DatetimeFilter is a WidgetFilter specialized to filter by datetimes.

filter/DatetimeFilter.html

Transform

Transform components implement transforms of DataFrame objects.

Filter type: None

Filter transform implement the filtering behavior of Filter components.

transform/Filter.html

HistoryTransform type: history

HistoryTransform accumulates a history of the queried data.

transform/HistoryTransform.html

Aggregate type: aggregate

Aggregate one or more columns or indexes, see pandas.DataFrame.groupby.

transform/Aggregate.html

Sort type: sort

Sort on one or more columns, see pandas.DataFrame.sort_values.

transform/Sort.html

Query type: query

Query applies the pandas.DataFrame.query method.

transform/Query.html

Columns type: columns

Columns selects a subset of columns.

transform/Columns.html

Astype type: as_type

Astype transforms the type of one or more columns.

transform/Astype.html

Stack type: stack

Stack applies pandas.DataFrame.stack to the declared level.

transform/Stack.html

Unstack type: unstack

Unstack applies pandas.DataFrame.unstack to the declared level.

transform/Unstack.html

Iloc type: iloc

Iloc allows selecting the data with integer indexing, see pandas.DataFrame.iloc.

transform/Iloc.html

Sample type: sample

Sample returns a random sample of items.

transform/Sample.html

Compute type: compute

Compute turns a dask.dataframe.DataFrame into a pandas.DataFrame.

transform/Compute.html

Pivot type: pivot

Pivot applies pandas.DataFrame.pivot given an index, columns, and values.

transform/Pivot.html

Melt type: melt

Melt applies the pandas.melt operation given the id_vars and value_vars.

transform/Melt.html

SetIndex type: set_index

SetIndex promotes DataFrame columns to indexes, see pandas.DataFrame.set_index.

transform/SetIndex.html

ResetIndex type: reset_index

ResetIndex resets DataFrame indexes to columns or drops them, see pandas.DataFrame.reset_index

transform/ResetIndex.html

Rename type: rename

Rename renames columns or indexes, see pandas.DataFrame.rename.

transform/Rename.html

RenameAxis type: rename_axis

Set the name of the axis for the index or columns,

transform/RenameAxis.html

Count type: count

Counts non-nan values in each column of the DataFrame and returns

transform/Count.html

Sum type: sum

Sums numeric values in each column of the DataFrame and returns a

transform/Sum.html

Eval type: eval

Applies an eval assignment expression to a DataFrame. The

transform/Eval.html

DropNA type: dropna

DropNA drops rows with any missing values.

transform/DropNA.html

project_lnglat type: project_lnglat

project_lnglat projects the given longitude/latitude columns to Web Mercator.

transform/project_lnglat.html

SQLGroupBy type: sql_group_by

Performs a Group-By and aggregation

transform/SQLGroupBy.html

SQLLimit type: sql_limit

Performs a LIMIT SQL operation on the query

transform/SQLLimit.html

SQLDistinct type: sql_distinct

SQLDistinct Transform

transform/SQLDistinct.html

SQLMinMax type: sql_minmax

SQLMinMax Transform

transform/SQLMinMax.html

SQLColumns type: sql_columns

SQLColumns Transform

transform/SQLColumns.html

SQLFilter type: sql_filter

Translates Lumen Filter query into a SQL WHERE statement.

transform/SQLFilter.html

View

View components provide a visual representation for the data returned

Panel type: panel

Panel views provide a way to declaratively wrap a Panel component.

view/Panel.html

StringView type: string

StringView renders the latest value of the field as a HTML string.

view/StringView.html

IndicatorView type: indicator

IndicatorView renders the latest field value as a Panel Indicator.

view/IndicatorView.html

hvOverlayView type: hv_overlay

hvOverlayView allows overlaying a list of layers consisting of

view/hvOverlayView.html

Table type: table

Table renders data using the powerful Panel Tabulator component.

view/Table.html

DownloadView type: download

DownloadView renders a button that allows downloading data as CSV, Excel, and parquet files.

view/DownloadView.html

PerspectiveView type: perspective

PerspectiveView renders data into a Perspective widget.

view/PerspectiveView.html

AltairView type: altair

AltairView provides a declarative way to render Altair charts.

view/AltairView.html

hvPlotUIView type: hvplot_ui

hvPlotUIView displays provides a component for exploring datasets interactively.

view/hvPlotUIView.html

hvPlotView type: hvplot

hvPlotView renders the queried data as a bokeh plot generated with hvPlot.

view/hvPlotView.html

Layout

Layout renders one or more :class:lumen.views.base.View components

Auth

An AuthPlugin is given the auth specfication and can apply arbitrary

Auth type: None

An AuthPlugin is given the auth specfication and can apply arbitrary

auth/Auth.html

YamlAuthMapperPlugin type: yaml

The YamlAuthMapperPlugin uses a Yaml file to map auth keys

auth/YamlAuthMapperPlugin.html

Defaults

Defaults to apply to the component classes.