UNPKG

@aurigma/design-atoms-interfaces

Version:

40 lines (39 loc) 1.37 kB
import { IItemData } from "./IItemData"; import { ILinePermissionsData } from "./ILinePermissionsData"; import { IPointF } from "./IPointF"; /** * A structure containing default parameters of lines. * @remarks You can apply these parameters to the `line` object through either **clientConfig.json** or {@link https://customerscanvas.com/dev/editors/iframe-api/reference/design-editor-iframe/iconfiguration.html|IConfiguration}. * @example * ```json * { * "defaultItemsConfig": { * "line": { * "width": 8, * "color": "rgb(255,0,0)", * "point0": { "x": 10, "y": 10 }, * "point1": { "x": 100, "y": 10 }, * "linePermissions": { * "allowChangeLineWidth": false, * "allowChangeLineColor": false * } * } * } * } * ``` * @public */ export interface ILineItemData extends IItemData { /** A default width of lines, in points. By default, this value is `1`. */ width?: number; /** A default color of lines. By default, this value is `"rgba(0,0,0,1)"`. */ color?: string; fixedWidth?: boolean; /** A default start point of lines. */ point0?: IPointF; /** A default end point of lines. */ point1?: IPointF; /** A structure defining line permissions. */ linePermissions?: ILinePermissionsData; overprintStroke?: boolean; }