Visualizers¶
The Visualizers family is one of the available components’ families you can use to populate a form.
It contains graphical elements used to visualize data. Visualizers can be added to a form without being associated to any interactive option; they display data-related information, such as a piece of text, a table or a plot. The Visualizers family contains one group, the Base one.
The Base group contains the following components:
Label
Table (in tasks only)
Plot (in tasks only)
Unlike the components belonging to the Organizers family, Visualizers cannot contain other components; unlike controllers, they do not manage any value, so they cannot be used as the Origin of a connection.
The layout of Base visualizers can be customized in the component’s layout menu, which can be accessed by right-clicking onto the component and clicking Open component layout, or when first dragging the component onto the stage.
The available fields depend on the component and, in some cases, on the values selected in other fields of the same component. Conditional fields are marked in the tables below.
Browse the tabs below to know more about the available options for each Base visualizer.
The Label displays a text on the form. The text can be a fixed content, written directly in the component, or a value which is resolved at runtime from a source structure.
Option |
Description |
|---|---|
Change as formula |
If selected, it allows users to work parametrically on the label, so that its content is resolved as a value coming from a source structure. When this option is selected, the Source structure field is displayed. To know more about working parametrically, go to the corresponding page. |
Source structure |
Specify the source from which the value of the label comes from. In tasks, select it from the drop-down list among the available structures; in the other types of form, type the structure name. This option is available only if Change as formula has been selected. |
Change as HTML |
If selected, the content of the label is interpreted as HTML code instead of plain text. |
Open links on external window |
If selected, the links contained in the HTML content are opened in a new window. This option is available only if Change as HTML has been selected. |
Label |
The label of this component. |
Label position |
The horizontal position of the text within the component. The possible values are: Left (default), Center, Right. |
Container width |
The width of the container of the label. It can be specified both in pixels or in percentage, by simply clicking on the corresponding symbols at the right of the number field. |
Font family |
Users can select from the drop-down list the font type of the label. |
Font size |
The size of the component’s label. |
Text transform |
The transformation applied to the text of the label, for example to display it all in uppercase or all in lowercase. |
Label color |
The color of the text of the label. |
Ellipsis |
If selected, any text that exceeds the available label space is truncated and replaced by an ellipsis (…). |
Order |
The position of the visualizer in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, components will be sorted in ascending order according to their Order value. |
Css |
Additional CSS code used to customize the label. |
Container Css |
Additional CSS code used to customize the container of the label. |
The Table displays a table of the task on the form. It is available in tasks only. The component is added to the form as a single Table visualizer: the Table type selected in the options determines which view is rendered, and which other fields are available.
The Table type can be chosen from the drop-down list among the available values:
preview, which displays a preview of the data.
results, which displays the results of the task.
variables, which displays the variables and the options of the task. The variables defined at module scope can be displayed through the Apply to module option.
models, which displays the information on the models.
Option |
Description |
|---|---|
Table type |
Select from the drop-down list the type of table which will be configured. The possible types are: preview, variables, results, models. In tasks, the structures available in the task can be selected as well. |
Automatic preview |
If selected (default), the preview of the data is calculated and displayed automatically. This option is available when the preview table type has been chosen. |
Export preview |
If selected, the preview of the data can be exported. This option is available when the preview table type has been chosen. |
Apply to module |
If selected, the table displays the variables defined at module scope. This option is available when the variables table type has been chosen. |
Add option |
If selected, the Option field is displayed, so that the table can be linked to an option. This option is available when the variables table type has been chosen. |
Option |
Select from the drop-down list the option, among those which have been previously set in the Options tab, which will be linked to the table. This option is available when the variables table type has been chosen and the Add option checkbox has been selected. |
Show hidden layer |
If selected, the hidden layers of the models are displayed in the table. This option is available when the models table type has been chosen. |
Order |
The position of the visualizer in the form. It is a 0-based dictionary, and its default value is 0 for all components, meaning that the order of the components will follow the dragging order. If this value is specified, components will be sorted in ascending order according to their Order value. |
Css |
Additional CSS code used to customize the container of the table. |
The other table types, such as those based on the structures available in the task, do not require any additional option: they use the data of the selected type.
The Plot is available in tasks only. It has a different structure compared to the other form components, particularly those belonging to the Visualizers family.
When dragged onto the stage, a window with two sections opens. The plot window is composed by the Table and Attributes on the left, and the plot widget structure on the right. The widget shows a preview of the plot, which is updated according to the attributes which have been added to the Attributes list.
The Plot is configured through this specialized window, so it does not have a separate Option section: the table, the attributes and the plot layout are all defined in the same place.
The Table field contains the data type contained in the table which will be represented by the plot. The possible values are Dataset (default), Results, Clusters, Clustlabs, Monitor, Frequentitemsets, Rareitemsets, Associationrules, Bundlehypotheses, Replacementrules, Frequentsequences, Autoregressive, Cutoff, Fillmiss, Branchvariable.
The Attributes area can be edited by using the plus and minus icons to add or delete attributes. By clicking on the plus button, the Add custom attributes window opens. To add a new attribute, click on the Add attribute button, so that the following fields appear to define a new attribute:
Name: the name of the attribute.
Type: the attribute type, among all those available in Rulex Platform. The possible values are Binary, Continuous, Currency, Date, Datetime, Integer, Month, Nominal (default), Percentage, Quarter, Time, Week.
To delete an attribute from the custom attributes window, simply click on the X button located at the right of the Type field.
To save the changes made in the custom attributes window, click the APPLY button.
Warning
Once the operations performed in the custom attributes window have been saved, it is possible to delete the existing attributes by selecting them from the Attributes list and clicking on the minus icon at the bottom of the list.
The plot layout options can be opened by clicking on the wrench button. They offer the same layout options as those found in Plots in Rulex Studio and in the Plots tab in Rulex Factory.
More information on the plot layout menu can be found in the corresponding page.
To build the plot and change the plot type, interact with the plot as you should do in the Data Manager Plots tab.