Slides and Dialogs¶

Slides and dialogs are two essential visual components of Rulex Studio, enabling users to customize and manage their views efficiently. To access and tailor slides and dialogs to their needs, users need to select their respective tabs located in the stage left panel. Down below the major features and functions of both slides and dialogs are delineated:

Slide: displays a blank canvas at the center of the stage window with pre-set dimensions for width and height. While these dimensions are initially fixed, they can be customized for each individual slide or by changing the default dimensions for all slides in the respective view.
Dialog: is a slide within a floating window, where users set its dimensions each time they create a new one. When adding a new dialog, a window prompts users to specify their preferred height and width.

In editing mode, when users select the Dialogs tab, they can see and directly modify their dialogs as needed. However, dialogs can also be viewed in read-only mode when triggered by Open modal window event type. In presentation mode, dialogs triggered by this event are always displayed in read-only mode.

Interactions in Slides and Dialogs Panels¶

Rulex Studio offers a variety of interactions within the Slides and Dialogs panels. While the widget interactions are shared between these two features, their respective context menus display unique operations targeted to the precise component they refer to.

Slides and Dialogs Context Menus

By right-clicking any entry of the slides and dialogs list, a dedicated context menu appears, showing a list of possible operations on the selected slide or dialog. In particular, the context menu contains the following entries:

Copy: it copies the selected slide or dialog.
Duplicate: it duplicates the selected slide or dialog.
Make dialog/slide: it converts a slide into a dialog, or a dialog into a slide.
Open slide/dialog layout: for slides, it opens the Slide layout preferences window, where users can set the layout preferences of their slides. For dialogs, it opens the Dialog layout preferences window, allowing users to configure layout options for dialogs.
Rename: it renames the selected slide or dialog.
Export slide/dialog: it exports the selected slide or dialog as a PNG file to the desired folder on your local system.
Delete: it deletes the selected slide or dialog.

Widget Interactions

The widget interactions available in Rulex Studio’s Slides and Dialogs panels are identical. To reach the shared list of operations for widgets, users need to click the expand icon next to the corresponding slide or dialog. This will display a list of all available widgets within the selected slide or dialog.

By right-clicking on any widget in this list, users can access to a range of stage operations for widgets. This context menu includes the following options:

Open widget layout: it opens the widget layout window for the selected widget. More information on configuring this window and its structure can be found on the corresponding widget’s page.
Set events: it allows users to choose from a range of trigger types for an event. More information on Events and on how to configure them can be found on the corresponding section of this manual.
Delete: it deletes the selected widget.

Example

In this step-by-step guide, it will be demonstrated how to create an interaction between a slide and a dialog within a view. Specifically, an Open modal window event will be set up on a widget in a slide and connected to a dialog that opens as a pop-up window.

After importing the Adult dataset into a view, select the Dialogs tab.
Click on the plus icon in the top-right corner of the Dialogs tab to create a new dialog in the view. When the Dialog layout preferences window appears, enter your preferred dimensions and click ADD.
Configure a Vertical Bar chart widget as follows:
Drag the age attribute onto the X Axis icon.
Drag the marital-status attribute onto the Color Target icon.

https://cdn.rulex.ai/docs/Studio/slide-dialog-example-5.webp

Select the Slides tab, then drag and drop a General button widget from the Controls category onto the stage.
Right-click on the button, then select the Set events option and choose the onClick trigger entry.

https://cdn.rulex.ai/docs/Studio/slide-dialog-example-7.webp

In the events tab, change the event by selecting the Open modal window event type. A pop-up will appear, informing you that all current changes will be discarded. Click YES to proceed.

https://cdn.rulex.ai/docs/Studio/slide-dialog-example-8.webp

Choose Dialog_1 from the Dialog to show drop-down list.

https://cdn.rulex.ai/docs/Studio/slide-dialog-example-9.webp

Save the event and close the Studio Events window.
Click on the General button widget to open the dialog with the plot.

https://cdn.rulex.ai/docs/Studio/slide-dialog-example-10.webp

Slides and Dialogs GOLD Reference¶

Slides and Dialogs are based on the Dashboard GOLD class:

class studio.dashboard.Dashboard(sessionlike=False, id=None, parent_id=None)

Class Dashboard used to describe slide in Slides and Dialogs. Inherits from BaseDashboard.

Property action:: dictionary with keys the identifier of action widgets present in any slides and values the corresponding Action instance
Property control:: dictionary with keys the identifier of control widgets present in any slides and values the corresponding Control instance
Property input:: dictionary with keys the identifier of input widgets present in any slides and values the corresponding StudioInput instance
Property event:: dictionary with keys the identifier of widgets and values the dictionary with keys the trigger and value the corresponding event
Property storedict:: dictionary used to control widget family we need to store
Property objects:: dictionary between widget identifier and type and label
Property obj_indrow:: dictionary used for action and filter management. It stores the indrow to be considered for a widget (directly or for a scope management) in the form: {<object identifier> : {<table identifier> : [<index of indrow vectors in tab_indrow field>, …]}}.
Property tab_indrow:: dictionary used for action and filter/selection management. Dictionary in the form {<table identifier> : [indrow evaluated, …]}
Property action_effect:: dictionary used for action and filter/selection management. FIXME
Property obj_selection:: dictionary used for action and selection management. It stores the indrow to be considered for a widget (directly or for a scope management) in the form: {<object identifier> : {<table identifier> : [<index of indrow vectors in tab_indrow field>, …]}}.

add(label, layout, order=None, id=None)

Function to add a new slide

Parameters:

label (text) – the name of the new slide
layout (dict) – the layout of the new slide. Must follow the general template presented here.
order (integer) – the position of the new slide, None for place it at the bottom, defaults to None
id (text) – the identifier of the new slide, None to generate it internally, defaults to None

baseAdd(label, layout, order=None, id=None)

Base function to add a new slide

Parameters:

label (text) – the name of the new slide
layout (dict) – the layout of the new slide. Must follow the general template presented here.
order (integer) – the position of the new slide, None for place it at the bottom, defaults to None
id (text) – the identifier of the new slide, None to generate it internally, defaults to None

Returns:

the id of the new slide

Return type:

text

baseCopy(label_orig=None, label_dest=None)

Base function to copy a slide

Parameters:

label_orig (text) – the slide to copy, None for the current one, defaults to None
label_dest (text) – the label of the new slide, defaults to None

Returns:

the name of the copied slide

Return type:

text

baseDashAdd(label, layout, order=None, id=None)

Base dashboard function to add a new slide

Parameters:

label (text) – the name of the new slide
layout (dict) – the layout of the new slide. Must follow the general template presented here.
order (integer) – the position of the new slide, None for place it at the bottom, defaults to None
id (text) – the identifier of the new slide, None to generate it internally, defaults to None

baseDashCopy(label_dest=None, label_orig=None, exclude_obj=[], isdialog=False)

Base dashboard function to copy a slide

Parameters:

label_dest (text) – the name of the new copied slide, use None to generate it internally, defaults to None
label_orig (text) – the name of the original slide, None for the current one, defaults to None
exclude_obj – a vector of widget identifiers to exclude them from the copy, defaults to []
isdialog (binary) – if True the current copy is performed in the Studio Dialogs tab, defaults to False

Returns:

the name of the copied slide

Return type:

text

baseDashDelete(label=None, force=False)

Base dashboard function to delete a slide

Parameters:

label (text) – the name of the slide to delete
force (binary) – if True, eventual used checks are disable, defaults to False

baseDashLoad(id, db)

Base dashboard function to load a dashboard instance from the working database

Parameters:

id (text) – the identifier of the BaseDashboard instance or its derivation on the working database
db (Database) – the working database expressed as a Database instance

baseDashMove(label, order)

Base dashboard function to move a slide

Parameters:

label (text) – the name of the slide to move
order (integer) – the new position of the slide

baseDashRename(newname, oldname=None)

Base dashboard function to rename a slide

Parameters:

newname (text) – the new name of the slide
oldname (text) – the name of the slide to rename, None for the current one, defaults to None

baseDashRestoreSave(): Base dashboard function to reset to last save status

baseDashSave(id_view, db, table='r_dashboard', column='view_id')

Base dashboard function to store the whole dashboard on the working database

Parameters:

id_view (text) – the identifier of the view used to store the whole dashboard
db (Database) – the working database, expressed as a Database instance
table (text) – the table to be used for the store, defaults to r_dashboard
column (text) – the primary key of the storing table, defaults to view_id

Returns:

the vector of the slide identifier which are erased by the current store status

Return type:

vector of text type

baseDelete(label=None, force=False)

Base function to delete a slide

Parameters:

label (text) – the name of the slide to delete
force (binary) – if True, eventual used checks are disable, defaults to False

baseGet(label=None, evalpar=False, valueasdict=True)

Base function to retrieve information about a slide

Parameters:

label (text) – the name of the slide to retrieve, None for the current one, defaults to None
evalpar (binary) – if True, the parametrization is evaluated taking into consideration eventual presence of variables in slide layout, defaults to False

Returns:

a dictionary in the form {"order": <integer>, "layout": <dict>, "id": <text>}

Return type:

dict

baseGetStage(label, scope=None, dataset=None, asdict=False, valueasdict=True, external=False)

Function to get the stage description of a slide

Parameters:

label (text) – the name of a slide
scope (dict) – the dictionary of scope for the actions, None for a the whole slide, defaults to None
dataset (Dataset) – the Dataset instance to be used in evaluations

Returns:

the JSON representation of the slide stage expressed as a GOLD dictionary

Return type:

dict

baseList(aslist=False)

Base function to list all the slides

Parameters:: aslist (binary) – if True output is returned as a list of dictionary, otherwise as a dictionary with key the name of the slides, defaults to False
Returns:: a list or a dictionary with base information about all the slides
Return type:: list or dict

baseLoad(id, db, table)

Base function to load the BaseSlide instance or its derivation from the working database

Parameters:

id (text) – the identifier of the BaseSlide instance or its derivation on the working database
db (Database) – the working database expressed as a Database instance
table (text) – the table where information about BaseSlide instance or its derivation are contained

Returns:

the vector of slides identifiers

Return type:

vector of text type

baseMove(label, order)

Base function to move a slide

Parameters:

label (text) – the name of the slide to move
order (integer) – the new position of the slide

baseRename(newname, oldname=None)

Base function to rename a slide

Parameters:

newname (text) – the new name of the slide
oldname (text) – the name of the slide to rename, None for the current one, defaults to None

baseRestoreSave(): Base function to reset situation to the last saved

baseSave(id_parent, db, maintable, maincolumn)

Base function to save BaseSlide information on the working db

Parameters:

id_parent (text) – the indentifier of the parent instance which contains the BaseSlide or its derivation
db (Database) – the working database expressed as a Database instance
maintable (text) – the table where to store information
maincolumn (text) – the primary key of the main table

Returns:

in case no slides are present it returns the list of slides present before

Return type:

vector of text type

baseSet(layout=None, order=None, label=None)

Base function to modify the slide layout, the position or the name

Parameters:

layout (dict) – if present, the new layout of the slide, defaults to None
order (integer) – if present, the new position of the slide, defaults to None
label (text) – if present, the new name of the slide, defaults to None

changeSessionlike(sessionlike)

Base function to change the field sessionlike

Parameters:: sessionlike (binary) – if True all base slide operation are connected to an Undo structure to record them and allow undo-redo operations, defaults to False

copy(label_dest=None, label_orig=None, isdialog=False)

Function to copy a slide

Parameters:

label_dest (text) – the name of the new copied slide, use None to generate it internally, defaults to None
label_orig (text) – the name of the original slide, None for the current one, defaults to None
isdialog (binary) – if True the current copy is performed in the Studio Dialogs tab, defaults to False

Returns:

the name of the copied slide

Return type:

text

copyAction(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy actions

Parameters:

label_dash_orig (text) – the slide on which the action to be copied is present
vec_label (vector of text type) – the name of the actions to be copied
vec_position (list) – the position of the actions to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied actions the new widget labels

Return type:

dict

copyControl(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy controls

Parameters:

label_dash_orig (text) – the slide on which the control to be copied is present
vec_label (vector of text type) – the name of the controls to be copied
vec_position (list) – the position of the controls to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied controls the new widget labels

Return type:

dict

copyGauge(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy gauges

Parameters:

label_dash_orig (text) – the slide on which the gauge to be copied is present
vec_label (vector of text type) – the name of the gauges to be copied
vec_position (list) – the position of the gauges to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied gauges the new widget labels

Return type:

dict

copyGraphic(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy graphics

Parameters:

label_dash_orig (text) – the slide on which the graphic to be copied is present
vec_label (vector of text type) – the name of the graphics to be copied
vec_position (list) – the position of the graphics to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied graphics the new widget labels

Return type:

dict

copyGridtable(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy gridtables

Parameters:

label_dash_orig (text) – the slide on which the gridtable to be copied is present
vec_label (vector of text type) – the name of the gridtables to be copied
vec_position (list) – the position of the gridtables to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied gridtables the new widget labels

Return type:

dict

copyImage(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy images

Parameters:

label_dash_orig (text) – the slide on which the image to be copied is present
vec_label (vector of text type) – the name of the images to be copied
vec_position (list) – the position of the images to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied images the new widget labels

Return type:

dict

copyInput(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy inputs

Parameters:

label_dash_orig (text) – the slide on which the input to be copied is present
vec_label (vector of text type) – the name of the inputs to be copied
vec_position (list) – the position of the inputs to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied inputs the new widget labels

Return type:

dict

copyPlot(label_dash_orig, vec_label, vec_position, label_dash_dest=None, withlayout=True)

Function to copy plots

Parameters:

label_dash_orig (text) – the slide on which the plot to be copied is present
vec_label (vector of text type) – the name of the plots to be copied
vec_position (list) – the position of the plots to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied plots the new widget labels

Return type:

dict

copyWidgets(copyDict, posDict, getDict, label_dash=None, withlayout=True)

Function to copy widgets

Parameters:

objtype (text) – the widget family to the new widget
label_dash_orig (text) – the slide on which the widget to be copied is present
vec_label (vector of text type) – the name of the widgets to be copied
vec_position (list) – the position of the widgets to be copied. Position in the form {"x": x, "y": y, "z": z}
label_dash_dest (text) – the destination slide, use None for the current one, defaults to None
withlayout (binary) – if True also the single layout fields are copied, defaults to True

Returns:

a dictionary which associates to the name of the copied widgets the new widget labels

Return type:

dict

createAction(label, layout, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a action on a slide

Parameters:

label (text) – the name of the new action
layout (dict) – the layout of the new action. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the action needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new action, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new action

Return type:

text

createControl(label, layout, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a control on a slide

Parameters:

label (text) – the name of the new gauge
layout (dict) – the layout of the new control. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the control needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new control, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new control

Return type:

text

createGauge(label, layout, data=None, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a gauge on a slide

Parameters:

label (text) – the name of the new gauge
layout (dict) – the layout of the new gauge. Schema of the following dictionary is contained in this page
data (list) – the output data of the gauge, if present, defaults to None
label_dash (text) – the slide on which the gauge needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new gauge, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new gauge

Return type:

text

createGraphic(label, layout, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a graphic on a slide

Parameters:

label (text) – the name of the new graphic
layout (dict) – the layout of the new graphic. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the graphic needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new graphic, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new graphic

Return type:

text

createGridtable(label, layout, label_dash=None, id=None, layout_dash=None, database=None, filepath=None, **kwargs)

Function to create a gridtable on a slide

Parameters:

label (text) – the name of the new gridtable
layout (dict) – the layout of the new gridtable. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the gridtable needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new gridtable, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None
database (Database) – the working database, expressed as a Database instance, defaults to None
filepath (text) – a possible blob file storing the final dataset, defaults to None

Returns:

the identifier of the new gridtable

Return type:

text

createImage(label, layout, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a image on a slide

Parameters:

label (text) – the name of the new gauge
layout (dict) – the layout of the new image. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the image needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new image, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new image

Return type:

text

createInput(label, layout, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a input on a slide

Parameters:

label (text) – the name of the new gauge
layout (dict) – the layout of the new input. Schema of the following dictionary is contained in this page
label_dash (text) – the slide on which the input needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new input, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new input

Return type:

text

createPlot(label, layout, data=None, label_dash=None, id=None, layout_dash=None, **kwargs)

Function to create a plot on a slide

Parameters:

label (text) – the name of the new plot
layout (dict) – the layout of the new plot. Schema of the following dictionary is contained in this page
data (list) – the output data of the plot, if present, defaults to None
label_dash (text) – the slide on which the plot needs to be created, use None for the current one, defaults to None
id (text) – the identifier of the new plot, use None to generate it internally, defaults to None
layout_dash (dict) – the layout of the slide if the creation needs to update it, defaults to None

Returns:

the identifier of the new plot

Return type:

text

delete(label=None, force=False)

Function to delete a slide

Parameters:

label (text) – the name of the slide to delete
force (binary) – if True, eventual used checks are disable, defaults to False

deleteAction(vec_label, label_dash=None)

Function to delete actions

Parameters:

vec_label (vector of text type) – the name of the actions to delete
label_dash (text) – the slide of the actions, use None for the current one, defaults to None

deleteControl(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of control

Parameters:

vec_label (vector of text type) – the name of the controls to be deleted
label_dash (text) – the slide of the control, use None for the current one, defaults to None
force (binary) – if True, use of the control in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

deleteEvent(ev_label, obj_label, obj_type, label_dash=None, layout_dash=None)

Function to delete an event to a widget

Parameters:

ev_label (text) – the trigger of the event
obj_label (text) – the name of the widget on which the event is applied
obj_type (text) – the family widget type of the widget on which the event is applied
label_dash (text) – the slide of the widget, use None for the current one, defaults to None
layout_dash (dict) – if present the layout of the slide to be updated, defaults to None

deleteGauge(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of gauge

Parameters:

vec_label (vector of text type) – the name of the gauges to be deleted
label_dash (text) – the slide of the gauge, use None for the current one, defaults to None
force (binary) – if True, use of the gauge in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

deleteGraphic(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of graphic

Parameters:

vec_label (vector of text type) – the name of the graphics to be deleted
label_dash (text) – the slide of the graphic, use None for the current one, defaults to None
force (binary) – if True, use of the graphic in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

deleteGridtable(vec_label, label_dash=None, force=False, withalign=True, dataset=None)

Function to delete a set of gridtables

Parameters:

vec_label (vector of text type) – the name of the gridtables to be deleted
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None
force (binary) – if True, use of the gridtable in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True
dataset (Dataset) – the Dataset instance use for scope re-evaluation if needed, defaults to None

deleteImage(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of image

Parameters:

vec_label (vector of text type) – the name of the images to be deleted
label_dash (text) – the slide of the image, use None for the current one, defaults to None
force (binary) – if True, use of the image in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

deleteInput(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of input

Parameters:

vec_label (vector of text type) – the name of the inputs to be deleted
label_dash (text) – the slide of the input, use None for the current one, defaults to None
force (binary) – if True, use of the input in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

deletePlot(vec_label, label_dash=None, force=False, withalign=True)

Function to delete a set of plot

Parameters:

vec_label (vector of text type) – the name of the plots to be deleted
label_dash (text) – the slide of the plot, use None for the current one, defaults to None
force (binary) – if True, use of the plot in view references is not checked, defaults to False
withalign (binary) – if True dashboard layout is corrected to erase the corresponding layers, defaults to True

disableAction(label, label_dash=None)

Function to disable any effects of an action

Parameters:

label (text) – the name of the action to execute
label_dash (text) – the slide of the action, use None for the current one, defaults to None

draw(scope, label_dash=None, withprogress=False, progress_args=None, alsoinputs=False, progress_id=None, alsogridtables=True, alsoactions=True)

Function to draw an entire slide

Parameters:

scope (dict) – the scope for the action contained in the slide
label_dash (text) – the slide of the widget, use None for the current one, defaults to None
withprogress (binary) – if True a progress message is sent, defaults to False
progress_args (dict) – the arguments used in progress message, defaults to None
alsoinputs (binary) – if True also studio Inputs are drawn, defaults to False

drawAction(label, input, dataset, label_dash=None, editing=False)

Function to draw an action

Parameters:

label (text) – the name of the action
input (dict) – the input of the action to draw (stored then in self.layout[“input”])
dataset (Dataset) – the Dataset instance to use as data origin
label_dash (text) – the slide of the action, use None for the current one, defaults to None
editing (binary) – if True the action is executed and drawn in editing mode, defaults to False

drawControl(label, dataset, label_dash=None)

Function to draw a control. The only result is the re-evaluation of eventual dependency on data or variables of the layout options.

Parameters:

label (text) – the name of the control
dataset (Dataset) – the Dataset instance to use in option re-evaluation
label_dash (text) – the slide of the control, use None for the current one, defaults to None

drawGauge(label, input, dataset, label_dash=None, layout=None, discrete=False, refresh=False)

Function to draw a gauge: the output is then stored in the self.data field.

Parameters:

label (text) – the name of the gauge
input (dict) – the input of the gauge to draw (stored then in self.layout[“input”])
options (dict) – the options of the gauge to draw (stored then in self.layout[“options”])
dataset (Dataset) – the Dataset instance to use as data origin
label_dash (text) – the slide of the gauge, use None for the current one, defaults to None
layout (dict) – if present it allows to modify the graphical appareance of the gauge (stored then in self.layout[“layout”]), defaults to None
discrete (binary) – if True the gauge is a discrete gauge, otherwise a continuous one, defaults to False
refresh (binary) – if True all the information are re-evaluated to refresh the dependence to eventual new data or variable values, defaults to False

drawGraphic(label, dataset, label_dash=None)

Function to draw a graphic. The only result is the re-evaluation of eventual dependency on data or variables of the layout options.

Parameters:

label (text) – the name of the graphic
dataset (Dataset) – the Dataset instance to use in option re-evaluation
label_dash (text) – the slide of the graphic, use None for the current one, defaults to None

drawGridtable(label, input, options, dataset=None, label_dash=None, refresh=False, filepath=None, loaddataset=False, layout=None, backupfields=None)

Function to draw a gridtable: the output is then stored in the self.data field.

Parameters:

label (text) – the name of the gridtable
input (dict) – the input of the gridtable to draw (stored then in self.layout[“input”])
options (dict) – the options of the gridtable to draw (stored then in self.layout[“options”])
dataset (Dataset) – the Dataset instance to use as data origin
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None
refresh (binary) – if True all the information are re-evaluated to refresh the dependence to eventual new data or variable values, defaults to False
filepath (text) – the filepath to be use to load the output dataset, defaults to None

drawImage(label, input, label_dash=None)

Function to draw a image. The only result is the re-evaluation of eventual dependency on data or variables of the layout options.

Parameters:: label (text) – the name of the image

::param input: the input of the image to draw (stored then in self.layout[“input”]) :type input: dict

Parameters:: label_dash (text) – the slide of the image, use None for the current one, defaults to None

drawInput(label, label_dash=None, alsoadd=True, single=True)

Function to draw an input

Parameters:

label (text) – the name of the input
label_dash (text) – the slide of the input, use None for the current one, defaults to None
alsoadd (binary) – if True the input can add row if no selection is present, defaults to True
single (binary) – FIXME, defaults to True

drawPlot(label, input, options, dataset, label_dash=None, layout=None, refresh=False)

Function to draw a plot: the output is then stored in the self.data field.

Parameters:

label (text) – the name of the plot
input (dict) – the input of the plot to draw (stored then in self.layout[“input”])
options (dict) – the options of the plot to draw (stored then in self.layout[“options”])
dataset (Dataset) – the Dataset instance to use as data origin
label_dash (text) – the slide of the plot, use None for the current one, defaults to None
layout (dict) – if present it allows to modify the graphical appareance of the plot (stored then in self.layout[“layout”]), defaults to None
refresh (binary) – if True all the information are re-evaluated to refresh the dependence to eventual new data or variable values, defaults to False

executeAction(label, layout, label_dash=None, reload=False, onlyindrow=False, skipdraw=False, **params)

Function to execute an action

Parameters:

label (text) – the name of the action to execute
layout (dict) – the layout of the action to execute if changed
label_dash (text) – the slide of the action, use None for the current one, defaults to None
reload (binary) – if True the whole slide is reloaded at the end, defaults to False
onlyindrow (binary) – if True only the indrow generated by the action is evaluated but not its effect or its propagation, defaults to False
params (dict) – extra params needed for the execution

executeEvent(obj_label, obj_type, evlabel, ind, exec_params={}, label_dash=None)

Function to execute an event

Parameters:

obj_label (text) – the name of the widget on which the event is applied
obj_type (text) – the family widget type of the widget on which the event is applied
evlabel (text) – the name of the event
ind (integer) – the index of the step of the event to execute
exec_params (dict) – dictionary of parameters additional for the execution, defaults to {}
label_dash (text) – the slide of the widget, use None for the current one, defaults to None

Returns:

the status of the execution

Return type:

dict

get(label=None)

Function to retrieve information about a slide

Parameters:: label (text) – the name of the slide to retrieve, None for the current one, defaults to None
Returns:: a dictionary in the form {"order": <integer>, "layout": <dict>, "id": <text>}
Return type:: dict

getAction(label, label_dash=None, dataset=None, withevents=True, asdict=False)

Function to get information about a action

Parameters:

label_obj (text) – the name of the action
label_dash (text) – the slide of the action, use None for the current one, defaults to None
dataset (Dataset) – the Dataset instance to be used if re-evaluation are needed, defaults to None
withevents (binary) – if True the events associated to the selected action are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected action

Return type:

dict or text

getControl(label, label_dash=None, withevents=True, asdict=False)

Function to get information about a control

Parameters:

label_obj (text) – the name of the control
label_dash (text) – the slide of the control, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected control are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected control

Return type:

dict or text

getEvent(label_ev, obj_label, obj_type, label_dash=None, raiseerror=True, onlyvalue=False)

Function to get an event from a widget

Parameters:

label_ev (text) – the name of the event
obj_label (text) – the name of the widget on which the event is applied
obj_type (text) – the family widget type of the widget on which the event is applied
label_dash (text) – the slide of the widget, use None for the current one, defaults to None
raiseerror (binary) – if True error is raised if the event is not present, defaults to False
onlyvalue (binary) – FIXME, defaults to False

getGauge(label, label_dash=None, withevents=True, asdict=False)

Function to get information about a gauge

Parameters:

label_obj (text) – the name of the gauge
label_dash (text) – the slide of the gauge, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected gauge are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected gauge

Return type:

dict or text

getGraphic(label, label_dash=None, withevents=True, asdict=False)

Function to get information about a graphic

Parameters:

label_obj (text) – the name of the graphic
label_dash (text) – the slide of the graphic, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected graphic are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected graphic

Return type:

dict or text

getGridtable(label, label_dash=None, withevents=True, asdict=False, external=False)

Function to get information about a gridtable

Parameters:

label_obj (text) – the name of the gridtable
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected gridtable are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected gridtable

Return type:

dict or text

getGridtableSelected(label_gridtable, columns=None, isselection=False, scalar=False, label_dash=None)

Function to get selected values of a gridtable via selection or filter

Parameters:

label_gridtable (text) – the name of the gridtable
columns (vector of type text) – columns whose values are requested, defaults to None
isselection (binary) – if the operation is a selection and not a filter, defaults to False
scalar (binary) – if the selected value is only one do not return it in a list, defaults to False
label_dash (text) – the slide where the gridtable is located, defaults to None

Returns:

a dictionary containing column name-column value pairs

Return type:

dict

getImage(label, label_dash=None, withevents=True, asdict=False)

Function to get information about a image

Parameters:

label_obj (text) – the name of the image
label_dash (text) – the slide of the image, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected image are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected image

Return type:

dict or text

getInput(label, label_dash=None, withevents=True, asdict=False, dataset=None)

Function to get information about a input

Parameters:

label_obj (text) – the name of the input
label_dash (text) – the slide of the input, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected input are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False
dataset (Dataset) – the Dataset instance to be used if re-evaluation are needed, defaults to None

Returns:

a GOLD dictionary or a JSON string with the full description of the selected input

Return type:

dict or text

getPlot(label, label_dash=None, withevents=True, asdict=False)

Function to get information about a plot

Parameters:

label_obj (text) – the name of the plot
label_dash (text) – the slide of the plot, use None for the current one, defaults to None
withevents (binary) – if True the events associated to the selected plot are also returned, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected plot

Return type:

dict or text

getStage(label, scope=None, dataset=None, asdict=False, external=False)

Function to get the stage description of a slide

Parameters:

label (text) – the name of a slide
scope (dict) – the dictionary of scope for the actions, None for a the whole slide, defaults to None
dataset (Dataset) – the Dataset instance to be used in evaluations
asdict (binary) – if True the stage is returned as GOLD dictionary

Returns:

the JSON representation of the slide stage expressed as a GOLD dictionary, or the GOLD dictionary directly

Return type:

dict

getWidgetData(objtype, widgetname, withevents=False, withselected=False, asdict=True, label_dash=None)

Function to get information about a widget

Parameters:

objtype (text) – the widget family to the new widget
widgetname (text) – the name of the widget
withevents (binary) – if True the events associated to the selected widget are also returned, defaults to True
withselected (binary) – if True the selection active on the selected widget is also returned in the ownSelected field, defaults to True
asdict (binary) – if True the result is returned as GOLD dictionary, otherwise as a JSON string, defaults to False

Returns:

a GOLD dictionary or a JSON string with the full description of the selected widget

Return type:

dict or text

initDashIndrow(id_dash, isselection=False)

Initialize action filter/selection on a slide

Parameters:

id_dash (text) – the identifier of the considered slide
isselection (binary) – if True the action considered is a selection action, defaults to False

list(aslist=False, evalpar=True)

Function to list all the slides

Parameters:

aslist (binary) – if True output is returned as a list of dictionary, otherwise as a dictionary with key the name of the slides, defaults to False
evalpar (binary) – if True, the parametrization is evaluated taking into consideration eventual presence of variables in slide layout, defaults to False

Returns:

a list or a dictionary with base information about all the slides

Return type:

list or dict

listAction(label_dash=None, aslist=False)

Function to list all the actions present in a slide

Parameters:

label_dash (text) – the slide of the action, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the actions of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the actions of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listAllWidgetNames(label_dash=None)

Function to list all widget names

Parameters:: label_dash (text) – the slide of the widget, use None for the current one, defaults to None

listControl(label_dash=None, aslist=False)

Function to list all the controls present in a slide

Parameters:

label_dash (text) – the slide of the control, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the controls of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the controls of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listGauge(label_dash=None, aslist=False)

Function to list all the gauges present in a slide

Parameters:

label_dash (text) – the slide of the gauge, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the gauges of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the gauges of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listGraphic(label_dash=None, aslist=False)

Function to list all the graphics present in a slide

Parameters:

label_dash (text) – the slide of the graphic, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the graphics of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the graphics of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listGridtable(label_dash=None, aslist=False)

Function to list all the gridtables present in a slide

Parameters:

label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the gridtables of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the gridtables of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listImage(label_dash=None, aslist=False)

Function to list all the images present in a slide

Parameters:

label_dash (text) – the slide of the image, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the images of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the images of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listInput(label_dash=None, aslist=False)

Function to list all the inputs present in a slide

Parameters:

label_dash (text) – the slide of the input, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the inputs of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the inputs of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

listPlot(label_dash=None, aslist=False)

Function to list all the plots present in a slide

Parameters:

label_dash (text) – the slide of the plot, use None for the current one, defaults to None
aslist (binary) – if True the output is simply the list of identifiers of all the plots of a certain type in a certain slide, otherwise it is a dictionary with id as key and value the corresponding class instances, defaults to False

Returns:

the identifiers of all the plots of a certain type in a certain slide or the dictionaries with also the class instances as value

Return type:

vector of text type or dict

load(id_dash, db)

Function to load a dashboard instance from the working database

Parameters:

id (text) – the identifier of the BaseDashboard instance or its derivation on the working database
db (Database) – the working database expressed as a Database instance

propagateAction(id_act, tab, indrow, new=True, isselection=False)

Function which propagate the effect of an action having a tab as scope to the other tabs. The effect of this function is to add/update the indrow to the tab_indrow and action_effect fields.

Parameters:

id_act (text) – the id of the considered action
tab (vector of text type) – the scope of the action
indrow (vector of integers) – the indrow obtained applying the action to the scope tab
new (binary) – if False olnly update the old indrow, else add new, defaults to True
isselection (binary) – if True the action to propagate is a selection action, defaults to False

refreshDashContentIndrow(id_dash)

Function to recompute all the indrows of a slide

Parameters:: id_dash (text) – the identifier of the considered slide

refreshDashIndrow(id_dash, dash_indrow, isselection=False, relative=True)

Function to repropagate all the actions and inputs in a slide

Parameters:

id_dash (text) – the identifier of the considered slide
dash_indrow (dictionary with keys the action identifier and value the created indrow) – the indrow available on the slide
isselection (binary) – if True the action considered is a selection action, defaults to False
relative (binary) – if True the indrow is relative to the query active on the slide, defaults to True

refreshLayoutAction(id_dash)

Function to refresh the layout of actions to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutControl(id_dash)

Function to refresh the layout of controls to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutGauge(id_dash)

Function to refresh the layout of gauges to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutGraphic(id_dash)

Function to refresh the layout of graphics to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutGridtable(id_dash)

Function to refresh the layout of gridtables to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutImage(id_dash)

Function to refresh the layout of images to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutInput(id_dash)

Function to refresh the layout of inputs to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

refreshLayoutPlot(id_dash)

Function to refresh the layout of plots to get the modification of data and variables in option values

Parameters:: id_dash (text) – the identifier of the slide considered

removeActionEffect(id_act)

Function to remove the effect of an action

Parameters:: id_act (text) – the identifier of the considered action

rename(newname, oldname=None)

Function to rename a slide

Parameters:

newname (text) – the new name of the slide
oldname (text) – the name of the slide to rename, None for the current one, defaults to None

renameAction(label, newname, label_dash=None)

Function to rename an action

Parameters:

label_obj (text) – the name of the action
newname (text) – the new name
label_dash (text) – the slide of the action, use None for the current one, defaults to None

renameControl(label, newname, label_dash=None)

Function to rename a control

Parameters:

label_obj (text) – the name of the control
newname (text) – the new name
label_dash (text) – the slide of the control, use None for the current one, defaults to None

renameEvent(label_ev, obj_label, obj_type, newlabel, label_dash=None)

Function to rename an event to a widget

Parameters:

label_ev (text) – the trigger of the event
obj_label (text) – the name of the widget on which the event is applied
obj_type (text) – the family widget type of the widget on which the event is applied
newlabel (text) – the new label of the event
label_dash (text) – the slide of the widget, use None for the current one, defaults to None

renameGauge(label, newname, label_dash=None)

Function to rename a gauge

Parameters:

label_obj (text) – the name of the gauge
newname (text) – the new name
label_dash (text) – the slide of the gauge, use None for the current one, defaults to None

renameGraphic(label, newname, label_dash=None)

Function to rename a graphic

Parameters:

label_obj (text) – the name of the graphic
newname (text) – the new name
label_dash (text) – the slide of the graphic, use None for the current one, defaults to None

renameGridtable(label, newname, label_dash=None)

Function to rename a gridtable

Parameters:

label_obj (text) – the name of the gridtable
newname (text) – the new name
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None

renameImage(label, newname, label_dash=None)

Function to rename a image

Parameters:

label_obj (text) – the name of the image
newname (text) – the new name
label_dash (text) – the slide of the image, use None for the current one, defaults to None

renameInput(label, newname, label_dash=None)

Function to rename a input

Parameters:

label_obj (text) – the name of the input
newname (text) – the new name
label_dash (text) – the slide of the input, use None for the current one, defaults to None

renamePlot(label, newname, label_dash=None)

Function to rename a plot

Parameters:

label_obj (text) – the name of the plot
newname (text) – the new name
label_dash (text) – the slide of the plot, use None for the current one, defaults to None

resetGridtable(label, oldindrow=None, label_dash=None)

Function to reset any query on a gridtable

Parameters:

label (text) – the name of the gridtable
oldindrow (vector of integers) – the indrow to set after the reset, defaults to None
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None

resetSelection(label_obj, type_obj, scope=None, issetlimit=False, label_dash=None)

Function to reset a preecedent selection

Parameters:

label_obj (text) – the name of the widget triggering a selection
type_obj (text) – the type of the widget triggering a selection
scope (dict) – the scope of the widget, None for the scope of the widget, defaults to None
label_dash (text) – the slide of the action, use None for the current one, defaults to None

resetTableInput(table, label_dash=None)

Function to reset all the inputs on a slide associated to a table

Parameters:

table (text) – the table to consider
label_dash (text) – the slide of the inputs to consider, use None for the current one, defaults to None

resetValueInput(label, label_dash=None)

Function to reset the value of an input

Parameters:

label (text) – the name of the input
label_dash (text) – the slide of the input, use None for the current one, defaults to None

restoreSave(): Function to reset to last save status

save(id_view, db)

Function to store the whole dashboard on the working database

Parameters:

id_view (text) – the identifier of the view used to store the whole dashboard
db (Database) – the working database, expressed as a Database instance

Returns:

the vector of the slide identifier which are erased by the current store status

Return type:

vector of text type

saveTableInput(table, withraise=False, label_dash=None)

Function to save input values on the table

Parameters:

table (text) – the table to update
withraise (binary) – if True error is raised if a consistency check is failed, defaults to False
label_dash (text) – the slide of the inputs to consider, use None for the current one, defaults to None

set(layout=None, order=None, label=None)

Function to modify the layout or the position or the name of a slide

Parameters:

layout (dict) – if present, the new layout of the slide, defaults to None
order (integer) – if present, the new position of the slide, defaults to None
label (text) – if present, the new name of the slide, defaults to None

setAction(label, layout=None, dataset=None, label_dash=None, onlyset=True, withundo=True)

Function to modify the action

Parameters:

label (text) – the name of the action
layout (dict) – the new layout of the action, defaults to None
dataset (Dataset) – the Dataset instance used for action evaluation, defaults to None
label_dash (text) – the slide of the action, use None for the current one, defaults to None
onlyset (binary) – if True the widget modified is not drawn again, defaults to True
withundo (binary) – if True operation is recorded for undo/redo management, defaults to True

setControl(label=None, layout=None, label_dash=None)

Function to modify the layout of an existing control

Parameters:

objtype (text) – the widget family to the new control
label (text) – the name of the control to be modified
layout (dict) – the new layout of the control
label_dash (text) – the slide of the control, use None for the current one, defaults to None

setDirtyStatusView(dirty=True)

Function to change the status of the view to dirty

Parameters:: dirty (binary) – the status to set, defaults to True

setEvent(label_ev, obj_label, obj_type, params, label_dash=None)

Function to modify or add an event to a widget

Parameters:

label_ev (text) – the trigger of the event
obj_label (text) – the name of the widget on which the event is applied
obj_type (text) – the family widget type of the widget on which the event is applied
params (dict) – dictionary with information about the event to be set
label_dash (text) – the slide of the widget, use None for the current one, defaults to None

Returns:

the identifier of the event created

Return type:

text

setGauge(label=None, layout=None, label_dash=None, withdata=False)

Function to modify the layout of an existing gauge

Parameters:

objtype (text) – the widget family to the new gauge
label (text) – the name of the gauge to be modified
layout (dict) – the new layout of the gauge
label_dash (text) – the slide of the gauge, use None for the current one, defaults to None
withdata (binary) – if True the layout is supposed to contain a key data with output information, defaults to False

setGraphic(label=None, layout=None, label_dash=None)

Function to modify the layout of an existing graphic

Parameters:

objtype (text) – the widget family to the new graphic
label (text) – the name of the graphic to be modified
layout (dict) – the new layout of the graphic
label_dash (text) – the slide of the graphic, use None for the current one, defaults to None

setGridtable(label=None, layout=None, evaluate=False, label_dash=None)

Function to modify the layout of an existing image

Parameters:

objtype (text) – the widget family to the new image
label (text) – the name of the image to be modified
layout (dict) – the new layout of the image
evaluate (binary) – if True the widget is re-evaluated and data field is obtained again, defaults to False
label_dash (text) – the slide of the image, use None for the current one, defaults to None

setImage(label=None, layout=None, label_dash=None)

Function to modify the layout of an existing image

Parameters:

objtype (text) – the widget family to the new image
label (text) – the name of the image to be modified
layout (dict) – the new layout of the image
label_dash (text) – the slide of the image, use None for the current one, defaults to None

setInput(label=None, layout=None, label_dash=None, onlyset=True)

Function to modify the layout of an existing image

Parameters:

objtype (text) – the widget family to the new image
label (text) – the name of the image to be modified
layout (dict) – the new layout of the image
label_dash (text) – the slide of the image, use None for the current one, defaults to None
onlyset (binary) – if True the widget modified is not drawn again, defaults to True

setObjIndrow(id_act, id_dash, scope, isselection=False)

Function to update the indrow of the objects as a consequence of the execution of an action

Parameters:

id_act (text) – the identifier of the considered action
id_dash (text) – the identifier of the slide to be aligned
scope (vector of text type) – the scope of the considered action
isselection (binary) – if True the action considered is a selection action, defaults to False

setPlot(label=None, layout=None, label_dash=None, withdata=False)

Function to modify the layout of an existing plot

Parameters:

objtype (text) – the widget family to the new plot
label (text) – the name of the plot to be modified
layout (dict) – the new layout of the plot
label_dash (text) – the slide of the plot, use None for the current one, defaults to None
withdata (binary) – if True the layout is supposed to contain a key data with output information, defaults to False

setSelection(label_obj, type_obj, tab, selection, isselection, scope=None, onlyindrow=False, label_dash=None, relative=True)

Function to set a selection on the slide

Parameters:

label_obj (text) – the name of the widget triggering a selection
type_obj (text) – the type of the widget triggering a selection
tab (text) – the table on which the selection is apply
isselection (binary) – if the operation is really a selection
scope (dict) – the scope of the widget, None for the scope of the widget, defaults to None
onlyindrow (binary) – if True effect is not propagated, defaults to False
label_dash (text) – the slide of the action, use None for the current one, defaults to None
relative (binary) – if True indrow is evaluated taking into account table preecedent query, defaults to True

setValueInput(label, value, label_dash=None)

Function to modify the value of an input

Parameters:

label (text) – the name of the input
value (any) – the value to set
label_dash (text) – the slide of the input, use None for the current one, defaults to None

sortGridtable(label, sort_attr, label_dash=None)

Function to sort a gridtable

Parameters:

label (text) – the name of the gridtable
sort_attr (list) – the name of the attributes to sort. They are provided as a list of lists of two elements each: the name of the attribute, and a binary True/False for ascending/descending order.
label_dash (text) – the slide of the gridtable, use None for the current one, defaults to None

store(id=None, db=None, withdata=False)

Function to store plots inside a Dashbaord instance on the working database

Parameters:

id (text) – the identifier of the current Dashboard instance, defaults to None
db (Database) – the working database expressed as a Database instance, defaults to None
withdata (binary) – if True the data field of the widget is also stored on the working database, defaults to False