Membrane React - v0.6.0
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    key?: string

    This field's key inside the parent field. If parent field is an object, it is a property key. If parent field is an array, this is an index inside the array. If it's a top-level field, the key is empty.

    name?: string

    Field's human-readable name.

    schema?: DataSchema

    Field's Data Schema

    value?: any

    Field's value. Can be a plain value or a formula.

    isRequired?: boolean

    Whether this field is required.

    valueLocator?: string

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

    iconUri?: string

    Icon associated with the field (if any)

    level: number

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

    variablesSchema?: any

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

    exampleVariables?: any

    Example values for variables from variablesSchema.

    optionFactories: ComboBoxOptionsFactory[]

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

    isInSchema?: boolean

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

    isDeletable?: boolean

    Can this field be deleted by the user?

    hasSiblings?: boolean

    Whether field has other fields within the same object

    isLastChild?: boolean

    Whether field is last child with siblings

    subFields?: IDataBuilderField[]

    Fields nested into this field

    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.

    dynamicSchemaVariables?: any

    Variables for calculating the dynamic schema for the current field.

    Settings

    Member Visibility

    On This Page

    Properties