ILocationData

Interfaces

ILocationData

A structure defining the default location of design elements.

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

originX?

optional originX?: OriginPointType;

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

originY?

optional originY?: OriginPointType;

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

x?

optional 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.

y?

optional 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.