Edge Documentation

{{DISPLAYTITLE:Scrolling Text Widget}}
[[Category:AppBoard 2.6]]
The Scrolling Text Widget provides a scrolling ticker for showing information in a dynamic and animated banner display.  The concept of the Scrolling Text Widget is similar to the HTML "marquee" tag as demonstrated below:


<marquee behavior="scroll" direction="left">Here is an example of text presented in a scrolling Marquee</marquee>



== How To Create a Scrolling Text Widget ==


For instructions on creating a Widget, see the general instructions in [[appboard/2.6/builder/widgets#Adding_Widgets|Adding Widgets]].  The <b>Scrolling Text</b> Widget type is located under the <b>Communications</b> category on the Widget selection screen.


== How To Configure a Scrolling Text Widget ==


# Follow the instructions above to create the basic "Scrolling Text" Widget.
# Enter the following information on the <b>Data</b> tab:
#* <b>Widget Type</b>: Scrolling Text
#* <b>Data collection</b>: Select the name of the Data Collection that will provide the data to be displayed in the Ticker.
#: Note: For convenience, buttons are provided for Adding or Editing a Data Collection.
#* <b>Widget Name</b>: Enter a name to display for the Widget when it is shown on a Board.
# Enter the following information on the <b>Visualization</b> tab:
#* <b>Label Field</b>: Check the box to include this optional field.  This will display a label prior to each value in the ticker display.  Select the name of the field from the Data Collection that is providing these labels.
#* <b>Value Field</b>: Select the name of the field from the Data Collection that is providing the text to be displayed in the Ticker.
#* <b>Color</b>: Select the default font color to be used for the text in the Ticker.  This setting applies to both the Label and Value items.  The Alpha number can be adjusted to determine the color's opacity.
#* <b>Background Color</b>: Select the text background color to be used in the Ticker.  The Alpha number can be adjusted to determine the color's opacity.
#* <b>Value Color Filter</b>: Click <b>Add</b> to create a Color Filter Rule that will determine the coloration of each scrolling text Value Field item based on application of a filter rule.  The text color of the Label Field will always be the default Color selection for the Widget.
#* <b>Speed</b>: Use the slider to indicate how quickly to scroll the text in the display.
#* <b>Items Shown</b>:
#** <b>Show Single Items</b>: Select this option to only show one Label and Value on the screen at a time.  When one Value scrolls off the Ticker, the next Value will scroll on to the Ticker.
#** <b>Show All Items</b>: Select this option to scroll all of the items immediately after one another.  Multiple Values and Labels could potentially be displayed at the same time.
#*** <b>Separator Character</b>: When "Show All Items" is selected, this character will be inserted after each item to distinguish it from the following item.
#*** <b>Padding</b>: When "Show All Items" is selected, this value will control how much space is inserted between each item and the separator character.
#* <b>Font Size</b>: Controls the size of all of the scrolling text in the display.  The font name is always AppBoard's default font (Arial)
# Click <b>Next</b> to proceed to the <b>Options</b> tab.
# Provide additional configuration on the <b>Options</b> tab.  For details on the available Options, see [[appboard/2.6/builder/widgets/options|Options]].
# Click <b>Finish</b>.
# In the <b>Builder Modes</b> panel, select <b>Builder</b> and navigate to the appropriate Board to observe the new Scrolling Text Widget.


[[Image:scrolling_text_sample.png|thumb|center|700px|A Sample Scrolling Text Widget]]


{{Tip|Users should be notified that they can pause the text from scrolling at any time by mouse-over (moving the pointer on to the Widget area).  This can be helpful if there is critical information that they need to process before it scrolls out of the display.}}

== Notes Regarding System Performance ==

*The Scrolling Text Widget will use additional CPU resources on the client due to the animation.
*The "Show All Items" mode uses more CPU than the "Show Single Items" mode.
*The "Show All Items" mode should be limited to Data Collections of 50 rows or less.  More than this may lead to unacceptable CPU usage and poor UI response in the Builder.


== Sample Data ==

Perform the following steps to create a Scrolling Text Widget using sample data provided with Appboard:


# Follow the instruction on the [[appboard/2.6/builder/sample_chart_data|Sample Chart Data]] page to create sample Data Collections.
# Select any of the Data Collections to use as the Data Collection for the Scrolling Text Widget.
# Select any field in the Data Collection to use as the Text Field for the Scrolling Text Widget.