Difference between revisions of "Tabulation setDiagramStyle"

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

 
  
−
=====Tabulation_setDiagramStyle=====
+
Sets the style for part of a chart.
  
−
Sets the style for part of a chart.
+
==Syntax==
  
−
'''Syntax'''
+
Tabulation_setDiagramStyle(''styleType, diagramStyle'')
  
−
Tabulation_setDiagramStyle(''styleType, diagramStyle'')
+
or can use [[TabulationDiagramParameter_class|TabulationDiagramParameter.SetDiagramStyle(styleType, TabulationDiagramStyle);]]
  
−
'''Arguments'''
+
==Arguments==
  
−
''styleType'': enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations:
+
*''styleType'': enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations:  
  
−
TableDiagram_AllTable = 0
+
TableDiagram_AllTable
  
−
TableDiagram_ColumnHeader = 1
+
TableDiagram_ColumnHeader
  
−
TableDiagram_ColumnHeaderLevel1 = 2
+
TableDiagram_ColumnHeaderLevel1
  
−
TableDiagram_ColumnHeaderLevel2 = 3
+
TableDiagram_ColumnHeaderLevel2
  
−
TableDiagram_ColumnHeaderLevel3 = 4
+
TableDiagram_ColumnHeaderLevel3  
  
−
TableDiagram_ColumnHeaderLevel4 = 5
+
TableDiagram_ColumnHeaderLevel4  
  
−
TableDiagram_RowHeader = 6
+
TableDiagram_RowHeader  
  
−
TableDiagram_RowHeaderLevel1 = 7
+
TableDiagram_RowHeaderLevel1  
  
−
TableDiagram_RowHeaderLevel2 = 8
+
TableDiagram_RowHeaderLevel2  
  
−
TableDiagram_RowHeaderLevel3 = 9
+
TableDiagram_RowHeaderLevel3  
  
−
TableDiagram_AnswerRow = 10
+
TableDiagram_AnswerRow
  
−
TableDiagram_AnswerRowAlternate = 11
+
TableDiagram_AnswerRowAlternate  
  
−
TableDiagram_AbsoluteColumn = 12
+
TableDiagram_AbsoluteColumn  
  
−
TableDiagram_AbsoluteColumnHeader = 13
+
TableDiagram_AbsoluteColumnHeader  
  
−
TableDiagram_AbsoluteColumnValue = 14
+
TableDiagram_AbsoluteColumnValue  
  
−
TableDiagram_PercentageColumn = 15
+
TableDiagram_PercentageColumn  
  
−
TableDiagram_PercentageColumnHeader = 16
+
TableDiagram_PercentageColumnHeader  
  
−
TableDiagram_PercentageColumnValue = 17
+
TableDiagram_PercentageColumnValue  
  
−
TableDiagram_TotalColumn = 18
+
TableDiagram_TotalColumn
  
−
TableDiagram_TotalColumnHeader = 19
+
TableDiagram_TotalColumnHeader  
  
−
TableDiagram_TotalColumnValue = 20
+
TableDiagram_TotalColumnValue  
  
−
TableDiagram_TotalRow = 21
+
TableDiagram_TotalRow  
  
−
TableDiagram_TotalRowHeader = 22
+
TableDiagram_TotalRowHeader  
  
−
TableDiagram_TotalRowValue = 23
+
TableDiagram_TotalRowValue  
  
−
TableDiagram_VarianceRow = 24
+
TableDiagram_VarianceRow  
  
−
TableDiagram_VarianceRowHeader = 25
+
TableDiagram_VarianceRowHeader  
  
−
TableDiagram_VarianceRowValue = 26
+
TableDiagram_VarianceRowValue  
  
−
TableDiagram_AverageRow = 27
+
TableDiagram_AverageRow  
  
−
TableDiagram_AverageRowHeader = 28
+
TableDiagram_AverageRowHeader  
  
−
TableDiagram_AverageRowValue = 29
+
TableDiagram_AverageRowValue  
  
−
TableDiagram_StdDevRow = 30
+
TableDiagram_StdDevRow  
  
−
TableDiagram_StdDevRowHeader = 31
+
TableDiagram_StdDevRowHeader  
  
−
TableDiagram_StdDevRowValue = 32
+
TableDiagram_StdDevRowValue  
  
−
TableDiagram_StdErrorRow = 33
+
TableDiagram_StdErrorRow  
  
−
TableDiagram_StdErrorRowHeader = 34
+
TableDiagram_StdErrorRowHeader  
  
−
TableDiagram_StdErrorRowValue = 35
+
TableDiagram_StdErrorRowValue
  
−
TableDiagram_MedianRow = 36
+
TableDiagram_MedianRow
  
−
TableDiagram_MedianRowHeader = 37
+
TableDiagram_MedianRowHeader  
  
−
TableDiagram_MedianRowValue = 38
+
TableDiagram_MedianRowValue  
  
−
TableDiagram_QuantilesRow = 39
+
TableDiagram_QuantilesRow  
  
−
TableDiagram_QuantilesRowHeader = 40
+
TableDiagram_QuantilesRowHeader  
  
−
TableDiagram_QuantilesRowValue = 41
+
TableDiagram_QuantilesRowValue  
  
−
TableDiagram_PercentileRow = 42
+
TableDiagram_PercentileRow
  
−
TableDiagram_PercentileRowHeader = 43
+
TableDiagram_PercentileRowHeader  
  
−
TableDiagram_PercentileRowValue = 44
+
TableDiagram_PercentileRowValue  
  
−
TableDiagram_SignificanceRow = 45
+
TableDiagram_SignificanceRow  
  
−
TableDiagram_SignificanceRowHeader = 46
+
TableDiagram_SignificanceRowHeader
  
−
TableDiagram_SignificanceRowValue = 47
+
TableDiagram_SignificanceRowValue  
  
−
TableDiagram_CountAnswerRow = 48
+
TableDiagram_CountAnswerRow  
  
−
TableDiagram_CountAnswerRowHeader = 49
+
TableDiagram_CountAnswerRowHeader  
  
−
TableDiagram_CountAnswerRowValue = 50
+
TableDiagram_CountAnswerRowValue  
  
−
TableDiagram_TotalRespondentRow = 51
+
TableDiagram_TotalRespondentRow  
  
−
TableDiagram_TotalRespondentRowHeader = 52
+
TableDiagram_TotalRespondentRowHeader  
  
−
TableDiagram_TotalRespondentRowValue = 53
+
TableDiagram_TotalRespondentRowValue  
  
−
''diagramStyle'': diagram style object want to apply. It is an array with the following constants.
+
TableDiagram_WeightRow
  
−
{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2"
+
TableDiagram_WeightRowHeader
 +
 
 +
TableDiagram_WeightRowValue
 +
 
 +
'''TableDiagram_QuestionHeader'''
 +
 
 +
'''TableDiagram_SpacerCell'''
 +
 
 +
*''diagramStyle'': diagram style object want to apply. It is an array with the following constants.
 +
 
 +
{| cellpadding="2" border="1" width="907" class="tableintopic" style="border-collapse: collapse; border: 1px solid rgb(1, 1, 1);"
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
Constant
+
Constant  
−
| style="border: 1px solid #010101" width="73" bgcolor="#F59D56" |
+
 
−
Type
+
| bgcolor="#f59d56" width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" bgcolor="#F59D56" |
+
Type  
−
Initial/Default value
+
 
−
| style="border: 1px solid #010101" width="433" bgcolor="#F59D56" |
+
| bgcolor="#f59d56" width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Description
+
Initial/Default value  
 +
 
 +
| bgcolor="#f59d56" width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Description  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
OBJECT_TYPE
+
OBJECT_TYPE  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Number
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Number  
−
21
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Enumeration defining the object type.
+
21  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Enumeration defining the object type.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_FILL
+
TABLE_DIAGRAM_STYLE_FILL  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Array
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Array  
−
As set in the object
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Fill style. Background color.
+
As set in the object  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Fill style. Background color.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_DECIMAL
+
TABLE_DIAGRAM_STYLE_DECIMAL  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Number
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Number  
−
As set in the object
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Decimal place.
+
As set in the object  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Decimal place.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_FONT
+
TABLE_DIAGRAM_STYLE_FONT  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
Array
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
Array  
−
As set in the object
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Font.
+
As set in the object  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Font.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_VALIGN
+
TABLE_DIAGRAM_STYLE_VALIGN  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
String
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
String  
−
As set in the object
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Vertical alignment (allows values "top", "center", or "bottom").
+
As set in the object  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Vertical alignment (allows values "top", "center", or "bottom").  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="227" |
+
| width="227" style="border: 1px solid rgb(1, 1, 1);" |  
−
TABLE_DIAGRAM_STYLE_HALIGN
+
TABLE_DIAGRAM_STYLE_HALIGN  
−
| style="border: 1px solid #010101" width="73" |
+
 
−
String
+
| width="73" style="border: 1px solid rgb(1, 1, 1);" |  
−
| style="border: 1px solid #010101" width="174" |
+
String  
−
As set in the object
+
 
−
| style="border: 1px solid #010101" width="433" |
+
| width="174" style="border: 1px solid rgb(1, 1, 1);" |  
−
Horizontal alignment (allows values "left", "center", or "right").
+
As set in the object  
 +
 
 +
| width="433" style="border: 1px solid rgb(1, 1, 1);" |  
 +
Horizontal alignment (allows values "left", "center", or "right").  
 +
 
 +
|}
 +
 
 +
==Return type==
 +
 
 +
Empty
 +
 
 +
==Examples==
 +
 
 +
''Tabulation_setTableLayout(TableChartLayout_Ifka);''
 +
 
 +
''Tabulation_setAbsText("abs");''
 +
 
 +
''Tabulation_setPctText("%");''
 +
 
 +
''Tabulation_setCountAnswer(true);''
 +
 
 +
''Tabulation_setTotalAnswerText("Total sample size");''
 +
 
 +
''Tabulation_setEnableOddEvenRowHeader(true);''
 +
 
 +
''Tabulation_setMergeStatisticPctItem(true);''
 +
 
 +
'''''//set values for Abs column'''''
 +
 
 +
''array font = {18,"Times New Roman",9,{17,0,0,0},false,false,false,true};''
 +
 
 +
''array fill_AbsCol = {19,{17,0,0,0},2,true};''
 +
 
 +
''string valign = "center";''
 +
 
 +
''string halign_AbsCol = "right";''
 +
 
 +
''number decimal = 0;''
 +
 
 +
''array diagramStyle_AbsCol={21,fill_AbsCol,decimal,font,valign,halign_AbsCol};''
 +
 
 +
''Tabulation_setDiagramStyle(TableDiagram_AbsoluteColumn,diagramStyle_AbsCol);''
 +
 
 +
'''''//set values for Count Answer Row'''''
 +
 
 +
''array font_CountAnswer = {18,"Times New Roman",9,{17,0,0,0},true,false,false,false};''
 +
 
 +
''string halign_CountAnswer = "left";''
 +
 
 +
''array diagramStyle_CountAnswer ={21,fill_AbsCol,decimal,font_CountAnswer,valign,halign_CountAnswer};''
 +
 
 +
''Tabulation_setDiagramStyle(TableDiagram_CountAnswerRow,diagramStyle_CountAnswer);''
 +
 
 +
'''''//set values for Headers column'''''
 +
 
 +
''array font_Header = DiagramFontStyle_getDefault(); ''
 +
 
 +
''font_Header[DIAGRAM_FONT_STYLE_COLOR] = Color_getByRGB("#000000");''
  
−
'''Return type'''
+
''font_Header[DIAGRAM_FONT_STYLE_FACE] = "Times New Roman"; ''  
  
−
Empty
+
''font_Header[DIAGRAM_FONT_STYLE_SIZE] = 9 ; ''
  
−
'''Examples'''
+
''array fill_style = DiagramFillStyle_getDefault(); ''  
  
−
string center = "center";
+
''array style_header = Tabulation_getDefaultDiagramStyle(Diagram_Type_Table); ''
  
−
string right = "right";
+
''style_header[TABLE_DIAGRAM_STYLE_FILL] = fill_style; ''
  
−
string left = "left";
+
''style_header[TABLE_DIAGRAM_STYLE_FONT] = font_Header; ''
  
−
number decimal1 = 1;
+
''style_header[TABLE_DIAGRAM_STYLE_VALIGN] = "center";''
  
−
number decimal0 = 0;
+
''style_header[TABLE_DIAGRAM_STYLE_HALIGN] = "center";''
  
−
array fill = {19,{17,0,0,0},2,true};
+
''Tabulation_setDiagramStyle(TableDiagram_ColumnHeaderLevel2, style_header);''
  
−
number styleType31 = 31;
+
''Tabulation_setDiagramStyle(TableDiagram_AbsoluteColumnHeader, style_header);''
  
−
array font31 = {18,"Times New Roman",13,{17,0,0,0},false,true,false,false};
+
''Tabulation_setDiagramStyle(TableDiagram_PercentageColumnHeader, style_header);''
  
−
array diagramStyle31={21,fill,decimal0,font31,center,left};
+
''createFrequenceDiagram("Civil_status");''
 +
[[Image:SetDiagramStyle.jpg]]
  
−
Tabulation_setDiagramStyle(styleType31,diagramStyle31);
+
==Availability==
  
−
'''Availability'''
+
Version 5.8.1 __NOTOC__
  
−
Version 5.8.1
+
[[Category:Style_setting_functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8101.htm-->
 

Latest revision as of 08:09, 22 September 2023

Tabulation_setDiagramStyle

Sets the style for part of a chart.

Syntax

Tabulation_setDiagramStyle(styleType, diagramStyle)

or can use TabulationDiagramParameter.SetDiagramStyle(styleType, TabulationDiagramStyle);

Arguments

  • styleType: enumeration for the part of a chart you want to set. Below is the full list of chart 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

  • diagramStyle: diagram style object want to apply. It is an array with the following constants.

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").

Return type

Empty

Examples

Tabulation_setTableLayout(TableChartLayout_Ifka);

Tabulation_setAbsText("abs");

Tabulation_setPctText("%");

Tabulation_setCountAnswer(true);

Tabulation_setTotalAnswerText("Total sample size");

Tabulation_setEnableOddEvenRowHeader(true);

Tabulation_setMergeStatisticPctItem(true);

//set values for Abs column

array font = {18,"Times New Roman",9,{17,0,0,0},false,false,false,true};

array fill_AbsCol = {19,{17,0,0,0},2,true};

string valign = "center";

string halign_AbsCol = "right";

number decimal = 0;

array diagramStyle_AbsCol={21,fill_AbsCol,decimal,font,valign,halign_AbsCol};

Tabulation_setDiagramStyle(TableDiagram_AbsoluteColumn,diagramStyle_AbsCol);

//set values for Count Answer Row

array font_CountAnswer = {18,"Times New Roman",9,{17,0,0,0},true,false,false,false};

string halign_CountAnswer = "left";

array diagramStyle_CountAnswer ={21,fill_AbsCol,decimal,font_CountAnswer,valign,halign_CountAnswer};

Tabulation_setDiagramStyle(TableDiagram_CountAnswerRow,diagramStyle_CountAnswer);

//set values for Headers column

array font_Header = DiagramFontStyle_getDefault();

font_Header[DIAGRAM_FONT_STYLE_COLOR] = Color_getByRGB("#000000");

font_Header[DIAGRAM_FONT_STYLE_FACE] = "Times New Roman";

font_Header[DIAGRAM_FONT_STYLE_SIZE] = 9 ;

array fill_style = DiagramFillStyle_getDefault();

array style_header = Tabulation_getDefaultDiagramStyle(Diagram_Type_Table);

style_header[TABLE_DIAGRAM_STYLE_FILL] = fill_style;

style_header[TABLE_DIAGRAM_STYLE_FONT] = font_Header;

style_header[TABLE_DIAGRAM_STYLE_VALIGN] = "center";

style_header[TABLE_DIAGRAM_STYLE_HALIGN] = "center";

Tabulation_setDiagramStyle(TableDiagram_ColumnHeaderLevel2, style_header);

Tabulation_setDiagramStyle(TableDiagram_AbsoluteColumnHeader, style_header);

Tabulation_setDiagramStyle(TableDiagram_PercentageColumnHeader, style_header);

createFrequenceDiagram("Civil_status"); SetDiagramStyle.jpg

Availability

Version 5.8.1

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