Click or drag to resize

CrossTabEngine Methods

The CrossTabEngine type exposes the following members.

Methods
  Name Description
Public method AddRemBase Insert bases into passed top/side spec string
Public method AxisAsNodes Return named axis as GenNodes
Public method AxisTreeAsNodes Return current AxisTree as GenNodes
Public method CloseJob Closes the job associated with the engine.
(Overrides VEngine.CloseJob)
Public method DeleteCBT Deletes a report that was previously saved via TableSaveCBT(String).
Public method DeleteInUserTOC Delete CBT under user section
Public method DeleteTableTOC Delete CBT under user section
Public method DrillDashboardTableAsOXT Load a table, drill with passed filter, and return oxt of result
Public method ExecUserTOCGenNodes ExecUser toc is Exec and User sections
Public method FullTOCGenNodes Full toc is Exec User and Session sections
Public method FunctionAction Various actions for changes to user functions list.
Public method FunctionListAsNodes Returns user functions list as GenNode[]
Public method GenTab(String, TableSpec) Generate a table from a shared table spec object
Public method GenTab(String, XTableSpec) Generate a table from a full table spec object
Public method GenTab(String, String, String, String, String, XSpecProperties, XDisplayProperties) The original string-based table generation method. The crosstab report results are always returned as a string. There are two usage patterns for this method: (1) If the output format is not None, then the returned string represents the generated report in the best way possible (2) If the output format is None, then the return value is null and the internal state of the table data is prepared for later output in a chosen format.
Public method GenTabAsPandas EXPERIMENTAL -- Generates crosstab results in a simpified strongly-typed format that clients can easily transform into shaped JSON that is suitable for consumption by the Python pandas package. Note that this method does not touch the current job and it could be a static method.
Public method GenTabAsPandasRaw EXPERIMENTAL -- Generates a crosstab report as an object that can be transformed into pandas compliant JSON.
Public method GenTabAsXLSX EXPERIMENTAL -- Generates a crosstab report as a strongly-typed byte array of an Excel Workbook.
Public method GenTabXLSX Generate a table from a shared table spec object and return the xlsxblob for Silver
Public method GetEditSpec Get current table spec for edit
Public method GetNewSpec Get empty table spec for starting a new table
Public method GetProps Gets the display properties of the open job.
Public method GetTabAsPandas EXPERIMENTAL -- Converts the current job's display table into an object shaped like a pandas dataframe.
Public method InsertBases Insert bases nodes under each codeframe in the spec, rerun and redisplay
Public method ListSavedReports Lists the contents of the saved reports directory as a hierarchy of nodes.
Public method LoadAxisTree Load named axis tree
Public method LoadTableTOC Load CBT from TOCNode.
Public method LoadTOC Load TOC files into memory in preparation for using TOC Exec/User/Session structure
Public method Message Return current message from job actions.
Public method Nest Nest a given axis on a filter expression
Public method ReformatTable Apply properties to current table returning string in assigned format.
Public method RestoreState Restores the state of a crosstab engine instance from a set of opaque strings that were created by the SaveState method.
Public method SaveState Saves the internal state of the crosstab engine instance to a set of opaque strings. Hosting applications can persist the state information in whatever way is suitable and restore an engine's state using the RestoreState(String) method.
Public method SaveTableSessionTOC Save a CBT into session section
Public method SaveTableUserTOC Save CBT under user section
Public method SetProps Set table display properties.
Public method SetPropsXLSX Set table display properties and return the XLSXblob for Silver
Public method SimpleTOCGenNodes Simple TOC is Exec plus one user
Public method TableAsFormat(XDisplayProperties) Formats a crosstab report with passed display properties
Public method TableAsFormat(XOutputFormat) Formats a crosstab report in a specified format
Public method TableGetProps Gets a reference to the display properties.
Public method TableLoadCBT Load CBT.
Public method TableLoadCBTXLSX Load CBT and return xlsx blob for display.
Public method TableSaveCBT Save as CBT.
Top
See Also