|
Cross
|
Top level interface for Table related machinery in Carbon.
Inheritance Hierarchy
Namespace: RCS.Carbon.Tables
Assembly: RCS.Carbon.Tables (in RCS.Carbon.Tables.dll) Version: 9.1.0
SyntaxC#
public sealed class CrossTabEngine : VEngine
The CrossTabEngine type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CrossTabEngine(ILicensingProvider, String) | Creates a Carbon cross-tabulation engine using a custom licensing provider. |
| CrossTabEngine(String, Int32, String) | Creates a Carbon cross-tabulation engine using the Red Centre Software licensing provider via calls to the RCS licensing web service. |
Methods| Name | Description | |
|---|---|---|
| AddRemBase | Insert bases into passed top/side spec string |
| AxisAsNodes | Return named axis as GenNodes |
| AxisTreeAsNodes | Return current AxisTree as GenNodes |
| CloseJob |
Closes the job associated with the engine.
(Overrides VEngine.CloseJob) |
| DeleteCBT | Deletes a report that was previously saved via TableSaveCBT(String). |
| DeleteInUserTOC | Delete CBT under user section |
| DeleteTableTOC | Delete CBT under user section |
| DrillDashboardTableAsOXT | Load a table, drill with passed filter, and return oxt of result |
| ExecUserTOCGenNodes | ExecUser toc is Exec and User sections |
| FullTOCGenNodes | Full toc is Exec User and Session sections |
| FunctionAction | Various actions for changes to user functions list. |
| FunctionListAsNodes | Returns user functions list as GenNode[] |
| GenTab(String, TableSpec) | Generate a table from a shared table spec object |
| GenTab(String, XTableSpec) | Generate a table from a full table spec object |
| 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. |
| 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. |
| GenTabAsPandasRaw | EXPERIMENTAL -- Generates a crosstab report as an object that can be transformed into pandas compliant JSON. |
| GenTabAsXLSX | EXPERIMENTAL -- Generates a crosstab report as a strongly-typed byte array of an Excel Workbook. |
| GenTabXLSX | Generate a table from a shared table spec object and return the xlsxblob for Silver |
| GetEditSpec | Get current table spec for edit |
| GetNewSpec | Get empty table spec for starting a new table |
| GetProps | Gets the display properties of the open job. |
| GetTabAsPandas | EXPERIMENTAL -- Converts the current job's display table into an object shaped like a pandas dataframe. |
| InsertBases | Insert bases nodes under each codeframe in the spec, rerun and redisplay |
| ListSavedReports | Lists the contents of the saved reports directory as a hierarchy of nodes. |
| LoadAxisTree | Load named axis tree |
| LoadTableTOC | Load CBT from TOCNode. |
| LoadTOC | Load TOC files into memory in preparation for using TOC Exec/User/Session structure |
| Message | Return current message from job actions. |
| Nest | Nest a given axis on a filter expression |
| ReformatTable | Apply properties to current table returning string in assigned format. |
| RestoreState | Restores the state of a crosstab engine instance from a set of opaque strings that were created by the SaveState 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. |
| SaveTableSessionTOC | Save a CBT into session section |
| SaveTableUserTOC | Save CBT under user section |
| SetProps | Set table display properties. |
| SetPropsXLSX | Set table display properties and return the XLSXblob for Silver |
| SimpleTOCGenNodes | Simple TOC is Exec plus one user |
| TableAsFormat(XDisplayProperties) | Formats a crosstab report with passed display properties |
| TableAsFormat(XOutputFormat) | Formats a crosstab report in a specified format |
| TableGetProps | Gets a reference to the display properties. |
| TableLoadCBT | Load CBT. |
| TableLoadCBTXLSX | Load CBT and return xlsx blob for display. |
| TableSaveCBT | Save as CBT. |
See Also