Class ComponentGridControllerExperimental

This controller is experimental and may change without warning. The ComponentGridController is responsible for all communication regarding Component Grid frames. Methods inside this controller can be called by window.SDK.componentGrid.{method-name}

Methods

resetSettings setComponentSource setDataSourceVariable setMapping setResizeMode updateSettings

Methods

resetSettings

setComponentSource

setDataSourceVariable

  • setDataSourceVariable(
        frameId: string,
        dataSourceVariableId: null | string,
    ): Promise<EditorResponse<null>>
    Experimental

    This method will set the data source variable of a specified component grid frame.

    Parameters

    • frameId: string

      the id of the frame to reset

    • dataSourceVariableId: null | string

      the data source variable to set, or null to unset

    Returns Promise<EditorResponse<null>>

setMapping

  • setMapping(
        frameId: string,
        componentId: string,
        targetVariableId: string,
        sourceVariableId: null | string,
        sourceField: null | string,
    ): Promise<EditorResponse<null>>
    Experimental

    This method will set the component grid mapping for a specified frame.

    Parameters

    • frameId: string

      the id of the frame that needs to get updated

    • componentId: string

      the id of the component to map

    • targetVariableId: string

      the id of the target variable to map to

    • sourceVariableId: null | string

      the id of the source variable to map from, or null to unset

    • sourceField: null | string

      the source field to map to

    Returns Promise<EditorResponse<null>>

setResizeMode

updateSettings

Settings

Member Visibility

On This Page

Methods