View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IObjectInspectorConfigParsed Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure containing the configuration of the Object inspector.

example
configuration = {
    widgets: {
        ObjectInspector: {
            bgItemEnabled: false,
            dndEnabled: false,
            toggleEnabled: true,
            inStringPlaceholderMode: "Single",
            violationWarningsEnabled: false
        }
    }
};

Properties

Optional aboveCanvasOnSmallScreenEnabled

aboveCanvasOnSmallScreenEnabled: boolean

Allows you to show the Object Inspector above the canvas. If true, the Object Inspector appears above the canvas when you work on small-screen devices; otherwise, it appears from the left side of the canvas. The default value is true.

Optional bgItemEnabled

bgItemEnabled: boolean

Displays the background element in the Object inspector. The default value is true.

Optional dndEnabled

dndEnabled: boolean

Allows your users to drag-and-drop layers in the Object inspector. The default value is true.

Optional emptyListTextEnabled

emptyListTextEnabled: boolean

Enables the message displayed in the Object inspector when loaded template has no customizable layers.

Optional expandNestedGroups

expandNestedGroups: boolean

If true, allows the user to expand all nested groups when clicking the parent group in the Object Inspector. If false, the user has to click the groups one by one to expand them all. The value in the config is false.

Optional groupRenameEnabled

groupRenameEnabled: boolean

If true, the user can rename group names in the Object Inspector. The default value is true.

Optional groupsExpandedByDefault

groupsExpandedByDefault: boolean

If true, automatically expands groups in the Object Inspector when loading a product. If false, groups of design elements appear collapsed. The default value is false.

Optional inStringPlaceholderMode

inStringPlaceholderMode: InStringPlaceholderModeType

Defines how the Object Inspector displays in-string placeholders. In the "Single" mode, all items appear at the top of the item list. In the "Multiple" mode, linked in-string placeholders appear separately and keep the order defined in PSD templates. The default value is "Multiple". For details, see the In-String Placeholders and Text Validation topic.

Optional isHidden

isHidden: boolean

Allows for hiding the Object Inspector. The default value is false.

Optional position

position: ObjectInspectorPositionType

Defines where the Object Inspector shows - on the left or on the right side of the canvas. The default value is Left.

Optional showItemName

showItemName: boolean

Enables text labels for design elements in the Object Inspector. The default value is false. For details, see the Defining Names of Design Elements topic.

Optional toggleEnabled

toggleEnabled: boolean

Enables the Toggle button, which allows your users to toggle the Object Inspector. The default value is false.

Optional variableItemsEnabled

variableItemsEnabled: boolean

Enables variable data printing for texts and images. If true, you can mark design elements as variable items in the editor and then customize them in your e-commerce system. The default value is false.

Optional violationWarningsEnabled

violationWarningsEnabled: boolean

Enables preflight of user designs and displaying warnings in the Object inspector. The default value is true. For details, see the Customizing the User Interface topic.