Difference between revisions of "Chart Gadget Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 80: | Line 80: | ||
!width="80%"|Description | !width="80%"|Description | ||
|- | |- | ||
| − | |valign="top"|Graph type||(Select from a known chart type (Horizontal Bar | Vertical Bar | Line | Pie | Gantt | Bipolar | Funnel | Radar | Rose | Scatter | Radial Scatter | Thermometer | Waterfall | Vertical Progress Bar | Horizontal Progress Bar) | + | |valign="top"|[[Chart Options#Graph type|Graph type]]||(Select from a known chart type (Horizontal Bar | Vertical Bar | Line | Pie | Gantt | Bipolar | Funnel | Radar | Rose | Scatter | Radial Scatter | Thermometer | Waterfall | Vertical Progress Bar | Horizontal Progress Bar) |
|- | |- | ||
| − | |valign="top"|Width||The chart width | + | |valign="top"|[[Chart Options#Size|Width]]||The chart width |
|- | |- | ||
| − | |valign="top"|Height||The chart height | + | |valign="top"|[[Chart Options#Size|Height]]||The chart height |
|- | |- | ||
| − | |valign="top"|Left gutter||The chart left gutter width in pixels | + | |valign="top"|[[Chart Options#Size|Left gutter]]||The chart left gutter width in pixels |
|- | |- | ||
| − | |valign="top"|Right gutter||The chart right gutter width in pixels | + | |valign="top"|[[Chart Options#Size|Right gutter]]||The chart right gutter width in pixels |
|- | |- | ||
| − | |valign="top"|Top gutter||The chart top gutter height in pixels | + | |valign="top"|[[Chart Options#Size|Top gutter]]||The chart top gutter height in pixels |
|- | |- | ||
| − | |valign="top"|Bottom gutter||The chart bottom gutter height in pixels | + | |valign="top"|[[Chart Options#Size|Bottom gutter]]||The chart bottom gutter height in pixels |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Appearance|Background color]]||The color of the chart canvas as an html-like color |
|- | |- | ||
| − | |valign="top"|Shadow||Enable or disable 3D shadowing (True | False). | + | |valign="top"|[[Chart Options#Appearance|Shadow]]||Enable or disable 3D shadowing (True | False). |
|- | |- | ||
| − | |valign="top"|Effects||Enable or disable special effects for displaying the chart (True | False). | + | |valign="top"|[[Chart Options#Appearance|Effects]]||Enable or disable special effects for displaying the chart (True | False). |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Appearance|Gradient colors]]||Enable or disable gradient colors (True | False). |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Appearance|Gradient start color]]||The start gradient color |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Appearance|Gradient end color]]||The end gradient color |
|- | |- | ||
| − | |valign="top"|Title||The chart title | + | |valign="top"|[[Chart Options#Title|Title]]||The chart title |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Title|Title foreground color]]||The chart title foreground color |
|- | |- | ||
| − | |valign="top"|[[ | + | |valign="top"|[[Chart Options#Title|Title background color]]||The chart title background color |
|- | |- | ||
| − | |valign="top"|Data||The comma separated list of chart data. For grouped data, separate the groups with a | character. | + | |valign="top"|[[Chart Options#Data|Data]]||The comma separated list of chart data. For grouped data, separate the groups with a | character. |
|- | |- | ||
| − | |valign="top"|Labels||The chart labels | + | |valign="top"|[[Chart Options#Labels|Labels]]||The chart labels |
|- | |- | ||
| − | |valign="top"|Label foreground color||The chart label foreground color | + | |valign="top"|[[Chart Options#Labels|Label foreground color]]||The chart label foreground color |
|- | |- | ||
| − | |valign="top"|Labels above||Enable or disable displaying a summary label next to the segment (True | False). | + | |valign="top"|[[Chart Options#Labels|Labels above]]||Enable or disable displaying a summary label next to the segment (True | False). |
|- | |- | ||
| − | |valign="top"|Legend labels||The chart legend labels | + | |valign="top"|[[Chart Options#Labels|Legend labels]]||The chart legend labels |
|- | |- | ||
| − | |valign="top"|Tooltips||A comma separated list of tooltips that are passed to the delegate | + | |valign="top"|[[Chart Options#Tooltips|Tooltips]]||A comma separated list of tooltips that are passed to the delegate |
|- | |- | ||
| − | |valign="top"|Colors||A comma separated list of html-style colors (one for each segment) | + | |valign="top"|[[Chart Options#Appearance|Colors]]||A comma separated list of html-style colors (one for each segment) |
|- | |- | ||
| − | |valign="top"|Delegate||An optional delegate to be called when segments of the chart are selected. By default the 'tooltip' for the segment selected will be used as a search key in any child sections. | + | |valign="top"|[[Chart Options#Delegate|Delegate]]||An optional delegate to be called when segments of the chart are selected. By default the 'tooltip' for the segment selected will be used as a search key in any child sections. |
|- | |- | ||
|} | |} | ||
Revision as of 10:36, 20 May 2016
Under construction
Contents
Details
| Attribute | Description |
|---|---|
| Name | The name for this gadget (unique to the section) |
| Meta types | A comma separated list of metatype names |
| Type | The type of control: Gadget (readonly) |
| Gadget type | The type of gadget: webview (readonly) |
| Margin | Margin size around the gadget |
| Fixed width | Fixed gadget width in pixels |
| Fixed height | Fixed gadget height in pixels |
| Inline | Render the gadget inline rather than it its own column (True | False) |
| Stretch width | Auto stretch the width of the gadget into the width of the section (True | False) |
Geometry
| Attribute | Description |
|---|---|
| Absolute | Enable or disable absolute positioning (True | False) |
| Top | Top position in pixels |
| Left | Left position in pixels |
| Width | Width in pixels |
| Height | Height in pixels |
| CSS style | CSS style (separate attributes with ; or use app:/filename.css) |
Caption
| Attribute | Description |
|---|---|
| Caption | The caption for the gadget |
| Background color | The background color for the caption |
| Foreground color | The foreground color for the caption |
| Font | The font for the caption |
| Icon | The image for the caption (png | jpg | gif). Use app:/imagename.ext for app specific images. |
| Border width | The caption border width |
| Border color | The caption border color |
| Transparency | Specify a transparency percentage from 0 to 100 |
| Gradient colors | Render the caption color as a gradient (True | False) |
| Gradient type | Specify the gradient type |
| Gradient start color | Gradient start color |
| Gradient end color | Gradient end color |
Chart Options
| Attribute | Description |
|---|---|
| Graph type | (Select from a known chart type (Horizontal Bar | Vertical Bar | Line | Pie | Gantt | Bipolar | Funnel | Radar | Rose | Scatter | Radial Scatter | Thermometer | Waterfall | Vertical Progress Bar | Horizontal Progress Bar) |
| Width | The chart width |
| Height | The chart height |
| Left gutter | The chart left gutter width in pixels |
| Right gutter | The chart right gutter width in pixels |
| Top gutter | The chart top gutter height in pixels |
| Bottom gutter | The chart bottom gutter height in pixels |
| Background color | The color of the chart canvas as an html-like color |
| Shadow | Enable or disable 3D shadowing (True | False). |
| Effects | Enable or disable special effects for displaying the chart (True | False). |
| Gradient colors | Enable or disable gradient colors (True | False). |
| Gradient start color | The start gradient color |
| Gradient end color | The end gradient color |
| Title | The chart title |
| Title foreground color | The chart title foreground color |
| Title background color | The chart title background color |
| Data | The comma separated list of chart data. For grouped data, separate the groups with a | character. |
| Labels | The chart labels |
| Label foreground color | The chart label foreground color |
| Labels above | Enable or disable displaying a summary label next to the segment (True | False). |
| Legend labels | The chart legend labels |
| Tooltips | A comma separated list of tooltips that are passed to the delegate |
| Colors | A comma separated list of html-style colors (one for each segment) |
| Delegate | An optional delegate to be called when segments of the chart are selected. By default the 'tooltip' for the segment selected will be used as a search key in any child sections. |
Other Options
| Attribute | Description |
|---|---|
| Hide header | Hide gadget header at runtime (True | False) |
Permissions and Roles
| Attribute | Description |
|---|---|
| Read roles | A comma separated list of roles that can read (and view) the data |
| Update roles | A comma separated list of roles that can perform update operations on the data |
UI Presentation Rules
| Attribute | Description |
|---|---|
| Desktop | Include this gadget in a Desktop client (True | False). |
| Web | Include this gadget in a Web client (True | False). |
| Tablet | Include this gadget in a Tablet client (True | False). |
| Phone | Include this gadget in a Phone client (True | False). |
| UI States | UI states that affect this gadget. Specify multiple states as a comma separated list. |
| Initial UI state | The initial UI state for this gadget. |
| Readonly when | Gadget is readonly at runtime if specified expression evaluates to true. |
| Visible when | Gadget is visible at runtime if specified expression evaluates to true. |
| Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) |
| Apply rules on change | Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). |
