Class VizVisualBuilder

Inheritance

object

VizVisualBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace

TabularEditor.Shared.Scripting

Assembly

TabularEditor3.Shared.dll

Fluent builder for configuring a visual within a page.

public class VizVisualBuilder

Extension Methods

ScriptHelper.Output(object)

Methods

AddField(string, string, string, string, string)

Add a field to a well. Wells: rows, values, legend, targets. objectType: "Column" (default) or "Measure". aggregation: "Sum" (default), "Count", "Average", "Min", "Max", "None".

public VizVisualBuilder AddField(string well, string table, string objectName, string objectType = "Column", string aggregation = "Sum")

Parameters

Type	Name	Description
string	well
string	table
string	objectName
string	objectType
string	aggregation

Returns

Type	Description
VizVisualBuilder

SetOption(string, object)

Set a visual option (e.g. "horizontal" = true, "showLegend" = false). Value must be a primitive type (bool, int, double, string).

public VizVisualBuilder SetOption(string key, object value)

Parameters

Type	Name	Description
string	key
object	value

Returns

Type	Description
VizVisualBuilder

SetSize(int, int)

Set the visual size explicitly.

public VizVisualBuilder SetSize(int w, int h)

Parameters

Type	Name	Description
int	w
int	h

Returns

Type	Description
VizVisualBuilder

SetTitle(string)

Set the visual title.

public VizVisualBuilder SetTitle(string title)

Parameters

Type	Name	Description
string	title

Returns

Type	Description
VizVisualBuilder