"""Circular progress bar to use for lenghty operations."""
# Author(s): Davide.De-Marchi@ec.europa.eu
# Copyright © European Union 2022-2023
#
# Licensed under the EUPL, Version 1.2 or as soon they will be approved by
# the European Commission subsequent versions of the EUPL (the "Licence");
#
# You may not use this work except in compliance with the Licence.
#
# You may obtain a copy of the Licence at:
# https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
# Unless required by applicable law or agreed to in writing, software
# distributed under the Licence is distributed on an "AS IS"
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
#
# See the Licence for the specific language governing permissions and
# limitations under the Licence.
from IPython.display import display
import ipyvuetify as v
from vois.vuetify.utils.util import *
#####################################################################################################################################################
# Display a circular progress bar centered inside an output widget
#####################################################################################################################################################
[docs]
class Progress:
"""
Circular progress bar to use for lenghty operations.
Parameters
----------
output : ipywidgets.Output
Output widget on which the progress bar has to be displayed
text : str, optional
Small text to display inside the circle (default is '')
show : bool, optional
If True, display the progress upon creation (default is False)
size : int, optional
Diameter of the circle in pixels (default is 120 pixels)
width : int, optional
Width in pixels of the moving line (default is 15)
output_height : int, optional
Height in pixels of the output widget (default is 400 pixels)
onchange : function, optional
Python function to call when the user selects one of the values in the list. The function will receive no parameter (use value property to retrieve the current selection)
color : str, optional
Color used for the widget (default is the color_first defined in the settings.py module)
Example
-------
Creation and display of a progress widget::
from vois.vuetify import progress
from ipywidgets import widgets, Layout
from IPython.display import display
output_height = 500
output = widgets.Output(layout=Layout(width='99%', height='%dpx' % (output_height+10)))
display(output)
p = Progress(output, text='Please, wait...',
size=200, width=20,
show=True, output_height=output_height)
To close the progress::
p.close()
.. figure:: figures/progress.png
:scale: 100 %
:alt: progress widget
Example of progress widget displayed inside an Output.
"""
deprecation_alias = dict(outputheight='output_height')
# Initialization
@deprecated_init_alias(**deprecation_alias)
def __init__(self,
output, # Output widget where the progress must be displayed
text: str = '', # Small text inside the circle
show: bool = False, # If True, display the progress upon creation
size: int = 120, # Diameter of the circle in pixels
width: int = 15, # Width of the moving line
output_height: int = 400, # Height in pixels of the output widget
color: str = None): # Color
from vois.vuetify import settings
self.output = output
self.size = size
self.output_height = output_height
self.prog = v.ProgressCircular(style_='overflow: hidden;',
class_='pa-0 ma-0',
indeterminate=True,
size=size,
width=width,
children=[text],
color=color if color is not None else settings.color_first)
self.nav = None
if show:
self.show()
for alias, new in self.deprecation_alias.items():
create_deprecated_alias(self, alias, new)
# Display the progress
[docs]
def show(self):
"""Displays the progress into the output widget"""
if self.output:
self.output.clear_output(wait=True)
with self.output:
# Centered vertically and horizontally!
h = v.Html(tag='div',
style_="height: %dpx; display: flex; justify-content: center; align-content: center; align-items:center; flex-direction: column; " % self.output_height,
class_="text-center", children=[self.prog])
display(h)
# Display the progress as an overlay in a specific position
[docs]
def showAbsolute(self, output, left, top, zindex=9999):
"""Displays the progress as an overlay layer in a specific position
Parameters
----------
output : ipywidgets.Output
Output widget to use for the display of the transparent widget
left : str
Position of the left side of the widget. It can be in pixels, vw, or other units.
top : str
Position of the top side of the widget. It can be in pixels, vh, or other units.
zindex : int, optional
Z-index of the progress on the page (default is 9999)
"""
self.nav = v.NavigationDrawer(stateless=True, permanent=True, floating=True, fixed=True, left=True,
color="transparent",
width="%dpx" % self.size,
height="%dpx" % self.size,
style_="left: %s; top: %s; z-index: %d;" % (left, top, zindex),
class_="pa-0 ma-0", children=[self.prog])
with output:
display(self.nav)
# Hide the progress
[docs]
def close(self):
"""Hides the progress by clearing the output widget content"""
if self.output:
self.output.clear_output()
if self.nav:
self.nav.close()