More actions
Cg huyphong (talk | contribs) No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{HelpFiles}} | |||
{{HelpFiles}} | |||
=== Tabulation_getDiagramStyle === | |||
Gets a session chart style object for a specif style type set in session. Style types are set in session using the Tabulation_setDiagramStyle function. | Gets a session chart style object for a specif style type set in session. Style types are set in session using the Tabulation_setDiagramStyle function. | ||
'''Syntax''' | '''Syntax''' | ||
Tabulation_getDiagramStyle(''styleType'') | Tabulation_getDiagramStyle(''styleType'') | ||
'''Arguments''' | '''Arguments''' | ||
''styleType'': enumeration for style type. Below is the full list of style type enumerations: | ''styleType'': enumeration for style type. Below is the full list of style type enumerations: | ||
TableDiagram_AllTable = 0 | TableDiagram_AllTable = 0 | ||
TableDiagram_ColumnHeader = 1 | TableDiagram_ColumnHeader = 1 | ||
TableDiagram_ColumnHeaderLevel1 = 2 | TableDiagram_ColumnHeaderLevel1 = 2 | ||
TableDiagram_ColumnHeaderLevel2 = 3 | TableDiagram_ColumnHeaderLevel2 = 3 | ||
TableDiagram_ColumnHeaderLevel3 = 4 | TableDiagram_ColumnHeaderLevel3 = 4 | ||
TableDiagram_ColumnHeaderLevel4 = 5 | TableDiagram_ColumnHeaderLevel4 = 5 | ||
TableDiagram_RowHeader = 6 | TableDiagram_RowHeader = 6 | ||
TableDiagram_RowHeaderLevel1 = 7 | TableDiagram_RowHeaderLevel1 = 7 | ||
TableDiagram_RowHeaderLevel2 = 8 | TableDiagram_RowHeaderLevel2 = 8 | ||
TableDiagram_RowHeaderLevel3 = 9 | TableDiagram_RowHeaderLevel3 = 9 | ||
TableDiagram_AnswerRow = 10 | TableDiagram_AnswerRow = 10 | ||
TableDiagram_AnswerRowAlternate = 11 | TableDiagram_AnswerRowAlternate = 11 | ||
TableDiagram_AbsoluteColumn = 12 | TableDiagram_AbsoluteColumn = 12 | ||
TableDiagram_AbsoluteColumnHeader = 13 | TableDiagram_AbsoluteColumnHeader = 13 | ||
TableDiagram_AbsoluteColumnValue = 14 | TableDiagram_AbsoluteColumnValue = 14 | ||
TableDiagram_PercentageColumn = 15 | TableDiagram_PercentageColumn = 15 | ||
TableDiagram_PercentageColumnHeader = 16 | TableDiagram_PercentageColumnHeader = 16 | ||
TableDiagram_PercentageColumnValue = 17 | TableDiagram_PercentageColumnValue = 17 | ||
TableDiagram_TotalColumn = 18 | TableDiagram_TotalColumn = 18 | ||
TableDiagram_TotalColumnHeader = 19 | TableDiagram_TotalColumnHeader = 19 | ||
TableDiagram_TotalColumnValue = 20 | TableDiagram_TotalColumnValue = 20 | ||
TableDiagram_TotalRow = 21 | TableDiagram_TotalRow = 21 | ||
TableDiagram_TotalRowHeader = 22 | TableDiagram_TotalRowHeader = 22 | ||
TableDiagram_TotalRowValue = 23 | TableDiagram_TotalRowValue = 23 | ||
TableDiagram_VarianceRow = 24 | TableDiagram_VarianceRow = 24 | ||
TableDiagram_VarianceRowHeader = 25 | TableDiagram_VarianceRowHeader = 25 | ||
TableDiagram_VarianceRowValue = 26 | TableDiagram_VarianceRowValue = 26 | ||
TableDiagram_AverageRow = 27 | TableDiagram_AverageRow = 27 | ||
TableDiagram_AverageRowHeader = 28 | TableDiagram_AverageRowHeader = 28 | ||
TableDiagram_AverageRowValue = 29 | TableDiagram_AverageRowValue = 29 | ||
TableDiagram_StdDevRow = 30 | TableDiagram_StdDevRow = 30 | ||
TableDiagram_StdDevRowHeader = 31 | TableDiagram_StdDevRowHeader = 31 | ||
TableDiagram_StdDevRowValue = 32 | TableDiagram_StdDevRowValue = 32 | ||
TableDiagram_StdErrorRow = 33 | TableDiagram_StdErrorRow = 33 | ||
TableDiagram_StdErrorRowHeader = 34 | TableDiagram_StdErrorRowHeader = 34 | ||
TableDiagram_StdErrorRowValue = 35 | TableDiagram_StdErrorRowValue = 35 | ||
TableDiagram_MedianRow = 36 | TableDiagram_MedianRow = 36 | ||
TableDiagram_MedianRowHeader = 37 | TableDiagram_MedianRowHeader = 37 | ||
TableDiagram_MedianRowValue = 38 | TableDiagram_MedianRowValue = 38 | ||
TableDiagram_QuantilesRow = 39 | TableDiagram_QuantilesRow = 39 | ||
TableDiagram_QuantilesRowHeader = 40 | TableDiagram_QuantilesRowHeader = 40 | ||
TableDiagram_QuantilesRowValue = 41 | TableDiagram_QuantilesRowValue = 41 | ||
TableDiagram_PercentileRow = 42 | TableDiagram_PercentileRow = 42 | ||
TableDiagram_PercentileRowHeader = 43 | TableDiagram_PercentileRowHeader = 43 | ||
TableDiagram_PercentileRowValue = 44 | TableDiagram_PercentileRowValue = 44 | ||
TableDiagram_SignificanceRow = 45 | TableDiagram_SignificanceRow = 45 | ||
TableDiagram_SignificanceRowHeader = 46 | TableDiagram_SignificanceRowHeader = 46 | ||
TableDiagram_SignificanceRowValue = 47 | TableDiagram_SignificanceRowValue = 47 | ||
'''Return type''' | '''Return type''' | ||
Returns the following array | Returns the following array | ||
{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2" | {| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" bgcolor="#F59D56" | | | style="border: 1px solid #010101" width="227" bgcolor="#F59D56" | | ||
Constant | Constant | ||
| style="border: 1px solid #010101" width="73" bgcolor="#F59D56" | | |||
Type | | style="border: 1px solid #010101" width="73" bgcolor="#F59D56" | | ||
| style="border: 1px solid #010101" width="174" bgcolor="#F59D56" | | Type | ||
Initial/Default value | |||
| style="border: 1px solid #010101" width="433" bgcolor="#F59D56" | | | style="border: 1px solid #010101" width="174" bgcolor="#F59D56" | | ||
Description | Initial/Default value | ||
| style="border: 1px solid #010101" width="433" bgcolor="#F59D56" | | |||
Description | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
OBJECT_TYPE | OBJECT_TYPE | ||
| style="border: 1px solid #010101" width="73" | | |||
Number | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | Number | ||
21 | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Enumeration defining the object type. | 21 | ||
| style="border: 1px solid #010101" width="433" | | |||
Enumeration defining the object type. | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
TABLE_DIAGRAM_STYLE_FILL | TABLE_DIAGRAM_STYLE_FILL | ||
| style="border: 1px solid #010101" width="73" | | |||
Array | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | Array | ||
As set in the object | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Fill style. Background color. | As set in the object | ||
| style="border: 1px solid #010101" width="433" | | |||
Fill style. Background color. | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
TABLE_DIAGRAM_STYLE_DECIMAL | TABLE_DIAGRAM_STYLE_DECIMAL | ||
| style="border: 1px solid #010101" width="73" | | |||
Number | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | Number | ||
As set in the object | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Decimal place. | As set in the object | ||
| style="border: 1px solid #010101" width="433" | | |||
Decimal place. | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
TABLE_DIAGRAM_STYLE_FONT | TABLE_DIAGRAM_STYLE_FONT | ||
| style="border: 1px solid #010101" width="73" | | |||
Array | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | Array | ||
As set in the object | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Font. | As set in the object | ||
| style="border: 1px solid #010101" width="433" | | |||
Font. | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
TABLE_DIAGRAM_STYLE_VALIGN | TABLE_DIAGRAM_STYLE_VALIGN | ||
| style="border: 1px solid #010101" width="73" | | |||
String | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | String | ||
As set in the object | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Vertical alignment (allows values "top", "center", or "bottom"). | As set in the object | ||
| style="border: 1px solid #010101" width="433" | | |||
Vertical alignment (allows values "top", "center", or "bottom"). | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid #010101" width="227" | | | style="border: 1px solid #010101" width="227" | | ||
TABLE_DIAGRAM_STYLE_HALIGN | TABLE_DIAGRAM_STYLE_HALIGN | ||
| style="border: 1px solid #010101" width="73" | | |||
String | | style="border: 1px solid #010101" width="73" | | ||
| style="border: 1px solid #010101" width="174" | | String | ||
As set in the object | |||
| style="border: 1px solid #010101" width="433" | | | style="border: 1px solid #010101" width="174" | | ||
Horizontal alignment (allows values "left", "center", or "right"). | As set in the object | ||
| style="border: 1px solid #010101" width="433" | | |||
Horizontal alignment (allows values "left", "center", or "right").'''<br>''' | |||
|} | |||
array significancerow = Tabulation_getDiagramStyle(45); | '''Examples'''<br> array significancerow = Tabulation_getDiagramStyle(45);<br> | ||
'''Availability''' | '''Availability'''<br> Version 5.8.1 | ||
[[Category:Style_setting_functions]] | |||
Revision as of 07:26, 6 January 2012
Tabulation_getDiagramStyle
Gets a session chart style object for a specif style type set in session. Style types are set in session using the Tabulation_setDiagramStyle function.
Syntax
Tabulation_getDiagramStyle(styleType)
Arguments
styleType: enumeration for style type. Below is the full list of style type enumerations:
TableDiagram_AllTable = 0
TableDiagram_ColumnHeader = 1
TableDiagram_ColumnHeaderLevel1 = 2
TableDiagram_ColumnHeaderLevel2 = 3
TableDiagram_ColumnHeaderLevel3 = 4
TableDiagram_ColumnHeaderLevel4 = 5
TableDiagram_RowHeader = 6
TableDiagram_RowHeaderLevel1 = 7
TableDiagram_RowHeaderLevel2 = 8
TableDiagram_RowHeaderLevel3 = 9
TableDiagram_AnswerRow = 10
TableDiagram_AnswerRowAlternate = 11
TableDiagram_AbsoluteColumn = 12
TableDiagram_AbsoluteColumnHeader = 13
TableDiagram_AbsoluteColumnValue = 14
TableDiagram_PercentageColumn = 15
TableDiagram_PercentageColumnHeader = 16
TableDiagram_PercentageColumnValue = 17
TableDiagram_TotalColumn = 18
TableDiagram_TotalColumnHeader = 19
TableDiagram_TotalColumnValue = 20
TableDiagram_TotalRow = 21
TableDiagram_TotalRowHeader = 22
TableDiagram_TotalRowValue = 23
TableDiagram_VarianceRow = 24
TableDiagram_VarianceRowHeader = 25
TableDiagram_VarianceRowValue = 26
TableDiagram_AverageRow = 27
TableDiagram_AverageRowHeader = 28
TableDiagram_AverageRowValue = 29
TableDiagram_StdDevRow = 30
TableDiagram_StdDevRowHeader = 31
TableDiagram_StdDevRowValue = 32
TableDiagram_StdErrorRow = 33
TableDiagram_StdErrorRowHeader = 34
TableDiagram_StdErrorRowValue = 35
TableDiagram_MedianRow = 36
TableDiagram_MedianRowHeader = 37
TableDiagram_MedianRowValue = 38
TableDiagram_QuantilesRow = 39
TableDiagram_QuantilesRowHeader = 40
TableDiagram_QuantilesRowValue = 41
TableDiagram_PercentileRow = 42
TableDiagram_PercentileRowHeader = 43
TableDiagram_PercentileRowValue = 44
TableDiagram_SignificanceRow = 45
TableDiagram_SignificanceRowHeader = 46
TableDiagram_SignificanceRowValue = 47
Return type
Returns the following array
Constant |
Type |
Initial/Default value |
Description |
OBJECT_TYPE |
Number |
21 |
Enumeration defining the object type. |
TABLE_DIAGRAM_STYLE_FILL |
Array |
As set in the object |
Fill style. Background color. |
TABLE_DIAGRAM_STYLE_DECIMAL |
Number |
As set in the object |
Decimal place. |
TABLE_DIAGRAM_STYLE_FONT |
Array |
As set in the object |
Font. |
TABLE_DIAGRAM_STYLE_VALIGN |
String |
As set in the object |
Vertical alignment (allows values "top", "center", or "bottom"). |
TABLE_DIAGRAM_STYLE_HALIGN |
String |
As set in the object |
Horizontal alignment (allows values "left", "center", or "right"). |
Examples
array significancerow = Tabulation_getDiagramStyle(45);
Availability
Version 5.8.1