416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

RSS Viewer - Dashboard Add-on

Hide navigation
RSS
Modified on Tue, 02 Apr 2013 10:36 AM
Click to return to: Documentation | Dundas Dashboard Add-ons


Go to the Dundas Dashboard Add-ons page for instructions on downloading and installing this add-on.

Overview

The RSS Viewer add-on allows you to view any RSS 2.0 or ATOM 1.0 feeds. It will show the feed items both in design-time (for a preview) and in view time.

Figure 1: The RSS Viewer.

Figure 1: The RSS Viewer.


The links may also have tooltips set on them with the description of the link (if provided by the feed). Additionally, to make viewing easier for the user, paging can be enabled to trim the length of the list. If no page size is given (page size is set to 0), the page selector bar at the bottom will not be shown.

Usage

To use this add-on, install it using the RSS Viewer installer. Once installed, the RSS viewer will appear in the General Controls section of the toolbar.

Figure 2: The RSS Viewer in the toolbar.

Figure 2: The RSS Viewer in the toolbar.


To use the control, simply drag it to the dashboard canvas.

Figure 3: The RSS Viewer on the dashboard.

Figure 3: The RSS Viewer on the dashboard.


The image that first appears indicates the control does not have a feed url yet, and thus has nothing to display. To make it display a feed, use the Feed Url property to set a RSS feed for the control to consume.

Specific Properties

Feed Url (FeedUri)

This property (of type string) specifies what URL is supplying the RSS/ATOM feed to the control.

Page Size (PageSize)

This property (of type int) specifies the size of a page in the control. For example, if a RSS feed supplies 20 items, and the PageSize is set to 5, there will be 4 pages in the feed viewer each with 5 items. The default is 0, which indicates not to use paging. However, if the number of items exceeds the visible area, a scroll bar will be used.

Figure 4: The RSS Viewer with a scrollbar.

Figure 4: The RSS Viewer with a scrollbar.


Errors

If the RSS Viewer is given a bad feed (i.e. a feed that does not comply with RSS 2.0 or ATOM 1.0 standards for example), the error will be displayed within the control to give the user indication of the failure, and the reason. Below is an example error when a bad page is given.

Figure 5: The RSS Viewer with an error.

Figure 5: The RSS Viewer with an error.


Limitations

  • The RSS Viewer works only with RSS 2.0 and ATOM 1.0 feeds. It will not work with any other types.
  • The Font color will only apply to the Title; the hyperlinks will always remain blue.
  • The Background doesn't affect the control.

Release history

This add-on was first released with Dundas Dashboard 2.0.0.

Related topics


Click to return to: Documentation | Dundas Dashboard Add-ons

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.