@aurigma/design-atoms-interfaces
Version:
44 lines (43 loc) • 1.75 kB
TypeScript
import { OriginPointType } from "../OriginPointType";
/**
* A structure defining the default location of design elements.
* @example For example, you can add a custom button to the Toolbox as follows:
* ```json
* {
* "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
* }
* }
* }]
* }
* }
* }
* ```
* @public
*/
export interface ILocationData {
/** The x coordinate, in either points or percent of available width. The default value is `0`, which is equivalent to the left edge. */
x?: 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. */
y?: string | number;
/** The origin point for the x coordinate relative to a rectangle bounding this design element. Possible values are `"Left"`, `"Right"`, and `"Center"`. */
originX?: OriginPointType;
/** The origin point for the y coordinate relative to a rectangle bounding this design element. Possible values are `"Top"`, `"Bottom"`, and `"Center"`. */
originY?: OriginPointType;
}