Interface PolytronOutputParameter

The PolytronOutputParameter interface represents an output parameter.

interface PolytronOutputParameter {
    ColorSpace?: "sRGB" | "Linear";
    FriendlyName?: string;
    ID: string;
    Name: string;
    OutputType?: "OneToMany" | "OneToOne";
    Value: string | number | boolean;
    VariableType: string;
}

Properties

ColorSpace? FriendlyName? ID Name OutputType? Value VariableType

Properties

OptionalColorSpace

ColorSpace?: "sRGB" | "Linear"

Defines the output color space. Valid for image types. Default: "sRGB"

OptionalFriendlyName

FriendlyName?: string

The friendly name used for display.

ID

ID: string

The unique parameter ID.

Name

Name: string

The unique name, no other parameter on the Polytron may have the same name.

OptionalOutputType

OutputType?: "OneToMany" | "OneToOne"

Defines the output type. If OneToMany multiple files may be generated by this parameter. Default: "OneToOne"

Value

Value: string | number | boolean

The output value.

VariableType

VariableType: string

The variable type.

Settings

Member Visibility

On This Page

Properties