Shimoku docs
Search…
Alert indicator
Alert Indicators are important tools to benchmark, target and monitor performance. Define performance indicators that relate to the most important activities.

The method to use

The method is shimoku.plt.alert.indicator()
It must contain the following input variables:
data: Union[str, DataFrame, List[Dict]]
menu_path: str
order: int
And accepts the following input variables as optional:
value: Optional[str]
header: Optional[str]
footer: Optional[str]
color: Optional[str]
target_path: Optional[str]
set_title: Optional[str]
rows_size: Optional[int]
cols_size: Optional[int]
padding: Optional[List[int]]

Video demonstration of the Alert Indicator

The Alert Indicator setting and usage.

Examples

1. Default configuration

data_ = [
{
"description": "",
"title": "Estado",
"value": "Abierto",
"color": "warning-background",
"targetPath": "/whispers-test/test",
},
{
"description": "",
"title": "Metodo",
"value": "Entrada",
"color": "error-background",
"targetPath": "/whispers-test/test",
},
]
shimoku.plt.alert_indicator(
data=data_,
menu_path='test/alert-indicator-1',
order=0,
rows_size=2, cols_size=12,
value='value',
header='title',
footer='description',
color='color',
target_path='targetPath',
set_title='Control de admissión'
)
The result is:
The alert indicator with two sets of data, and with the default configuration.
The indicator is showed in the path test/alert-indicator-1

2. Title for the indicator, changing data, sizes, and adding padding

data_ = [
{
"description": "Entrada de mercancías",
"title": "Estado",
"value": "Abierto",
"color": "success-background",
"targetPath": "www.shimoku.com",
},
]
shimoku.plt.alert_indicator(
data=data_,
menu_path=menu_path,
order=0,
rows_size=2, cols_size=4,
value='value',
header='title',
footer='description',
color='color',
target_path='targetPath',
)
data_ = [
{
"description": "Fase de procesamiento",
"title": "Metodo",
"value": "Entrada",
"color": "warning-background",
"targetPath": "www.shimoku.com",
},
]
shimoku.plt.alert_indicator(
data=data_,
menu_path=menu_path,
order=1, rows_size=2, cols_size=6,
padding="0,0,0,2",
value='value',
header='title',
footer='description',
color='color',
target_path='targetPath',
)
The result is:
The first alert indicator has rows_size=2, cols_size=4, the padding="0,0,0,2", introduces space between the alert indicators, and the second alert indicator has rows_size=2, cols_size=6.
  • Available font colors: success, warning, error, grey
  • Available background colors: success-background, warning-background, error-background
  • Alignment: left , center, right by default the value right is taken. Note that the alignment only applies to the value, not to the title nor description.
Changing menu_path The menu_path can be modified.
It is possible to use any number of rows.
Last modified 3mo ago
Copy link
On this page
The method to use
Examples