Text file widgets

From SpinetiX Support Wiki

Jump to: navigation, search

This page is about the text-file data-driven widgets included into Elementi 2016 and Elementi 2017. For other versions, see the links below.

Text file example

Introduction

Because of their simplicity, plain-text files are commonly used for storage of information, like service / product descriptions, details of a procedure / process, notifications, rules, warnings etc. Text file widgets can be used to display the content of such text files, allowing to add styling information to the text and using animations whenever the entire text doesn't fit into the widget area.

There are many software tools that allows writing / modifying text files, like Notepad, WordPad, Microsoft Word, Google Docs, OpenOffice Writer, LibreOffice Writer etc.


Note Note:
The text content must be saved as plain-text format (.txt) before using it as data source. See this tutorial for more details.

Video tutorial

Text widgets

Text file widgets in Elementi 2016 / 2017

Under the "Text" folder of Elementi 2015 Library, you can find three ready-to-use widgets that automatically display data extracted from a text file data source:

  • Text Bar
    Displays text content using a fixed number of lines and applying a bottom-to-top & line-by-line scrolling effect whenever the entire text doesn't fit into the widget area.
  • Text Ticker
    Displays text content using a continuous horizontal scrolling effect. The font size is adjusted automatically for the text to fit into the widget area.
  • Text Roll
    Displays text content using a continuous vertical scrolling effect. The font size is adjusted automatically for the selected number of lines to fit into the predefined area.

Configuration

Each of the widgets above can be customized using the options provided under "Properties" tab - for more details go to the dedicated page of each widget type, linked above.

"Data Properties" dialog for text file widgets in Elementi 2016 / 2017

To edit the properties related to the data source, click on the Data Properties button. This opens the "Data Properties" dialog, which allows changing the following:

  • URI
    Enter the URI from where the data is retrieved. This can be a local path into the project or a remote HTTP(S) address.
  • Refresh
    Enter a number, optionally followed by s (implicit), m or h, to specify the period after which the widget should refresh the feed data (this is useful especially when the widget is running in a loop); the minimum accepted value is 10 seconds. Using "When document opens" will refresh the data only when the document is re-opened.
  • Limit
    Enable this option and specify the maximum number of items (rows) to be kept from the data set (starting from the first row).


Note Note:
At any point, the data source configuration can be tested by clicking on the "Test..." button.

Troubleshooting

See also

This page was last modified on 23 May 2018, at 19:23.