Difference between revisions of "Tabulation getDiagramStyle"

From Catglobe Wiki
Jump to: navigation, search
(jrfconvert import)
 
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:HelpBooks]]
+
= Tabulation_getDiagramStyle =
−

+
__NOTOC__
 +
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'')
 +
 
 +
or can use [[TabulationDiagramParameter_class|TabulationDiagramParameter.GetDiagramStyle(styleType);]]
 +
 
 +
==Arguments==
 +
 
 +
''styleType'': enumeration for style type. Below is the full list of style type enumerations:
 +
 
 +
TableDiagram_AllTable
 +
 
 +
TableDiagram_ColumnHeader
 +
 
 +
TableDiagram_ColumnHeaderLevel1
 +
 
 +
TableDiagram_ColumnHeaderLevel2
 +
 
 +
TableDiagram_ColumnHeaderLevel3
  
−
=====Tabulation_getDiagramStyle=====
+
TableDiagram_ColumnHeaderLevel4
  
−
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.
+
TableDiagram_RowHeader
  
−
'''Syntax'''
+
TableDiagram_RowHeaderLevel1
  
−
Tabulation_getDiagramStyle(''styleType'')
+
TableDiagram_RowHeaderLevel2
  
−
'''Arguments'''
+
TableDiagram_RowHeaderLevel3
  
−
''styleType'': enumeration for style type. Below is the full list of style type enumerations:
+
TableDiagram_AnswerRow 
  
−
TableDiagram_AllTable = 0
+
TableDiagram_AnswerRowAlternate
  
−
TableDiagram_ColumnHeader = 1
+
TableDiagram_AbsoluteColumn
  
−
TableDiagram_ColumnHeaderLevel1 = 2
+
TableDiagram_AbsoluteColumnHeader
  
−
TableDiagram_ColumnHeaderLevel2 = 3
+
TableDiagram_AbsoluteColumnValue
  
−
TableDiagram_ColumnHeaderLevel3 = 4
+
TableDiagram_PercentageColumn
  
−
TableDiagram_ColumnHeaderLevel4 = 5
+
TableDiagram_PercentageColumnHeader
  
−
TableDiagram_RowHeader = 6
+
TableDiagram_PercentageColumnValue
  
−
TableDiagram_RowHeaderLevel1 = 7
+
TableDiagram_TotalColumn 
  
−
TableDiagram_RowHeaderLevel2 = 8
+
TableDiagram_TotalColumnHeader
  
−
TableDiagram_RowHeaderLevel3 = 9
+
TableDiagram_TotalColumnValue
  
−
TableDiagram_AnswerRow = 10
+
TableDiagram_TotalRow
  
−
TableDiagram_AnswerRowAlternate = 11
+
TableDiagram_TotalRowHeader
  
−
TableDiagram_AbsoluteColumn = 12
+
TableDiagram_TotalRowValue
  
−
TableDiagram_AbsoluteColumnHeader = 13
+
TableDiagram_VarianceRow
  
−
TableDiagram_AbsoluteColumnValue = 14
+
TableDiagram_VarianceRowHeader
  
−
TableDiagram_PercentageColumn = 15
+
TableDiagram_VarianceRowValue
  
−
TableDiagram_PercentageColumnHeader = 16
+
TableDiagram_AverageRow
  
−
TableDiagram_PercentageColumnValue = 17
+
TableDiagram_AverageRowHeader
  
−
TableDiagram_TotalColumn = 18
+
TableDiagram_AverageRowValue
  
−
TableDiagram_TotalColumnHeader = 19
+
TableDiagram_StdDevRow
  
−
TableDiagram_TotalColumnValue = 20
+
TableDiagram_StdDevRowHeader
  
−
TableDiagram_TotalRow = 21
+
TableDiagram_StdDevRowValue
  
−
TableDiagram_TotalRowHeader = 22
+
TableDiagram_StdErrorRow
  
−
TableDiagram_TotalRowValue = 23
+
TableDiagram_StdErrorRowHeader
  
−
TableDiagram_VarianceRow = 24
+
TableDiagram_StdErrorRowValue
  
−
TableDiagram_VarianceRowHeader = 25
+
TableDiagram_MedianRow
  
−
TableDiagram_VarianceRowValue = 26
+
TableDiagram_MedianRowHeader
  
−
TableDiagram_AverageRow = 27
+
TableDiagram_MedianRowValue
  
−
TableDiagram_AverageRowHeader = 28
+
TableDiagram_QuantilesRow
  
−
TableDiagram_AverageRowValue = 29
+
TableDiagram_QuantilesRowHeader
  
−
TableDiagram_StdDevRow = 30
+
TableDiagram_QuantilesRowValue
  
−
TableDiagram_StdDevRowHeader = 31
+
TableDiagram_PercentileRow
  
−
TableDiagram_StdDevRowValue = 32
+
TableDiagram_PercentileRowHeader
  
−
TableDiagram_StdErrorRow = 33
+
TableDiagram_PercentileRowValue
  
−
TableDiagram_StdErrorRowHeader = 34
+
TableDiagram_SignificanceRow
  
−
TableDiagram_StdErrorRowValue = 35
+
TableDiagram_SignificanceRowHeader 
  
−
TableDiagram_MedianRow = 36
+
TableDiagram_SignificanceRowValue
  
−
TableDiagram_MedianRowHeader = 37
+
TableDiagram_CountAnswerRow
  
−
TableDiagram_MedianRowValue = 38
+
TableDiagram_CountAnswerRowHeader
  
−
TableDiagram_QuantilesRow = 39
+
TableDiagram_CountAnswerRowValue
  
−
TableDiagram_QuantilesRowHeader = 40
+
TableDiagram_TotalRespondentRow
  
−
TableDiagram_QuantilesRowValue = 41
+
TableDiagram_TotalRespondentRowHeader
  
−
TableDiagram_PercentileRow = 42
+
TableDiagram_TotalRespondentRowValue
  
−
TableDiagram_PercentileRowHeader = 43
+
TableDiagram_WeightRow
  
−
TableDiagram_PercentileRowValue = 44
+
TableDiagram_WeightRowHeader
  
−
TableDiagram_SignificanceRow = 45
+
TableDiagram_WeightRowValue
  
−
TableDiagram_SignificanceRowHeader = 46
+
'''TableDiagram_QuestionHeader'''
  
−
TableDiagram_SignificanceRowValue = 47
+
'''TableDiagram_SpacerCell'''
  
−
'''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>'''
 +
 
 +
|}
  
−
'''Examples'''
 
  
 +
 +
==Examples==
 
array significancerow = Tabulation_getDiagramStyle(45);
 
array significancerow = Tabulation_getDiagramStyle(45);
  
−
'''Availability'''
+
==Availability==
 +
Version 5.8.1
  
−
Version 5.8.1
+
[[Category:Style_setting_functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8102.htm-->
 

Latest revision as of 09:02, 22 September 2023

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)

or can use TabulationDiagramParameter.GetDiagramStyle(styleType);

Arguments

styleType: enumeration for style type. Below is the full list of style type enumerations:

TableDiagram_AllTable

TableDiagram_ColumnHeader

TableDiagram_ColumnHeaderLevel1

TableDiagram_ColumnHeaderLevel2

TableDiagram_ColumnHeaderLevel3

TableDiagram_ColumnHeaderLevel4

TableDiagram_RowHeader

TableDiagram_RowHeaderLevel1

TableDiagram_RowHeaderLevel2

TableDiagram_RowHeaderLevel3

TableDiagram_AnswerRow

TableDiagram_AnswerRowAlternate

TableDiagram_AbsoluteColumn

TableDiagram_AbsoluteColumnHeader

TableDiagram_AbsoluteColumnValue

TableDiagram_PercentageColumn

TableDiagram_PercentageColumnHeader

TableDiagram_PercentageColumnValue

TableDiagram_TotalColumn

TableDiagram_TotalColumnHeader

TableDiagram_TotalColumnValue

TableDiagram_TotalRow

TableDiagram_TotalRowHeader

TableDiagram_TotalRowValue

TableDiagram_VarianceRow

TableDiagram_VarianceRowHeader

TableDiagram_VarianceRowValue

TableDiagram_AverageRow

TableDiagram_AverageRowHeader

TableDiagram_AverageRowValue

TableDiagram_StdDevRow

TableDiagram_StdDevRowHeader

TableDiagram_StdDevRowValue

TableDiagram_StdErrorRow

TableDiagram_StdErrorRowHeader

TableDiagram_StdErrorRowValue

TableDiagram_MedianRow

TableDiagram_MedianRowHeader

TableDiagram_MedianRowValue

TableDiagram_QuantilesRow

TableDiagram_QuantilesRowHeader

TableDiagram_QuantilesRowValue

TableDiagram_PercentileRow

TableDiagram_PercentileRowHeader

TableDiagram_PercentileRowValue

TableDiagram_SignificanceRow

TableDiagram_SignificanceRowHeader

TableDiagram_SignificanceRowValue

TableDiagram_CountAnswerRow

TableDiagram_CountAnswerRowHeader

TableDiagram_CountAnswerRowValue

TableDiagram_TotalRespondentRow

TableDiagram_TotalRespondentRowHeader

TableDiagram_TotalRespondentRowValue

TableDiagram_WeightRow

TableDiagram_WeightRowHeader

TableDiagram_WeightRowValue

TableDiagram_QuestionHeader

TableDiagram_SpacerCell

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

Retrieved from "http://wiki.catglobe.com/index.php?title=Tabulation_getDiagramStyle&oldid=240902"