Table of Contents

Namespace TabularEditor.Shared.Scripting

Classes

BpaAnalysisResult

Complete result of running BPA analysis on a model.

BpaResult

Result of evaluating a single BPA rule against a model object.

BpaRuleError

Result of a BPA rule that failed to compile or evaluate.

ColumnStats

Per-column VertiPaq Analyzer statistics. Returned by Columns.

PartitionStats

Per-partition VertiPaq Analyzer statistics. Returned by Partitions.

QuickScriptSafetyResult

Result of a quick script safety analysis (without full compilation).

RelationshipStats

Per-relationship VertiPaq Analyzer statistics. Returned by Relationships.

ScriptBpa

Script-accessible Best Practice Analyzer helper. Exposed as ScriptHost.Bpa. Delegates are wired by the host (CLI or TE3 UI) at startup.

ScriptException
ScriptHelper

Contains various extension methods which are commonly used in scripts

ScriptHost

This is the host class in which a C# script is executed

ScriptMethodAttribute

Public static methods that are decorated with this attribute, will be exposed to the scripting engine as top-level methods, so that the end-user does not need to specify the class name to invoke the method.

ScriptViz

Script-accessible visualization builder. Exposed as ScriptHost.Viz. Accumulates VizCommand objects that the frontend processes into store actions. Thread safety: TabularEditor.Shared.Scripting.ScriptViz.Commands is static; cleared at request start, drained at request end.

ScriptVpa

Script-accessible VPA (VertiPaq Analyzer) read helper. Exposed as ScriptHost.Vpa. Provides read access to previously collected VPA statistics. Call CollectVertiPaqAnalyzerStats() first to populate the data.

TableStats

Per-table VertiPaq Analyzer statistics. Returned by Tables.

VertipaqSummary

Model-level VertiPaq Analyzer summary. Returned by Summary.

VizCommand

A serializable command emitted by the viz scripting API. The frontend viz-script-bridge processes these into store actions.

VizPageBuilder

Fluent builder for configuring a viz page.

VizReportBuilder

Fluent builder for configuring a viz report.

VizVisualBuilder

Fluent builder for configuring a visual within a page.

Interfaces

IMacroActionCreator
IScriptMessageSink

Hook for redirecting script messages (Info / Warning / Error / Output) in command-line / headless hosts. When a sink is registered through ScriptHelper.InitScriptHelper and TabularEditor.IApp.CommandLineMode is true, all script messaging routes through the sink instead of writing directly to Console. The UI app passes null (legacy behavior preserved).