Table of Contents

Class VizCommand

Inheritance
VizCommand
Implements
Inherited Members
Namespace
TabularEditor.Shared.Scripting
Assembly
TabularEditor3.Shared.dll

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

public record VizCommand : IEquatable<VizCommand>
Extension Methods

Constructors

VizCommand(string, object)

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

public VizCommand(string Action, object Payload)

Parameters

Type Name Description
string Action
object Payload

VizCommand(VizCommand)

protected VizCommand(VizCommand original)

Parameters

Type Name Description
VizCommand original

Properties

Action

public string Action { get; init; }

Property Value

Type Description
string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type Description
Type

Payload

public object Payload { get; init; }

Property Value

Type Description
object

Methods

Deconstruct(out string, out object)

public void Deconstruct(out string Action, out object Payload)

Parameters

Type Name Description
string Action
object Payload

Equals(object?)

public override bool Equals(object? obj)

Parameters

Type Name Description
object obj

Returns

Type Description
bool

Equals(VizCommand?)

public virtual bool Equals(VizCommand? other)

Parameters

Type Name Description
VizCommand other

Returns

Type Description
bool

GetHashCode()

public override int GetHashCode()

Returns

Type Description
int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type Name Description
StringBuilder builder

Returns

Type Description
bool

ToString()

public override string ToString()

Returns

Type Description
string

Operators

operator ==(VizCommand?, VizCommand?)

public static bool operator ==(VizCommand? left, VizCommand? right)

Parameters

Type Name Description
VizCommand left
VizCommand right

Returns

Type Description
bool

operator !=(VizCommand?, VizCommand?)

public static bool operator !=(VizCommand? left, VizCommand? right)

Parameters

Type Name Description
VizCommand left
VizCommand right

Returns

Type Description
bool