|
Property Name
|
Description
|
Type
|
Values
|
|
FGBarImage
BGBarImage ONBarImage |
Determines the actual image data that is mapped to a graph bar image type.
|
string
|
null = no image
default = internal vector based URL = external JPG or SWF |
|
FGBarOpacity
BGBarOpacity ONBarOpacity |
Determines the opacity of the graph bar image type.
|
percentile
|
0 - 100
0 = completely transparent |
|
FGBarBorderRadius
BGBarBorderRadius ONBarBorderRadius |
Determines how rounded the corners of a vector-based graph bar image type will be.
|
CSV percentiles
|
0-100 [, 0-100, 0-100, 0-100]
0 => square corners |
|
FGBarBorderColour
BGBarBorderColour ONBarBorderColour |
Determines the colour of a vector-based bar image border
|
integer
|
0 - 0xFFFFFF
|
|
FGBarBorderWeight
BGBarBorderWeight ONBarBorderWeight |
Determines the weight of a vector-based bar image border
|
percentile
|
0 - min(Width,Height)
|
|
FGBarColours
BGBarColours ONBarColours |
Determines the fill colours of a vector-based bar image
|
CSV integers
|
0 - 0xFFFFFF [,0 - 0xFFFFFF]
|
|
UseBarMask
|
Determines whether or not the graph bar will be masked
|
boolean
|
false/true
0/1 |
Detail
The following Properties provide the designer with the means to specify how and what image data is mapped to each graph bar comprising a specified Graph Panel. Graph bars are made up of the following four elements:
| · | A mouse-over bar image.
|
| · | A foreground bar image.
|
| · | A background bar image.
|
| · | A bar mask.
|
The ONBar... Property set relates to the mouse-over bar image. This image is of constant length and overlays the foreground and background bar images when the mouse pointer is over a graph bar. Note: The ONBar... Property set may only be defined for the Votes Panel and is only of relevance if the developer wishes to enable to the end-user to be able to vote by clicking on a graph bar.
The BGBar... Property set relates to the background bar image. This image is of constant length and is overlayed by the foreground bar image.
The BGBar... Property set relates to the foreground bar image. If a bar mask is undefined then the length of the foreground bar image is dynamic and determined by the relative magnitude of the data relating to the Graph Panel.
If a bar mask is defined then the foreground bar image length is constant and the same as that of the background bar image. The bar mask overlays the foreground bar image and makes the foreground bar image transparent thus making the background bar image visible. The length of the bar mask is dynamic and determined by the relative magnitude of the data relating to the Graph Panel. Click on the little red mushroom rating scale in the diagram for Example Two to see how this is of use.
FGBarImage - the foreground bar image Property.
BGBarImage - the background bar image Property.
ONBarImage - the mouse-over bar image Property.
Use these Properties to define the source of any image data that is to be mapped to the foreground and background bar images. Image data can come from an internal or an external source.
FGBarOpacity - the foreground bar image opacity Property.
BGBarOpacity - the background bar image opacity Property.
ONBarOpacity - the mouse-over bar image opacity Property.
Use these Properties to define the percentage opacity of any external or internal image data that has been mapped to the foreground and background bar images. A value of zero will cause the image data to be invisible; a value of 100 will cause the image data to be entirely opaque.
UseBarMask
Use this Property to enable/disable the bar mask. The actual mask object is provided by the system.
Default Images
The following Properties affect the appearance of the default vector-based bar images only. If the designer chooses to provide their own external images these Properties will have no effect.
FGBarBorderRadius - the foreground bar border radius.
BGBarBorderRadius - the background bar border radius.
ONBarBorderRadius - the mouse-over bar border radius.
Use these Properties to specify how rounded each corner of the bar images will be. Property values can be either of the following:
| · | a single integer. each corner of the Component will have be rounded by the same amount; a value of zero will cause the Component to have right-angled corners.
|
| · | a comma separated list of up to four percentile integers. Each integer is a percentile that defines the top-left, top-right, bottom-right and bottom left corners respectively. Any more than four integers will be ignored; two or three integers will cause the unspecified corners to have right-angled corners.
|
FGBarBorderWeight - the foreground bar border weight
BGBarBorderWeight - the background bar border weight
ONBarBorderWeight - the mouse-over bar border weight
Use these Properties to define a border line for the bar images. A value of zero defines no border line.
FGBarBorderColour - the foreground bar border colour
BGBarBorderColour - the background bar border colour
ONBarBorderColour - the mouse-over bar border colour
If the <Bar Image Type>BorderWeight Property is greater than zero then these Properties can be used to specify the colour of the border line.
FGBarColours - the foreground bar image colour(s).
BGBarColours - the background bar image colour(s)
ONBarColours - the mouse-over bar image colour(s)
Use these Properties to specify the bar image fill colour(s). Property values can be either a single integer in the range 0 - 0xFFFFFF or a comma separated list of up to two integers. In the latter case the bar image will be gradient filled from left to right with the first integer in the list being the left hand colour and the second being the right hand colour.
Scope
The Properties listed in this section are defined as attributes of the XML tag corresponding to the following Components:
The Graph Panels:
| The Votes Panel
|
| The Hits Panel
|
| The Ratings Panel
|
