LayoutMeasurement

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:278

Constructors

Constructor

new LayoutMeasurement(value: LayoutMeasurementValue): LayoutMeasurement;

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:281

Parameters

Parameter	Type
`value`	`LayoutMeasurementValue`

Returns

LayoutMeasurement

Constructor

new LayoutMeasurement(value: number, unit: LayoutMeasurementUnit): LayoutMeasurement;

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:282

Parameters

Parameter	Type
`value`	`number`
`unit`	`LayoutMeasurementUnit`

Returns

LayoutMeasurement

Properties

Property	Type	Defined in
`unit`	`LayoutMeasurementUnit`	packages/dynamic-design-engine/src/utils/measurements.ts:280
`value`	`number`	packages/dynamic-design-engine/src/utils/measurements.ts:279

Methods

toMM()

toMM(surface: {
  availableMargin: {
     bottom: number;
     left: number;
     right: number;
     top: number;
  };
  bleedArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  cutArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  decorationTechnology: string;
  designConfig: {
     isCompact?: boolean;
     isFullyDecorated?: boolean;
     minFontSizeInPt: number;
     productMinDpi: number;
     ruInPt: number;
     targetFontSizesInPt: readonly number[];
     transformation?: {
        rotationInClockwiseDegrees: number;
        translation: {
           x: number;
           y: number;
        };
     };
  };
  hasOverhang?: boolean;
  height: number;
  id: string;
  isCircular?: boolean;
  name: string;
  safeArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  width: number;
}, maxAvailableInMM: number): number;

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:293

Parameters

Parameter	Type	Description
`surface`	{ `availableMargin`: { `bottom`: `number`; `left`: `number`; `right`: `number`; `top`: `number`; }; `bleedArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `cutArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `decorationTechnology`: `string`; `designConfig`: { `isCompact?`: `boolean`; `isFullyDecorated?`: `boolean`; `minFontSizeInPt`: `number`; `productMinDpi`: `number`; `ruInPt`: `number`; `targetFontSizesInPt`: readonly `number`[]; `transformation?`: { `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }; }; `hasOverhang?`: `boolean`; `height`: `number`; `id`: `string`; `isCircular?`: `boolean`; `name`: `string`; `safeArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `width`: `number`; }	-
`surface.availableMargin`	{ `bottom`: `number`; `left`: `number`; `right`: `number`; `top`: `number`; }	-
`surface.availableMargin.bottom`	`number`	-
`surface.availableMargin.left`	`number`	-
`surface.availableMargin.right`	`number`	-
`surface.availableMargin.top`	`number`	-
`surface.bleedArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	-
`surface.bleedArea.height`	`number`	-
`surface.bleedArea.width`	`number`	-
`surface.bleedArea.x`	`number`	-
`surface.bleedArea.y`	`number`	-
`surface.cutArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	-
`surface.cutArea.height`	`number`	-
`surface.cutArea.width`	`number`	-
`surface.cutArea.x`	`number`	-
`surface.cutArea.y`	`number`	-
`surface.decorationTechnology`	`string`	-
`surface.designConfig`	{ `isCompact?`: `boolean`; `isFullyDecorated?`: `boolean`; `minFontSizeInPt`: `number`; `productMinDpi`: `number`; `ruInPt`: `number`; `targetFontSizesInPt`: readonly `number`[]; `transformation?`: { `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }; }	-
`surface.designConfig.isCompact?`	`boolean`	-
`surface.designConfig.isFullyDecorated?`	`boolean`	-
`surface.designConfig.minFontSizeInPt`	`number`	-
`surface.designConfig.productMinDpi`	`number`	-
`surface.designConfig.ruInPt`	`number`	-
`surface.designConfig.targetFontSizesInPt`	readonly `number`[]	-
`surface.designConfig.transformation?`	{ `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }	-
`surface.designConfig.transformation.rotationInClockwiseDegrees`	`number`	-
`surface.designConfig.transformation.translation`	{ `x`: `number`; `y`: `number`; }	-
`surface.designConfig.transformation.translation.x`	`number`	-
`surface.designConfig.transformation.translation.y`	`number`	-
`surface.hasOverhang?`	`boolean`	If true, the product extends beyond the printable area (as in a t-shirt) If false (default), the product is “fully printed” (like a business card)
`surface.height`	`number`	Height in mm
`surface.id`	`string`	-
`surface.isCircular?`	`boolean`	-
`surface.name`	`string`	-
`surface.safeArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	All units in mm
`surface.safeArea.height`	`number`	-
`surface.safeArea.width`	`number`	-
`surface.safeArea.x`	`number`	-
`surface.safeArea.y`	`number`	-
`surface.width`	`number`	Width in mm
`maxAvailableInMM`	`number`	-

Returns

number

toRu()

toRu(surface: {
  availableMargin: {
     bottom: number;
     left: number;
     right: number;
     top: number;
  };
  bleedArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  cutArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  decorationTechnology: string;
  designConfig: {
     isCompact?: boolean;
     isFullyDecorated?: boolean;
     minFontSizeInPt: number;
     productMinDpi: number;
     ruInPt: number;
     targetFontSizesInPt: readonly number[];
     transformation?: {
        rotationInClockwiseDegrees: number;
        translation: {
           x: number;
           y: number;
        };
     };
  };
  hasOverhang?: boolean;
  height: number;
  id: string;
  isCircular?: boolean;
  name: string;
  safeArea: {
     height: number;
     width: number;
     x: number;
     y: number;
  };
  width: number;
}, maxAvailableInMM: number): number;

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:301

Parameters

Parameter	Type	Description
`surface`	{ `availableMargin`: { `bottom`: `number`; `left`: `number`; `right`: `number`; `top`: `number`; }; `bleedArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `cutArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `decorationTechnology`: `string`; `designConfig`: { `isCompact?`: `boolean`; `isFullyDecorated?`: `boolean`; `minFontSizeInPt`: `number`; `productMinDpi`: `number`; `ruInPt`: `number`; `targetFontSizesInPt`: readonly `number`[]; `transformation?`: { `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }; }; `hasOverhang?`: `boolean`; `height`: `number`; `id`: `string`; `isCircular?`: `boolean`; `name`: `string`; `safeArea`: { `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }; `width`: `number`; }	-
`surface.availableMargin`	{ `bottom`: `number`; `left`: `number`; `right`: `number`; `top`: `number`; }	-
`surface.availableMargin.bottom`	`number`	-
`surface.availableMargin.left`	`number`	-
`surface.availableMargin.right`	`number`	-
`surface.availableMargin.top`	`number`	-
`surface.bleedArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	-
`surface.bleedArea.height`	`number`	-
`surface.bleedArea.width`	`number`	-
`surface.bleedArea.x`	`number`	-
`surface.bleedArea.y`	`number`	-
`surface.cutArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	-
`surface.cutArea.height`	`number`	-
`surface.cutArea.width`	`number`	-
`surface.cutArea.x`	`number`	-
`surface.cutArea.y`	`number`	-
`surface.decorationTechnology`	`string`	-
`surface.designConfig`	{ `isCompact?`: `boolean`; `isFullyDecorated?`: `boolean`; `minFontSizeInPt`: `number`; `productMinDpi`: `number`; `ruInPt`: `number`; `targetFontSizesInPt`: readonly `number`[]; `transformation?`: { `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }; }	-
`surface.designConfig.isCompact?`	`boolean`	-
`surface.designConfig.isFullyDecorated?`	`boolean`	-
`surface.designConfig.minFontSizeInPt`	`number`	-
`surface.designConfig.productMinDpi`	`number`	-
`surface.designConfig.ruInPt`	`number`	-
`surface.designConfig.targetFontSizesInPt`	readonly `number`[]	-
`surface.designConfig.transformation?`	{ `rotationInClockwiseDegrees`: `number`; `translation`: { `x`: `number`; `y`: `number`; }; }	-
`surface.designConfig.transformation.rotationInClockwiseDegrees`	`number`	-
`surface.designConfig.transformation.translation`	{ `x`: `number`; `y`: `number`; }	-
`surface.designConfig.transformation.translation.x`	`number`	-
`surface.designConfig.transformation.translation.y`	`number`	-
`surface.hasOverhang?`	`boolean`	If true, the product extends beyond the printable area (as in a t-shirt) If false (default), the product is “fully printed” (like a business card)
`surface.height`	`number`	Height in mm
`surface.id`	`string`	-
`surface.isCircular?`	`boolean`	-
`surface.name`	`string`	-
`surface.safeArea`	{ `height`: `number`; `width`: `number`; `x`: `number`; `y`: `number`; }	All units in mm
`surface.safeArea.height`	`number`	-
`surface.safeArea.width`	`number`	-
`surface.safeArea.x`	`number`	-
`surface.safeArea.y`	`number`	-
`surface.width`	`number`	Width in mm
`maxAvailableInMM`	`number`	-

Returns

number

toString()

toString(): string;

Defined in: packages/dynamic-design-engine/src/utils/measurements.ts:309

Returns

string