Interface SVGActionResult

Standardized result from SVG actions

interface SVGActionResult {
    Message?: string;
    Params?: ActionParam[];
    ResultCode: string;
    Success: boolean;
    diagnostics?: Record<string, unknown>;
    height?: number;
    svg?: string;
    warnings?: string[];
    width?: number;
}

Hierarchy (view full)

Properties

Message? Params? ResultCode Success diagnostics? height? svg? warnings? width?

Properties

Optional Message

Message?: string

Optional, additional information about the result of the action

Optional Params

Params?: ActionParam[]

All parameters including inputs and outputs are provided here for convenience

ResultCode

ResultCode: string

A string that indicates the strucutred output/results of the action

Success

Success: boolean

Indicates if the action was successful or not.

Optional diagnostics

diagnostics?: Record<string, unknown>

Diagnostic information

Optional height

height?: number

Height in pixels

Optional svg

svg?: string

SVG XML string ready to embed

Optional warnings

warnings?: string[]

Warnings about rendering issues

Optional width

width?: number

Width in pixels

Settings

Member Visibility

Theme

On This Page

MessageParamsResultCodeSuccessdiagnosticsheightsvgwarningswidth