_images/vois_horizontal_small.png

Reference manual

Setup

The vois library can be installed by executing: pip install vois

Packages

The vois library is grouped in these packages:

General package

Contains modules that define utilities functions and classes of

general use (geojson, maps, svg, etc.)

Vuetify package

Contains modules that define classes to simplify the creation of

GUI elements using ipyvuetify widgets

Geo package

Contains modules that enable the display of geospatial content on an

interactive Map

General package

The General package is made up of these modules:

colors

Utility functions and classes to manage colors and color interpolation.

download

Utility functions for downloading text and binary files

eucountries

Utility functions and classes to manage information on EU countries.

geojsonUtils

Utility functions to manage geospatial vector data in geojson format.

interMap

Utility functions for the creation of interactive maps using BDAP interactive library.

ipytrees

Utility functions for the creation ipytrees from hierarchical data.

leafletMap

Utility functions for the creation of interactive maps using ipyleaflet Map.

svgBarChart

SVG BarChart to display interactive vertical bars.

svgBubblesChart

SVG bubbles chart from a pandas DataFrame.

svgGraph

SVG visualization of a graph.

svgHeatmap

SVG heatmap chart from a pandas DataFrame.

svgMap

European map implemented in SVG.

svgPackedCirclesChart

SVG Packed Circles chart from a pandas DataFrame.

svgRankChart

SVG RankChart to display vertically aligned rectangles.

svgUtils

SVG drawings for general use.

textpopup

Map popup widget to display titles and texts in a geographic position on a ipyleaflet Map.

treemapPlotly

Utility functions to prepare data for Plotly Treemap, Sunburst and Icicle plots.

urlOpen

Utility functions to open a web page.

urlUpdate

Utility functions to update the URL of the page that launched the dashboard.

To use the modules of the General package they have to be imported using code like:

from vois import colors
print( colors.string2rgb('#ff00bb') )

Vuetify package

The Vuetify package is made up of these modules:

app

App class to easily define the structure of a typical Voilà dashboard.

basemaps

Widget to select the basemap to visualise on a ipyleaflet Map

Button

Button widget to call a python function when clicked.

card

Simple card with title, subtitle and image.

cardsGrid

Cards with title, subtitle and image displayed in rows and columns

ColorPicker

Input widget to select a color

datatable

Display of a Pandas DataFrame in a data-table widget.

DatePicker

Input widget to select a date

dayCalendar

Calendar widget showing days with events

dialogGeneric

Generic modal dialog-box to ask input from the user.

dialogMessage

Dialog-box to display a message for the user.

dialogWait

Dialog-box to display a message to the user during a lenghty operation.

dialogYesNo

Dialog-box to ask a yes-no question to the user.

fab

Floating-action-button to be displayed in absolute mode on the page.

fontsettings

Font settings for ipyvuetify widgets.

footer

Footer bar to be displayed at the bottom of a Voilà dashboard.

iconButton

Button displaying an icon.

IconClipboard

IconButton to copy text to the clipboard.

label

Label widget to display a text with an optional icon.

layers

Widget to manage the layers Table Of Content for a ipyleaflet Map

mainPage

Initial page for an application

menu

Menu widget opened on hover on a button.

multiSwitch

Widget to select independent options using a list of buttons displayed horizontally or vertically.

page

Fullscreen page

paletteEditor

Widget for the creation and editing of color palettes.

palettePicker

Selection of a palette of colors

palettePickerEx

Extended selection of a palette of different families (sequential, divergent, etc.)

popup

Popup window opened at hover on a button.

Progress

Circular progress bar to use for lenghty operations.

queryStrings

Read parameters passed in the URL of the Voila dashboard

Radio

Radio buttons to allow users to select from a predefined set of options.

rangeSlider

Slider to select a range of numeric values.

rangeSliderFloat

Widget to select a range of float values

selectImage

Select widget that displays images and enables for single selection.

selectMultiple

Multiple selection widget.

selectSingle

Single selection widget from a dropdown list.

settings

General settings for ipyvuetify widgets.

sidePanel

Side panel that opens on the side of the screen to show content or get user input.

sliderFloat

Widget to select a float value

snackbar

Widget to display a quick message to the user in an overlapping window that will disappear after a timeout

sortableList

Vertically aligned list of customizable cards with items that can be moved, added and removed.

svgsGrid

Display and selection of a list of SVG files

switch

The switch widget provides users the ability to choose between two distinct values.

tabs

Widget to select among alternative display using a list of tabs displayed horizontally or vertically.

textlist

Widget to display text strings vertically aligned.

title

Class that implements a title bar that can be used as a simple main interface for a dashboard.

toggle

Widget to select among alternative options using a list of buttons displayed horizontally or vertically.

tooltip

Add tooltip text to a widget: returns a "modified" widget to be used instead of the original one.

treeview

Simplified creation of v-treeview vuetify widget to display hierarchical data in a tree

upload

Widget to upload files from the user local machine

UploadImage

Upload local image: dialog box with image preview

UploadJson

Upload local json file: dialog box to select and preview of some fields

To use the modules of the Vuetify package they have to be imported using code like:

from vois.vuetify import app
a = app.app()
a.show()

Geo package

The Geo package is made up of these modules:

Map

Map widget for interactive display of geospatial datasets

mapUtils

Utilities functions for maps

Modules