Synopsis  
  
Property Name
Description
Type
Values
BarSizeRelativeToAPage  
 Determines whether graph bars are sized relative to the current page or the whole of the Sample Data file
boolean
false/true
0/1
DefaultGraphsView  
 Determines the type of graphs view presented when the Pollstar100 Application is first loaded
string
Votes
Hits
Ratings

SamplePageSize
Determines the Sample Data page size for the UI
integer
0 - max(Sample Data records)
AllowSorting  
 Determines whether the Sample Data is sortable
boolean
false/true
0/1
DataFile  
 Specifies the location of the Sample Data file on the webhost system
string
absolute or relative pathname
VoteRecustomiseFile  
 Specifies the pathname to an alternative Custom XML file to be used once the end-user has cast a vote.
string
absolute or relative URL
AutoRefreshSeconds  
  
 Specifies the amount of time the client waits between automatic updates
integer
0 - 0xFFFFFFFF
LoadResourceSeconds  
 Specifies the amount of time the client spends attempting to download an external resource
integer
0 - 0xFFFFFFFF
ShowResourceMarker  
 Specifies whether or not a resource marker is displayed while an external resource is downloaded
boolean
false/true
0/1
CacheResources  
 Specifies whether or not external resources are cached  
 boolean
false/true
0/1
CacheCustomFile  
 Specifies whether or not the Custom XML file is cached  
 boolean
false/true
0/1
Width  
 Specifies the width of the Application  
 integer
0 - 0xFFFFFFFF
Height  
 Specifies the height of the Application  
 integer
0 - 0xFFFFFFFF
 
 
 
 
Detail  
 
The following set of Properties are defined at an Application level:  
 
BarSizeRelativeToAPage  
The size of the Pollstar100 Graph Bars is determined relativistically. That is to say that the Sample Data item with the greatest number of hits or votes is used as a maximum by which the length of all other data items' graph bars are scaled accordingly. The designer can use this Property to determine whether the scope of the maximum Sample Data item is at a page level or applies to the whole of the Sample Data set.  
 
 
DefaultGraphsView  
The designer can use this Property to define the default view that the end-user is initially presented with when a Pollstar100 Application is first loaded into the client browser. This behaviour may subsequently be overriden by the end-user via the implementation of the RememberView cookie-related Property.  
 
 
SamplePageSize  
Sample Data resides on the webserver within the Sample Data file and is streamed into the end-users browser via the Flash client. If so desired, the Sample Data can be streamed to the UI on a page-by-page basis. The end-user uses the Page Controls to navigate through multiple Sample Data pages. The designer uses this Property to define the Sample Data page size. The default sample page size is 5 items per page.  
 
 
AllowSorting  
The designer can use this Property to specify whether the set of Sample Data items are sortable or not for a specific Pollstar100 Application. If sorting is enabled then the end-user may click on any or all of the Column Controls to change the order in which the entire set of Sample Data items is presented in the client:  
 
 
DataFile  
This Property specifies the pathname of the Sample Data file on the webserver. This value can either be an absolute webserver pathname or a pathname relative to the location of the Pollstar100 Service. Note: The value of this Property may alternatively be defined within the HTML document that embeds the Pollstar100 Application within it. Also note that a value provided for this Property within the Custom XML file will override any such value provided within the embedding HTML document.  
 
 
VoteRecustomiseFile  
This Property provides the designer with the ability to dynamically alter the appearance of a Pollstar100 Application in response to the end-user casting a vote. This is useful for those designers wishing to show/hide various aspects of a Pollstar100 Application such as the Graph Panels and voting controls depending on whether the end-user has cast a vote or not. Use this Property to specify a pathname for an alternative Custom XML file for your Pollstar100 Application. The alternative custom configuration is triggered once the end-user has cast a vote. Note: in order to provide a smoother transition from one configuration to the other; only those Components defined in the alternative custom configuration file will be re-drawn. All other Components will remain unchanged.  
  
 
AutoRefreshSeconds  
If this Property is set to an integer greater than zero then the Pollstar100 Application will automatically request updates from the service. The value of this Property is the interval in seconds between subsequent update requests. Setting this Property to zero causes a Pollstar100 Application to make manual update requests only. Note: while not a requirement, it is suggested that resources are cached if autorefresh is turned on -otherwise some may get unnecessarily re-loaded on each update causing them to flicker.  
 
 
LoadResourceSeconds  
This Property is used to set the timeout period in seconds used by a Pollstar100 Application when it attempts to download external resources such as Component images. If this Property is set to zero then the Pollstar100 Application will wait indefinitely for an external resource to download.  
 
 
ShowResourceMarker  
This Property is used in conjunction with the LoadResourceSeconds Property. If this Property is set to true then an internal resource marker will be displayed in place of an external resource until either the resource has been successfully loaded or the LoadResourceSeconds timeout period has elapsed.  
 
 
CacheResources  
Use this Property to specify whether or not externally loaded resources such as images are cached in the end-users' browser cache. Typically during the design of a custom Application the designer will want to set this to false. Otherwise during normal usage it is likely to make for a smoother end-user experience if external resources are cached.  
 
 
CacheCustomFile  
Use this Property to specify whether or not the Applications' Custom XML file is cached in the end-users' browser cache. Typically during the design of a custom Application the designer will want to set this to false. During normal usage, it may still make sense not to cache the Custom XML file. Typically these files should be small and by not caching them, a designer can then make style changes at any time without the need to rename the Custom XML file (URL) in order for the changes to get picked up by existing end-users.  
 
 
Width  
This Property is used to set the width of the whole Application. The locations and sizes of all physical Components not defined within a Groupbox Component should be relative to this value.  
 
 
Height  
This Property is used to set the height of the whole Application. The locations and sizes of all physical Components not defined within a Groupbox Component should be relative to this value.  
 
  
 
 
Scope

The Properties listed in this section are defined as attributes of the XML tag corresponding to the following Components:
 
The Application