Difference between revisions of "Chart Gadget Attributes"

Revision as of 11:02, 7 July 2016

Getting and Setting Attributes

The setAttribute(name, value) method can be used to set the value of an Attribute:

Lianja.get("pageid.sectionid.fieldid").setAttribute("caption","Formitem1")

Note: the shortened form setAttr(name,value) is also available.

The getAttribute(name) method can be used to get the value of an Attribute:

cTitle = Lianja.get("pageid.sectionid.fieldid").getAttribute("caption")

Note: the shortened form getAttr(name) is also available.

Details

Attribute	Description	Name	Type
Name	The name for this gadget (unique to the section)	id	Character
Meta types	A comma separated list of metatype names	metatypes	Character
Type	The type of control: Gadget (readonly)	type	Character
Gadget type	The type of gadget: chart (readonly)	gadgetType	Character
Margin	Margin size around the gadget	gadgetMargin	Int
Fixed width	Fixed gadget width in pixels	gadgetFixedWidth	Int
Fixed height	Fixed gadget height in pixels	gadgetFixedHeight	Int
Inline	Render the gadget inline rather than it its own column (True \| False)	gadgetInline	Boolean
Stretch width	Auto stretch the width of the gadget into the width of the section (True \| False)	gadgetStretchWidth	Boolean

Geometry

Attribute	Description	Name	Type
Absolute	Enable or disable absolute positioning (True \| False)	absolutePosition	Boolean
Top	Top position in pixels	absolutePositionY	Int
Left	Left position in pixels	absolutePositionX	Int
Width	Width in pixels	absolutePositionWidth	Int
Height	Height in pixels	absolutePositionHeight	Int
CSS style	CSS style (separate attributes with ; or use app:/filename.css)	cssStyle	Character

Caption

Attribute	Description	Name	Type
Caption	The caption for the gadget	caption	Character
Background color	The background color for the caption	backColor	Character
Foreground color	The foreground color for the caption	foreColor	Character
Font	The font for the caption	captionFont	Character
Icon	The image for the caption (png \| jpg \| gif). Use app:/imagename.ext for app specific images.	captionIcon	Character
Border width	The caption border width	captionBorderWidth	Int
Border color	The caption border color	captionBorderColor	Character
Transparency	Specify a transparency percentage from 0 to 100	transparency	Int
Gradient colors	Render the caption color as a gradient (True \| False)	captionGradient	Boolean
Gradient type	Specify the gradient type	captionGradientType	Int
Gradient start color	Gradient start color	captionFromColor	Character
Gradient end color	Gradient end color	captionToColor	Character

Chart Options

Attribute	Description	Name	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)	chartUrlType	Character
Width	The chart width	chartWidth	Int
Height	The chart height		Int
Left gutter	The chart left gutter width in pixels	chartGutterLeft	Int
Right gutter	The chart right gutter width in pixels	chartGutterRight	Int
Top gutter	The chart top gutter height in pixels	chartGutterTop	Int
Bottom gutter	The chart bottom gutter height in pixels	chartGutterBottom	Int
Background color	The color of the chart canvas as an html-like color	chartBackColor	Character
Shadow	Enable or disable 3D shadowing (True \| False).	chartShadow	Boolean
Effects	Enable or disable special effects for displaying the chart (True \| False).	chartEffects	Boolean
Gradient colors	Enable or disable gradient colors (True \| False).	chartGradient	Boolean
Gradient start color	The start gradient color	chartGradientstart	Character
Gradient end color	The end gradient color	chartGradientend	Character
Title	The chart title	chartTitle	Character
Title foreground color	The chart title foreground color	chartTitleForeColor	Character
Title background color	The chart title background color	chartTitleBackColor	Character
Data	The comma separated list of chart data. For grouped data, separate the groups with a \| character.	chartData	Character
Labels	The chart labels	chartLabels	Character
Label foreground color	The chart label foreground color	chartLabelColor	Character
Labels above	Enable or disable displaying a summary label next to the segment (True \| False).	chartLabelsAbove	Boolean
Legend labels	The chart legend labels	chartKeyLabels	Character
Tooltips	A comma separated list of tooltips that are passed to the delegate	chartTooltips	Character
Colors	A comma separated list of html-style colors (one for each segment)	chartColors	Character
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.	chartDelegate	Character

Other Options

Attribute	Description	Name	Type
Hide header	Hide gadget header at runtime (True \| False)	gadgetHideHeader	Boolean

Permissions and Roles

Attribute	Description	Name	Type
Read roles	A comma separated list of roles that can read (and view) the data.	permRead	Character
Update roles	A comma separated list of roles that can perform update operations on the data.	permUpdate	Character

UI Presentation Rules

Attribute	Description	Name	Type
Desktop	Include this gadget in a Desktop client (True \| False).	desktopUI	Boolean
Web	Include this gadget in a Web client (True \| False).	webUI	Boolean
Tablet	Include this gadget in a Tablet client (True \| False).	tabletUI	Boolean
Phone	Include this gadget in a Phone client (True \| False).	mobileUI	Boolean
UI States	UI states that affect this gadget. Specify multiple states as a comma separated list.	state	Character
Initial UI state	The initial UI state for this gadget.	uiStateInit	Character
Readonly when	Gadget is readonly at runtime if specified expression evaluates to true.	readonlyWhen	Character
Visible when	Gadget is visible at runtime if specified expression evaluates to true.	visibleWhen	Character
Display orientation	Display depending on mobile device orientation for Tablets and Phones. (Always \| Portrait \| Landscape)	displayOrientation	Character
Apply rules on change	Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True \| False).	applyRulesOnChange	Boolean

@@ Line 128: / Line 128: @@
 |-
 |valign="top"|[[Chart Options#Graph type|Graph type]]||(Select from a known chart type (Horizontal Bar &#124; Vertical Bar &#124; Line &#124; Pie &#124; Gantt &#124; Bipolar &#124; Funnel &#124; Radar &#124; Rose &#124; Scatter &#124; Radial Scatter &#124; Thermometer &#124; Waterfall &#124; Vertical Progress Bar &#124; Horizontal Progress Bar)
+|valign="top"|chartUrlType||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Size|Width]]||The chart width
+|valign="top"|chartWidth||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Size|Height]]||The chart height
+|valign="top"| ||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Size|Left gutter]]||The chart left gutter width in pixels
+|valign="top"|chartGutterLeft||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Size|Right gutter]]||The chart right gutter width in pixels
+|valign="top"|chartGutterRight||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Size|Top gutter]]||The chart top gutter height in pixels
+|valign="top"|chartGutterTop||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Size|Bottom gutter]]||The chart bottom gutter height in pixels
+|valign="top"|chartGutterBottom||valign="top"|Int
 |-
 |valign="top"|[[Chart Options#Appearance|Background color]]||The color of the chart canvas as an html-like color
+|valign="top"|chartBackColor||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Appearance|Shadow]]||Enable or disable 3D shadowing (True &#124; False).
+|valign="top"|chartShadow||valign="top"|Boolean
 |-
 |valign="top"|[[Chart Options#Appearance|Effects]]||Enable or disable special effects for displaying the chart (True &#124; False).
+|valign="top"|chartEffects||valign="top"|Boolean
 |-
 |valign="top"|[[Chart Options#Appearance|Gradient colors]]||Enable or disable gradient colors (True &#124; False).
+|valign="top"|chartGradient||valign="top"|Boolean
 |-
 |valign="top"|[[Chart Options#Appearance|Gradient start color]]||The start gradient color
+|valign="top"|chartGradientstart||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Appearance|Gradient end color]]||The end gradient color
+|valign="top"|chartGradientend||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Title|Title]]||The chart title
+|valign="top"|chartTitle||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Title|Title foreground color]]||The chart title foreground color
+|valign="top"|chartTitleForeColor||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Title|Title background color]]||The chart title background color
+|valign="top"|chartTitleBackColor||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Data|Data]]||The comma separated list of chart data.  For grouped data, separate the groups with a  &#124;  character.
+|valign="top"|chartData||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Labels|Labels]]||The chart labels
+|valign="top"|chartLabels||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Labels|Label foreground color]]||The chart label foreground color
+|valign="top"|chartLabelColor||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Labels|Labels above]]||Enable or disable displaying a summary label next to the segment (True &#124; False).
+|valign="top"|chartLabelsAbove||valign="top"|Boolean
 |-
 |valign="top"|[[Chart Options#Labels|Legend labels]]||The chart legend labels
+|valign="top"|chartKeyLabels||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Tooltips|Tooltips]]||A comma separated list of tooltips that are passed to the delegate
+|valign="top"|chartTooltips||valign="top"|Character
 |-
 |valign="top"|[[Chart Options#Appearance|Colors]]||A comma separated list of html-style colors (one for each segment)
+|valign="top"|chartColors||valign="top"|Character
 |-
 |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.
+|valign="top"|chartDelegate||valign="top"|Character
 |-
 |}