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

ILocationDefaultConfig Interface

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

A structure defining the default location of design elements.

For example, you can add a custom button to the Toolbox as follows:

example
{
    "widgets": {
        "Toolbox": {
            "buttons": [{
                "action": "CustomText",
                "iconClass": "cc-icon-add-text",
                "itemConfig": {
                    "name":  "CardID",
                    "text": "1234 ABCD 5678",
                    "color": "rgb(193,0,32)",
                    "isVariable":  true,
                    "location": {
                        "originX": "right",
                        "originY": "top",
                        "x": "50%",
                        "y": "0%"
                    },
                    "textPermissions": {
                        "allowChangeText": false
                    }
                }
            }]
        }
    }
}

Properties

Optional originX

originX: OriginPointType

The origin point for the x coordinate relative to a rectangle bounding this design element. Possible values are "Left", "Right", and "Center".

Optional originY

originY: OriginPointType

the origin point for the y coordinate relative to a rectangle bounding this design element. Possible values are "Top", "Bottom", and "Center".

Optional x

x: string | number

The x coordinate, in either points or percent of available width. The default value is 0, which is equivalent to the left edge.

Optional y

y: string | number

The y coordinate, in either points or percent of available height. The default value is 0, which is equivalent to the bottom edge.