Tabulation class - Revision history

Administrator at 05:07, 12 May 2022

2022-05-12T05:07:03Z

← Older revision		Revision as of 05:07, 12 May 2022
Line 67:		Line 67:
	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===
	<source lang="javascript">		<source lang="javascript">
	//CreateCrossDiagram		//* CreateCrossDiagram *//
	number reportStyleSheetId = 11060624;		number reportStyleSheetId = 11060624;
	TabulationDiagramParameter p = new TabulationDiagramParameter();		TabulationDiagramParameter p = new TabulationDiagramParameter();
Line 75:		Line 75:
	t.CreateCrossDiagram({"Q1"}, {"Q2"}, p);		t.CreateCrossDiagram({"Q1"}, {"Q2"}, p);
	</source>		</source>

	<source lang="javascript">		<source lang="javascript">
	//~~SetTableDiagramStyle~~		//* addParagraph addImage and SaveAsReport ShowResultAsPdf *//
	~~TabulationDiagramParameter p = new TabulationDiagramParameter();~~
	~~p.DataCacheId = 17116726;~~
	~~Tabulation t = new Tabulation ();~~
	~~//TabulationFillStyle FillStyle = new TabulationFillStyle();~~
	~~//TabulationDiagramStyle DiagramStyle = new TabulationDiagramStyle();~~
	~~TabulationTextStyle textStyle = new TabulationTextStyle();~~
	~~textStyle.Color = Color_getByRGB("#FF0000");~~
	~~p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel2, TABLE_DIAGRAM_STYLE_FONT, textStyle);~~
	~~textStyle.Color = Color_getByRGB("#FFF000");~~
	~~p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel1, TABLE_DIAGRAM_STYLE_FONT, textStyle);~~
	~~t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);~~
	~~</source>~~
	~~<source lang="javascript">~~
	~~//SetDiagramStyle~~
	~~TabulationDiagramParameter p = new TabulationDiagramParameter();~~
	~~p.DataCacheId = 17116726;~~
	~~Tabulation t = new Tabulation ();~~
	~~TabulationDiagramStyle DiagramStyle = new TabulationDiagramStyle();~~
	~~DiagramStyle.Fill.Color = Color_getByRGB("#FF0000");~~
	~~p.SetDiagramStyle(TableDiagram_ColumnHeaderLevel2, DiagramStyle);~~
	~~DiagramStyle.Fill.Color = Color_getByRGB("#FFF000");~~
	~~p.SetDiagramStyle(TableDiagram_ColumnHeaderLevel1, DiagramStyle);~~
	~~t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);~~
	~~</source>~~
	~~<source lang="javascript">~~
	//addParagraph addImage and SaveAsReport ShowResultAsPdf
	TabulationDiagramParameter p = new TabulationDiagramParameter();		TabulationDiagramParameter p = new TabulationDiagramParameter();
	p.DataCacheId = 17116726;		p.DataCacheId = 17116726;
Line 109:		Line 85:
	textStyle.Color = new Color("red", false);		textStyle.Color = new Color("red", false);
	TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();		TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
			t.AddToHeader(new TabulationImage(new Attachment(17148336), paragraphStyle));
	paragraphStyle.Alignment = "center"; //left, right, center.		paragraphStyle.Alignment = "center"; //left, right, center.
	~~t.AddToHeader(new TabulationParagraph(paragraphStyle,"Header", textStyle));~~
	~~t.AddToBody(new TabulationImage(new Attachment(17148336), paragraphStyle));~~
	t.AddToFooter(new TabulationParagraph(paragraphStyle,"Page $p of $P", textStyle));		t.AddToFooter(new TabulationParagraph(paragraphStyle,"Page $p of $P", textStyle));
			t.AddToBody(new TabulationParagraph(paragraphStyle,"Some Text 1", textStyle));
	t.CreateCrossDiagram({"Rit_3"}, {"VilStemme"}, p);		t.CreateCrossDiagram({"Rit_3"}, {"VilStemme"}, p);
			t.AddToBody(new TabulationParagraph(paragraphStyle,"Some Text 2", textStyle));
	number parentId = 17148135;		number parentId = 17148135;
	number groupPermissionId = 17146562;		number groupPermissionId = 17146562;

Administrator at 10:25, 11 May 2022

2022-05-11T10:25:38Z

@@ Line 100: / Line 100: @@
 p.SetDiagramStyle(TableDiagram_ColumnHeaderLevel1, DiagramStyle);
 t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);
 </source>

Administrator at 10:10, 11 May 2022

2022-05-11T10:10:48Z

← Older revision		Revision as of 10:10, 11 May 2022
Line 67:		Line 67:
	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===
	<source lang="javascript">		<source lang="javascript">
			//CreateCrossDiagram
	number reportStyleSheetId = 11060624;		number reportStyleSheetId = 11060624;
	TabulationDiagramParameter p = new TabulationDiagramParameter();		TabulationDiagramParameter p = new TabulationDiagramParameter();
Line 75:		Line 76:
	</source>		</source>
	<source lang="javascript">		<source lang="javascript">
			//SetTableDiagramStyle
	TabulationDiagramParameter p = new TabulationDiagramParameter();		TabulationDiagramParameter p = new TabulationDiagramParameter();
	p.DataCacheId = 17116726;		p.DataCacheId = 17116726;
Line 85:		Line 87:
	textStyle.Color = Color_getByRGB("#FFF000");		textStyle.Color = Color_getByRGB("#FFF000");
	p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel1, TABLE_DIAGRAM_STYLE_FONT, textStyle);		p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel1, TABLE_DIAGRAM_STYLE_FONT, textStyle);
			t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);
			</source>
			<source lang="javascript">
			//SetDiagramStyle
			TabulationDiagramParameter p = new TabulationDiagramParameter();
			p.DataCacheId = 17116726;
			Tabulation t = new Tabulation ();
			TabulationDiagramStyle DiagramStyle = new TabulationDiagramStyle();
			DiagramStyle.Fill.Color = Color_getByRGB("#FF0000");
			p.SetDiagramStyle(TableDiagram_ColumnHeaderLevel2, DiagramStyle);
			DiagramStyle.Fill.Color = Color_getByRGB("#FFF000");
			p.SetDiagramStyle(TableDiagram_ColumnHeaderLevel1, DiagramStyle);
	t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);		t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);
	</source>		</source>

Administrator at 10:08, 11 May 2022

2022-05-11T10:08:07Z

← Older revision		Revision as of 10:08, 11 May 2022
Line 65:		Line 65:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>VerticalSortDataColumn</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Define which column should be sort. Use combine with VerticalSort. It's the column you want to sort (start with 0)</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>VerticalSortDataColumn</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Define which column should be sort. Use combine with VerticalSort. It's the column you want to sort (start with 0)</nowiki>}}
	}}		}}
			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			number reportStyleSheetId = 11060624;
			TabulationDiagramParameter p = new TabulationDiagramParameter();
			p.DataCacheId = 16749647;
			Tabulation t = new Tabulation();
			t.StyleSheet = new ReportStyleSheet(reportStyleSheetId);
			t.CreateCrossDiagram({"Q1"}, {"Q2"}, p);
			</source>
			<source lang="javascript">
			TabulationDiagramParameter p = new TabulationDiagramParameter();
			p.DataCacheId = 17116726;
			Tabulation t = new Tabulation ();
			//TabulationFillStyle FillStyle = new TabulationFillStyle();
			//TabulationDiagramStyle DiagramStyle = new TabulationDiagramStyle();
			TabulationTextStyle textStyle = new TabulationTextStyle();
			textStyle.Color = Color_getByRGB("#FF0000");
			p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel2, TABLE_DIAGRAM_STYLE_FONT, textStyle);
			textStyle.Color = Color_getByRGB("#FFF000");
			p.SetTableDiagramStyle(TableDiagram_ColumnHeaderLevel1, TABLE_DIAGRAM_STYLE_FONT, textStyle);
			t.CreateCrossDiagram({"Rit_3"},{"VilStemme"},p);
			</source>

Administrator: Created page with "{{CGscriptClass_Template |Name=Tabulation |Description=Represents a tabulation. |InheritsFrom=object|Constructors= {{CGscriptConstructors_Tem..."

2022-05-05T02:54:35Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>Tabulation</nowiki> |Description=<nowiki>Represents a tabulation.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptConstructors_Tem..."

New page

{{CGscriptClass_Template
|Name=<nowiki>Tabulation</nowiki>
|Description=<nowiki>Represents a tabulation.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Create new tabulation instance</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddPagebreak</nowiki>|Description=<nowiki>Insert a page break</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddToBody</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>TabulationImage/TabulationParagraph element</nowiki>}}
|Description=<nowiki>Adds an element to the body </nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddToFooter</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>TabulationImage/TabulationParagraph element</nowiki>}}
|Description=<nowiki>Adds an element to the footer</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddToHeader</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>TabulationImage/TabulationParagraph element</nowiki>}}
|Description=<nowiki>Adds an element to the header </nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>CreateCrossDiagram</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>rowAxisNames</nowiki>|Description=<nowiki>rowAxisNames</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>columnAxisNames</nowiki>|Description=<nowiki>columnAxisNames</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationDiagramParameter|Name=<nowiki>DiagramParameter</nowiki>|Description=<nowiki>DiagramParameter</nowiki>}}
|Description=<nowiki>Creates a cross diagram from the axis names specified as string arrays for rows and columns. A unique id is returned when a diagram is added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>CreateFixedCrossDiagram</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=FixedCrossTable|Name=<nowiki>FixedCrossTable</nowiki>|Description=<nowiki>An FixedCrossTable expression</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationDiagramParameter|Name=<nowiki>DiagramParameter</nowiki>|Description=<nowiki>DiagramParameter</nowiki>}}
|Description=<nowiki>Creates a custom cross diagram</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>CreateFrequenceDiagram</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>axisName</nowiki>|Description=<nowiki>axisName</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationDiagramParameter|Name=<nowiki>DiagramParameter</nowiki>|Description=<nowiki>DiagramParameter</nowiki>}}
|Description=<nowiki>Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>CreateStackCrossDiagram</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>rowAxisNames</nowiki>|Description=<nowiki>rowAxisNames</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>columnAxisNames</nowiki>|Description=<nowiki>columnAxisNames</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=TabulationDiagramParameter|Name=<nowiki>DiagramParameter</nowiki>|Description=<nowiki>DiagramParameter</nowiki>}}
|Description=<nowiki>Creates a stack cross diagram from the axis names specified as string arrays for rows and columns. A unique id is returned when a diagram is added.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ExportToExcel</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>name of excel report</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemporaryFile</nowiki>|Description=<nowiki>isTemporaryFile</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>worksheetDistribution</nowiki>|Description=<nowiki>This is optional parameter. If not set will use default with option 1 (each table show on separate sheet). Tabulation_SheetDistribution_xxx constant</nowiki>}}
|Description=<nowiki>Export tabulation to Excel </nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>RenderHtml</nowiki>|Description=<nowiki>This function will return array html of all chart created on current tabulation script </nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Reset</nowiki>|Description=<nowiki>Reset tabulation</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>SaveAsReport</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>name of pdf report</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>parentId</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Dictionary|Name=<nowiki>permissionGroups</nowiki>|Description=<nowiki>Grant groups have permission to a resource.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>overwrite</nowiki>|Description=<nowiki> If set to true the existing report and report template will be overwritten. The argument is optional and if not specified overwrite must default to false causing a runtime exception if the report and report template already exists.</nowiki>}}
|Description=<nowiki>This function tells the interpreter to save the tabulation results as a report once the script is executed, and returns the report's resource unique id. </nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetPdfMargin</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>marginType</nowiki>|Description=<nowiki>Diagram_PdfHeader_Margin_xxx constant</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>margin</nowiki>|Description=<nowiki>The value the margin should have. Valid value: 0-100</nowiki>}}
|Description=<nowiki>Sets a given margin in the Pdf report</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetPDFPrintingDirection</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>direction</nowiki>|Description=<nowiki>Diagram_PdfLayoutDirection_xxx constant</nowiki>}}
|Description=<nowiki>Set PDF printing direction</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>EnableOddEvenRowHeader</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>This setting makes it possible to either activate or deactivate the chart's inheritance of the odd even rows styles from the style sheet</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>ExcludedSortOrderHorizontal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Exclude some axis options from the the horizontal sorting. Axis array which contains some axis options that will be excluded from the the horizontal sorting.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>ExcludedSortOrderVertical</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Exclude some axis options from the the vertical sorting. Axis array which contains some axis options that will be excluded from the the vertical sorting.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>HorizontalSort</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Sort the tabulation table in horizontal . The constants for this parameter Tabulation_SortOrder_xxx</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>HorizontalSortDataColumn</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Define which column should be sort. Use combine with HorizontalSort. It's the column you want to sort (start with 0)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>MergeStatisticPctItem</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>When tables are being shown with both absolute and percentage columns, the statistical rows will, for an item, show the same result in both the absolute and statistical columns. When enabling this setting, the cells for these columns will be merged together, so that the result will just be shown on one shared cell for both columns. </nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowErrorInResult</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide error on result.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowExpression</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide a expression column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowFilterDescription</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide filter in table</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowResultAsPdf</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide export PDF dialog.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowResultViewer</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Enables or disables whether the diagrams created will be shown in the Result viewer-dialog when the script has been executed successfully.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowSignificanceDescription</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>show/hide significance row in table</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowTotalColumn</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide the total column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowWeightDescription</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Show/hide weight row in table</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>StartingPageNumber</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the starting page number for the PDF report.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=ReportStyleSheet|Name=<nowiki>StyleSheet</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the report style sheet which is be used when displaying/creating diagrams</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TableChartLayoutType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Use constant TableChartLayout_xxx to sets the general style of a table chart with some prefixed layout styles overriding any style sheet settings.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>VerticalSort</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Sort the tabulation table in vertical. The constants for this parameter Tabulation_SortOrder_xxx</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>VerticalSortDataColumn</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Define which column should be sort. Use combine with VerticalSort. It's the column you want to sort (start with 0)</nowiki>}}
}}