Interface CellProps

Props of a cell.

interface CellProps {
    cells?: JsonFormsCellRendererRegistryEntry[];
    config?: any;
    data: any;
    enabled: boolean;
    errors: string;
    id: string;
    isValid: boolean;
    path: string;
    renderers?: JsonFormsRendererRegistryEntry[];
    rootSchema: JsonSchema;
    schema: JsonSchema;
    uischema: ControlElement;
    visible: boolean;
    handleChange(path, value): void;
}

Hierarchy (view full)

Properties

cells? config? data enabled errors id isValid path renderers? rootSchema schema uischema visible

Methods

handleChange

Properties

Optional cells

cells?: JsonFormsCellRendererRegistryEntry[]

All available cell renderers.

Optional config

config?: any

Any configuration options for the element.

data

data: any

The data to be rendered.

enabled

enabled: boolean

Whether the rendered element should be enabled.

errors

errors: string

Any validation errors that are caused by the data to be rendered.

id

id: string

A unique ID that should be used for rendering the scoped UI schema element.

isValid

isValid: boolean

path

path: string

Instance path the data is written to, in case of a control.

Optional renderers

renderers?: JsonFormsRendererRegistryEntry[]

All available renderers.

rootSchema

rootSchema: JsonSchema

The root schema as returned by the store.

schema

schema: JsonSchema

The JSON schema that describes the data.

uischema

uischema: ControlElement

The UI schema to be rendered.

visible

visible: boolean

Whether the rendered element should be visible.

Methods

handleChange

  • handleChange(path, value): void

  • Update handler that emits a data change

    Parameters

    • path: string

      the path to the data to be updated

    • value: any

      the new value that should be written to the given path

    Returns void

Settings

Member Visibility

Theme

On This Page

cellsconfigdataenablederrorsidisValidpathrenderersrootSchemaschemauischemavisiblehandleChange