Administrator at 04:51, 12 May 2022

2022-05-12T04:51:57Z

← Older revision		Revision as of 04:51, 12 May 2022
Line 87:		Line 87:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Weight</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Weight</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Weight</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Weight</nowiki>}}
	}}		}}
			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			TabulationDiagramParameter p = new TabulationDiagramParameter();
			p.DataCacheId = 17116726;
			p.ShowMode = Diagram_ShowModeType_Absolute;
			p.Weight = "W1";
			p.Filters = {"Region == [1-4]"};
			p.Average = true;
			Tabulation t = new Tabulation ();
			t.StyleSheet = new ReportStyleSheet(11060624);
			t.CreateCrossDiagram({"Rit_3"}, {"VilStemme"}, p);
			</source>

Administrator: Created page with "{{CGscriptClass_Template |Name=TabulationDiagramParameter |Description=Represents a diagram configuration. |InheritsFrom=object|Constructors=..."

2022-05-05T02:58:55Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>TabulationDiagramParameter</nowiki> |Description=<nowiki>Represents a diagram configuration.</nowiki> |InheritsFrom=object|Constructors=..."

New page

{{CGscriptClass_Template
|Name=<nowiki>TabulationDiagramParameter</nowiki>
|Description=<nowiki>Represents a diagram configuration.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create new DiagramParameter instance</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=TabulationDiagramParameter|Name=<nowiki>diagramParameter</nowiki>|Description=<nowiki>diagramParameter</nowiki>}}
|Description=<nowiki>Create new DiagramParameter instance</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddPercentile</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>percent</nowiki>|Description=<nowiki>The percentage used in the calculation</nowiki>}}
|Description=<nowiki>Adds a percentile calculation row to a diagram of chart type Diagram_ChartType_Table</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddQuantile</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>q</nowiki>|Description=<nowiki>an integer between 2 and the maximum value allowed for a 32 bit signed integer.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>k</nowiki>|Description=<nowiki>an integer greater than 0 and smaller than q specified above.</nowiki>}}
|Description=<nowiki>Adds a quantile calculation row to a diagram of chart type Diagram_ChartType_Table. </nowiki>}}
{{CGscriptMethods_Template|ReturnType=TabulationDiagramStyle|Name=<nowiki>GetDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for style type. Below is the full list of style type enumeration: TableDiagram_xxx constant</nowiki>}}
|Description=<nowiki>Gets a session chart style object for a specif style type set in session.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAllPercentiles</nowiki>|Description=<nowiki>Removes all added percentile calculation rows from a diagram of chart type Diagram_ChartType_Table.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAllQuantiles</nowiki>|Description=<nowiki>Removes all added quantile calculation rows from a diagram of chart type Diagram_ChartType_Table.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemovePercentile</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>percent</nowiki>|Description=<nowiki>The percentage used in the calculation</nowiki>}}
|Description=<nowiki>Removes a percentile calculation row earlier added to a diagram of chart type Diagram_ChartType_Table.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveQuantile</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>q</nowiki>|Description=<nowiki>an integer between 2 and the maximum value allowed for a 32 bit signed integer.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>k</nowiki>|Description=<nowiki>an integer greater than 0 and smaller than q specified above.</nowiki>}}
|Description=<nowiki>Removes a quantile calculation row earlier added to a diagram of chart type Diagram_ChartType_Table.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationDiagramStyle|Name=<nowiki>diagramStyle</nowiki>|Description=<nowiki>DiagramStyle object want to apply.</nowiki>}}
|Description=<nowiki>Sets the style for part of a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTableDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>tableDiagramStyle</nowiki>|Description=<nowiki> It's the value of the Table Diagram style constants. TABLE_DIAGRAM_STYLE_xxx.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationFillStyle|Name=<nowiki>styleBase</nowiki>|Description=<nowiki>TabulationFillStyleCGO. Use for TABLE_DIAGRAM_STYLE_FILL</nowiki>}}
|Description=<nowiki>Sets the style for a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTableDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>tableDiagramStyle</nowiki>|Description=<nowiki> It's the value of the Table Diagram style constants. TABLE_DIAGRAM_STYLE_xxx.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationTextStyle|Name=<nowiki>styleBase</nowiki>|Description=<nowiki>TabulationTextStyleCGO. Use for TABLE_DIAGRAM_STYLE_FONT</nowiki>}}
|Description=<nowiki>Sets the style for a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTableDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>tableDiagramStyle</nowiki>|Description=<nowiki> It's the value of the Table Diagram style constants. TABLE_DIAGRAM_STYLE_xxx.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>styleBase</nowiki>|Description=<nowiki>String. Use for TABLE_DIAGRAM_STYLE_VALIGN, TABLE_DIAGRAM_STYLE_HALIGN, TABLE_DIAGRAM_STYLE_NUMBER_FORMATTER, TABLE_DIAGRAM_STYLE_PERCENT_FORMATTER, TABLE_DIAGRAM_STYLE_SIGNIFICANCE_FORMATTER</nowiki>}}
|Description=<nowiki>Sets the style for a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTableDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>tableDiagramStyle</nowiki>|Description=<nowiki> It's the value of the Table Diagram style constants. TABLE_DIAGRAM_STYLE_xxx.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>styleBase</nowiki>|Description=<nowiki>Number. Use for TABLE_DIAGRAM_STYLE_DECIMAL</nowiki>}}
|Description=<nowiki>Sets the style for a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTableDiagramStyle</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>styleType</nowiki>|Description=<nowiki>enumeration for the part of a chart you want to set. Below is the full list of chart style type enumerations: TableDiagram_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>tableDiagramStyle</nowiki>|Description=<nowiki> It's the value of the Table Diagram style constants. TABLE_DIAGRAM_STYLE_xxx.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationBorder|Name=<nowiki>styleBase</nowiki>|Description=<nowiki>TabulationBorder. Use for TABLE_DIAGRAM_STYLE_BORDER_STYLE</nowiki>}}
|Description=<nowiki>Sets the style for a chart</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AbsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set text to Abs (Default text in English is "(abs)")</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Average</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Gets double values for row values of the column and calculates the average value of those values.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AverageText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set text to Average (Default text in English is "Average")</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ChartType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the chart types are also determines what configuration settings it makes sense to set, some even give exceptions based on the current chart type, using Diagram_ChartType_xxx constant.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CountAnswerIncluded</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enables or disables the count total answers row in table diagrams. This row is a statistical row shown at the bottom of the table. The value of the row tells us how many answers were given to the question. This may be the same as the total number of respondents, but given that the question type is multi, it may also be that it was more than this, since each respondent then can give more than one answer to one question.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CustomCalculationScriptResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>CustomCalculationScriptResourceId</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DataCacheId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>DataCache Id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Direction</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the direction determines how the totals are calculated either vertical or horizontal, using Diagram_DirectionType_xxx constant.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FilterHeaderText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set text to Filter header.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FilterInfoText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set text to Filter infomartion.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Filters</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Filters</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeTotal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enables or disables the total row which can be shown for table diagrams.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Median</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Calculate the value of the middle observation. In case of an even number of observations the median is the average of the two values on each side of the middle point. Note that the median is NOT calculated based on the categories, but using all data in the dcs.All empty values are ignored.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MedianText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set median text(Default text is Median).</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PctText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set value to DiagramParameter's PctText (Default text in English is "(pct)")</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PercentileText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Percentile text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QuantileText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Quantile text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>RealTotalRespondentText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>RealTotalRespondentText</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>RemoveEmptyColumns</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Remove empty column in table diagram.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>RemoveEmptyRows</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Remove empty rows in table diagram</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ShowMode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The constants determine how the results are presented; as absolute numbers or as percentages or as both. Using Diagram_ShowModeType_xxx constant</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowRealTotalRespondent</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>ShowRealTotalRespondent</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowTotalAsSum</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Returns the total percentage values (should be sum of pct values OR always is 100%), which can be shown for table diagrams. The values tells us percentage of answers were given to the question. This may be the same as the total percentage values, but given that the question type is MULTI, it may also be that it was more than this, since each respondent then can give more than one answer to one question.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowTotalRowAsAbsolute</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enable/Disable showing the total Row in absolute numbers, even though it is a pct column </nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Significance</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enables or disables the significance row which can be shown for table diagrams.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SignificanceDifferenceText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Significance difference text. Default text is "[+] and [-] = Significant difference of 95% or more".</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>SignificanceLevel</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Set SignificanceLevel. Default when not set is 1.96.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SignificanceText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Significance text. Default text is Significance.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SortDataType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set which data should be sorted, using Diagram_SortDataType_xxx constant.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>StDev</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Estimates standard deviation based on a sample.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StDevText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set text to StdDev column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>StError</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enables or disables the standard error row which can be shown for table diagrams.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StErrorText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set StdError text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TotalAnswerText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Set the text for the total answers row, which is one of the statistical rows that can be shown for tables. If this function is not used then the label for the row will just be the default value Total answers.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TotalText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the text for the total row, which is one of the statistical rows that can be shown for tables. If this function is not used then the label for the row will just be the default value "Total".</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>UseAxisName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Sets diagrams to use axis name instead of axis text as labels for the diagram series names (basically identifying what a question concerns). If not set the default value is False, meaning that axis texts will be used.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Variance</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Estimates variance based on a data cache column’s values.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>VarianceText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Variance text.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Weight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Weight</nowiki>}}
}}

TabulationDiagramParameter class - Revision history

Administrator at 04:51, 12 May 2022

Administrator: Created page with "{{CGscriptClass_Template |Name=TabulationDiagramParameter |Description=Represents a diagram configuration. |InheritsFrom=object|Constructors=..."