Interface IWidgetConfigsForSurface

A structure defining the configuration of widgets for a separate surface.

Package: @aurigma/design-editor-iframe

Remarks

For details, see Configuring UI on different pages.

Examples

product = {
    surfaces: [{
            name: "surface1",
            printAreas: [{ designFile: "Postcard_side1" }]
        },
        {
            name: "surface2",
            printAreas: [{ designFile: "Postcard_side2" }]
        }
    ]
};

config = {
    perSurfaceConfiguration: {
        "surface2": {
            widgets: {
                ObjectInspector: {
                    bgItemEnabled: false
                },
                ColorPicker: {
                    showPaletteOnly: false,
                    sections: [
                        {
                            type: "PaletteSection",
                            palette: [["rgb(0,0,0)", "rgb(255,255,255)"]]
                        }
                    ]
                }
            }
        }
    }
};

Properties

ColorPicker

Settings defining a color selection in the editor.

Declaration

ColorPicker?: ColorPicker.IColorPickerConfig;

Property Value

Type	Description
IColorPickerConfig	Settings defining a color selection in the editor.

ObjectInspector

Settings defining a position of the Object Inspector, an appearance of layers, and messages.

Declaration

ObjectInspector?: IObjectInspectorConfig;

Property Value

Type	Description
IObjectInspectorConfig	Settings defining a position of the Object Inspector, an appearance of layers, and messages.

Toolbox

Settings of design elements that can be added to a canvas from the Toolbox.

Declaration

Toolbox?: IToolboxConfig;

Property Value

Type	Description
IToolboxConfig	Settings of design elements that can be added to a canvas from the Toolbox.