Tabulation class

From Catglobe Wiki
Jump to: navigation, search

Tabulation



Represents a tabulation.

Parent class

Inherits from object

Constructors

  • () - Create new tabulation instance

Methods

  • Empty AddPagebreak() - Insert a page break
  • Empty AddToBody(object element "TabulationImage/TabulationParagraph element") - Adds an element to the body
  • Empty AddToFooter(object element "TabulationImage/TabulationParagraph element") - Adds an element to the footer
  • Empty AddToHeader(object element "TabulationImage/TabulationParagraph element") - Adds an element to the header
  • number CreateCrossDiagram(array rowAxisNames "rowAxisNames", array columnAxisNames "columnAxisNames", TabulationDiagramParameter DiagramParameter "DiagramParameter") - 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.
  • number CreateFixedCrossDiagram(FixedCrossTable FixedCrossTable "An FixedCrossTable expression", TabulationDiagramParameter DiagramParameter "DiagramParameter") - Creates a custom cross diagram
  • number CreateFrequenceDiagram(string axisName "axisName", TabulationDiagramParameter DiagramParameter "DiagramParameter") - Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
  • number CreateStackCrossDiagram(array rowAxisNames "rowAxisNames", array columnAxisNames "columnAxisNames", TabulationDiagramParameter DiagramParameter "DiagramParameter") - 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.
  • Empty ExportToExcel(string name "name of excel report", bool isTemporaryFile "isTemporaryFile", int worksheetDistribution "This is optional parameter. If not set will use default with option 1 (each table show on separate sheet). Tabulation_SheetDistribution_xxx constant") - Export tabulation to Excel
  • array RenderHtml() - This function will return array html of all chart created on current tabulation script
  • Empty Reset() - Reset tabulation
  • number SaveAsReport(string name "name of pdf report", int parentId "parentId", Dictionary permissionGroups "Grant groups have permission to a resource.", bool overwrite " 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.") - 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.
  • Empty SetPdfMargin(int marginType "Diagram_PdfHeader_Margin_xxx constant", int margin "The value the margin should have. Valid value: 0-100") - Sets a given margin in the Pdf report
  • Empty SetPDFPrintingDirection(int direction "Diagram_PdfLayoutDirection_xxx constant") - Set PDF printing direction
  • (From object) string ToString() - The string representation of the object.

Properties

  • bool EnableOddEvenRowHeader { get; set; } - This setting makes it possible to either activate or deactivate the chart's inheritance of the odd even rows styles from the style sheet
  • array ExcludedSortOrderHorizontal { get; set; } - 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.
  • array ExcludedSortOrderVertical { get; set; } - 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.
  • int HorizontalSort { get; set; } - Sort the tabulation table in horizontal . The constants for this parameter Tabulation_SortOrder_xxx
  • int HorizontalSortDataColumn { get; set; } - Define which column should be sort. Use combine with HorizontalSort. It's the column you want to sort (start with 0)
  • bool MergeStatisticPctItem { get; set; } - 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.
  • string ObjectTypeName { get; } - The name of the type of object.
  • bool ShowErrorInResult { get; set; } - Show/hide error on result.
  • bool ShowExpression { get; set; } - Show/hide a expression column
  • bool ShowFilterDescription { get; set; } - Show/hide filter in table
  • bool ShowResultAsPdf { get; set; } - Show/hide export PDF dialog.
  • bool ShowResultViewer { get; set; } - Enables or disables whether the diagrams created will be shown in the Result viewer-dialog when the script has been executed successfully.
  • bool ShowSignificanceDescription { get; set; } - show/hide significance row in table
  • bool ShowTotalColumn { get; set; } - Show/hide the total column
  • bool ShowWeightDescription { get; set; } - Show/hide weight row in table
  • int StartingPageNumber { get; set; } - Get/Set the starting page number for the PDF report.
  • ReportStyleSheet StyleSheet { get; set; } - Get/set the report style sheet which is be used when displaying/creating diagrams
  • int TableChartLayoutType { get; set; } - Use constant TableChartLayout_xxx to sets the general style of a table chart with some prefixed layout styles overriding any style sheet settings.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • int VerticalSort { get; set; } - Sort the tabulation table in vertical. The constants for this parameter Tabulation_SortOrder_xxx
  • int VerticalSortDataColumn { get; set; } - Define which column should be sort. Use combine with VerticalSort. It's the column you want to sort (start with 0)

Examples

//*** CreateCrossDiagram ***//
number reportStyleSheetId = 11060624;
TabulationDiagramParameter p = new TabulationDiagramParameter();
p.DataCacheId = 16749647;
Tabulation t = new Tabulation();
t.StyleSheet = new ReportStyleSheet(reportStyleSheetId);
t.CreateCrossDiagram({"Q1"}, {"Q2"}, p);

//*** addParagraph addImage and SaveAsReport ShowResultAsPdf ***//

TabulationDiagramParameter p = new TabulationDiagramParameter();
p.DataCacheId = 17116726;
Tabulation t = new Tabulation ();
TabulationTextStyle textStyle = new TabulationTextStyle();
textStyle.Color = new Color("red", false); 
TabulationParagraphStyle paragraphStyle = new TabulationParagraphStyle();
t.AddToHeader(new TabulationImage(new Attachment(17148336), paragraphStyle));
paragraphStyle.Alignment = "center"; //left, right, center.
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.AddToBody(new TabulationParagraph(paragraphStyle,"Some Text 2", textStyle));
number parentId = 17148135;
number groupPermissionId = 17146562;
t.SaveAsReport("test", parentId, {groupPermissionId: "Read"}, true);
t.ShowResultAsPdf = true;
Retrieved from "http://wiki.catglobe.com/index.php?title=Tabulation_class&oldid=240450"