Interface IDataBuilderField

interface IDataBuilderField {
    key?: string;
    name?: string;
    schema?: DataSchema;
    value?: any;
    isRequired?: boolean;
    valueLocator?: string;
    iconUri?: string;
    level: number;
    variablesSchema?: any;
    exampleVariables?: any;
    optionFactories: ComboBoxOptionsFactory[];
    isInSchema?: boolean;
    isDeletable?: boolean;
    hasSiblings?: boolean;
    isLastChild?: boolean;
    subFields?: IDataBuilderField[];
    dynamicSchema?: DataSchema;
    dynamicSchemaVariables?: any;
}

Hierarchy (View Summary)

Properties

key? name? schema? value? isRequired? valueLocator? iconUri? level variablesSchema? exampleVariables? optionFactories isInSchema? isDeletable? hasSiblings? isLastChild? subFields? dynamicSchema? dynamicSchemaVariables?

Properties

Optionalkey

key?: string

Optionalname

name?: string

Optionalschema

schema?: DataSchema

Optionalvalue

value?: any

OptionalisRequired

isRequired?: boolean

OptionalvalueLocator

valueLocator?: string

Locator of this field's value in the top-level field value.

OptionaliconUri

iconUri?: string

Icon associated with the field (if any)

level

level: number

Field level in the hierarchy of nested fields. Used for visualization.

OptionalvariablesSchema

variablesSchema?: any

Schema for variables that can be used to build formulas for the field's value.

OptionalexampleVariables

exampleVariables?: any

Example values for variables from variablesSchema.

optionFactories

optionFactories: ComboBoxOptionsFactory[]

Option factories used to display value options for this field inside the ComboBox.

OptionalisInSchema

isInSchema?: boolean

Whether this field is in the parent's schema. If not - it means it was added by the user.

OptionalisDeletable

isDeletable?: boolean

Can this field be deleted by the user?

OptionalhasSiblings

hasSiblings?: boolean

Whether field has other fields within the same object

OptionalisLastChild

isLastChild?: boolean

Whether field is last child with siblings

OptionalsubFields

subFields?: IDataBuilderField[]

Fields nested into this field

OptionaldynamicSchema

dynamicSchema?: DataSchema

Original schema for the top level field. It may contain formulas. We keep it here to calculate dynamic schema for the current field if we were not able to calculate it on the higher level. For example, if different elements of an array get different dynamic schemas, we'll need this original formula in each array element.

OptionaldynamicSchemaVariables

dynamicSchemaVariables?: any

Variables for calculating the dynamic schema for the current field.

Settings

Member Visibility

On This Page

Properties