Reference manual
Setup
The vois library can be installed by executing: pip install vois
Packages
The vois library is grouped in these packages:
Contains modules that define utilities functions and classes of general use (geojson, maps, svg, etc.) |
|
Contains modules that define classes to simplify the creation of GUI elements using ipyvuetify widgets |
|
Contains modules that enable the display of geospatial content on an interactive Map |
General package
The General package is made up of these modules:
Utility functions and classes to manage colors and color interpolation. |
|
Utility functions for downloading text and binary files |
|
Utility functions and classes to manage information on EU countries. |
|
Utility functions to manage geospatial vector data in geojson format. |
|
Utility functions for the creation of interactive maps using BDAP interactive library. |
|
Utility functions for the creation ipytrees from hierarchical data. |
|
Utility functions for the creation of interactive maps using ipyleaflet Map. |
|
SVG BarChart to display interactive vertical bars. |
|
SVG bubbles chart from a pandas DataFrame. |
|
SVG visualization of a graph. |
|
SVG heatmap chart from a pandas DataFrame. |
|
European map implemented in SVG. |
|
SVG Packed Circles chart from a pandas DataFrame. |
|
SVG RankChart to display vertically aligned rectangles. |
|
SVG drawings for general use. |
|
Map popup widget to display titles and texts in a geographic position on a ipyleaflet Map. |
|
Utility functions to prepare data for Plotly Treemap, Sunburst and Icicle plots. |
|
Utility functions to open a web page. |
|
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 class to easily define the structure of a typical Voilà dashboard. |
|
Widget to select the basemap to visualise on a ipyleaflet Map |
|
Button widget to call a python function when clicked. |
|
Simple card with title, subtitle and image. |
|
Cards with title, subtitle and image displayed in rows and columns |
|
Input widget to select a color |
|
Display of a Pandas DataFrame in a data-table widget. |
|
Input widget to select a date |
|
Calendar widget showing days with events |
|
Generic modal dialog-box to ask input from the user. |
|
Dialog-box to display a message for the user. |
|
Dialog-box to display a message to the user during a lenghty operation. |
|
Dialog-box to ask a yes-no question to the user. |
|
Floating-action-button to be displayed in absolute mode on the page. |
|
|
Font settings for ipyvuetify widgets. |
Footer bar to be displayed at the bottom of a Voilà dashboard. |
|
Button displaying an icon. |
|
IconButton to copy text to the clipboard. |
|
Label widget to display a text with an optional icon. |
|
Widget to manage the layers Table Of Content for a ipyleaflet Map |
|
Initial page for an application |
|
Menu widget opened on hover on a button. |
|
Widget to select independent options using a list of buttons displayed horizontally or vertically. |
|
Fullscreen page |
|
Widget for the creation and editing of color palettes. |
|
Selection of a palette of colors |
|
Extended selection of a palette of different families (sequential, divergent, etc.) |
|
Popup window opened at hover on a button. |
|
Circular progress bar to use for lenghty operations. |
|
Read parameters passed in the URL of the Voila dashboard |
|
Radio buttons to allow users to select from a predefined set of options. |
|
Slider to select a range of numeric values. |
|
Widget to select a range of float values |
|
Select widget that displays images and enables for single selection. |
|
Multiple selection widget. |
|
Single selection widget from a dropdown list. |
|
General settings for ipyvuetify widgets. |
|
Side panel that opens on the side of the screen to show content or get user input. |
|
Widget to select a float value |
|
Widget to display a quick message to the user in an overlapping window that will disappear after a timeout |
|
Vertically aligned list of customizable cards with items that can be moved, added and removed. |
|
Display and selection of a list of SVG files |
|
The switch widget provides users the ability to choose between two distinct values. |
|
Widget to select among alternative display using a list of tabs displayed horizontally or vertically. |
|
Widget to display text strings vertically aligned. |
|
Class that implements a title bar that can be used as a simple main interface for a dashboard. |
|
Widget to select among alternative options using a list of buttons displayed horizontally or vertically. |
|
Add tooltip text to a widget: returns a "modified" widget to be used instead of the original one. |
|
Simplified creation of v-treeview vuetify widget to display hierarchical data in a tree |
|
Widget to upload files from the user local machine |
|
Upload local image: dialog box with image preview |
|
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 widget for interactive display of geospatial datasets |
|
Utilities functions for maps |
Modules
- General modules
- colors module
- download module
- eucountries module
- geojsonUtils module
- interMap module
- ipytrees module
- leafletMap module
- svgBarChart module
- svgBubblesChart module
- svgGraph module
- svgHeatmap module
- svgMap module
- svgPackedCirclesChart module
- svgRankChart module
- svgUtils module
- textpopup module
- treemapPlotly module
- urlOpen module
- urlUpdate module
- Vuetify modules
- app class
app
app.outcontent
app.contentAddPanel()
app.contentBackground()
app.contentResetPanels()
app.contentSetPanel()
app.dialogGeneric()
app.dialogMessage()
app.dialogWaitClose()
app.dialogWaitOpen()
app.dialogYesNo()
app.display()
app.downloadBytes()
app.downloadText()
app.fab()
app.setActiveTab()
app.show()
app.snackbar()
app.urlOpen()
app.urlParameter()
app.urlUpdate()
- basemaps widget
- Button widget
- card widget
- cardsGrid widget
- ColorPicker widget
- datatable widget
- DatePicker widget
- dayCalendar widget
- dialogGeneric widget
- dialogMessage widget
- dialogWait widget
- dialogYesNo widget
- fab widget
- footer widget
- iconButton widget
- IconClipboard widget
- label widget
- layers widget
- mainPage widget
- menu widget
- multiSwitch widget
- page widget
page
page.appname
page.copyrighttext
page.creditswidth
page.footercolor
page.footerdark
page.footerheight
page.left_back
page.logoappurl
page.logocreditsurl
page.logowidth
page.show_back
page.show_credits
page.show_help
page.state
page.title
page.titlecolor
page.titledark
page.titleheight
page.titleimageurl
page.transition
- paletteEditor widget
- palettePicker widget
- palettePickerEx widget
- popup widget
- Progress widget
- queryStrings module
- Radio widget
- rangeSlider widget
- rangeSliderFloat widget
- selectImage widget
- selectMultiple widget
- selectSingle widget
- settings module
- sidePanel widget
- slider widget
- sliderFloat widget
- snackbar widget
- sortableList widget
- svgsGrid widget
- switch widget
- tabs widget
- textlist widget
- title bar
- toggle widget
- tooltip widget
- treeview widget
CustomTreeview
CustomTreeview.items
CustomTreeview.selectable
CustomTreeview.activatable
CustomTreeview.selected
CustomTreeview.selectednames
CustomTreeview.opened
CustomTreeview.color
CustomTreeview.on_change
CustomTreeview.on_activated
CustomTreeview.expand_selection_to_parents
CustomTreeview.iconsshow
CustomTreeview.iconscolor
CustomTreeview.icons_folder_opened
CustomTreeview.icons_folder_closed
CustomTreeview.tooltips
CustomTreeview.tooltips_chars
CustomTreeview.search
CustomTreeview.item_height
CustomTreeview.font_size
CustomTreeview.icon_size
CustomTreeview.checkbox_size
createFlatTreeview()
createTreeviewFromDF2Columns()
createTreeviewFromDF3Columns()
createTreeviewFromList()
treeviewOperations
treeviewOperations.treecard
treeviewOperations.getActive()
treeviewOperations.getChildren()
treeviewOperations.getFirstChildFullname()
treeviewOperations.getOpened()
treeviewOperations.getSelected()
treeviewOperations.openAll()
treeviewOperations.setActive()
treeviewOperations.setChildren()
treeviewOperations.setOpened()
treeviewOperations.setSearch()
treeviewOperations.setSelected()
- upload widget
- UploadImage widget
- UploadJson widget
- app class
- Geo modules