--- title: "Container | Customer's Canvas On-Premises" canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Container/" --- # Container > - [`SurfaceContainer`](#surfacecontainer) ## Classes ### ColorLessContainer #### Extends #### Constructors ##### Constructor ```ts new ColorLessContainer(initialItems?, name?): ColorLessContainer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`ColorLessContainer`](#colorlesscontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`constructor`](#constructor-6) #### Properties ##### constraints ```ts constraints: ContainerConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`constraints`](#constraints-4) ##### dpi ```ts dpi: number; ``` ##### id ```ts id: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`id`](#id-6) ##### opaque ```ts opaque: boolean; ``` ##### outputColor ```ts outputColor: Color; ``` ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`parentComponent`](#parentcomponent-6) ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`printingTechniqueConstraints`](#printingtechniqueconstraints-4) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`renderingGroupName`](#renderinggroupname-6) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`translationKey`](#translationkey-6) ##### type ```ts readonly type: string = ColorLessContainer.type; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-12) ##### visualization ```ts visualization: ContainerVisualization; ``` ##### type ```ts static type: string = "ColorLessContainer"; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-13) #### Accessors ##### amount ###### Get Signature ```ts get amount(): number; ``` ###### Returns `number` ###### Set Signature ```ts set amount(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `number` | ###### Returns `void` ##### dither ###### Get Signature ```ts get dither(): Dither; ``` ###### Returns [`Dither`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Dither.md#dither) ###### Set Signature ```ts set dither(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`Dither`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Dither.md#dither) | ###### Returns `void` ##### format ###### Get Signature ```ts get format(): Format; ``` ###### Returns [`Format`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Format.md#format) ###### Set Signature ```ts set format(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`Format`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Format.md#format) | ###### Returns `void` ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`items`](#items-6) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`locked`](#locked-6) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`name`](#name-6) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`region`](#region-6) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`renderingType`](#renderingtype-6) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`tags`](#tags-6) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`version`](#version-6) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`visible`](#visible-6) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`addPropertyChanged`](#addpropertychanged-6) ##### clone() ```ts clone(generateNewIds?): SurfaceContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`SurfaceContainer`](#surfacecontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`clone`](#clone-6) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`equals`](#equals-6) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`generateNewIds`](#generatenewids-6) ##### getSimplifiedObject() ```ts getSimplifiedObject(): object; ``` ###### Returns ###### amount ```ts amount: number; ``` ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### dither ```ts dither: Dither; ``` ###### dpi ```ts dpi: number; ``` ###### format ```ts format: Format; ``` ###### opaque ```ts opaque: boolean; ``` ###### outputColor ```ts outputColor: IColor; ``` ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### visualization ```ts visualization: object; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`getSimplifiedObject`](#getsimplifiedobject-6) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`removePropertyChanged`](#removepropertychanged-6) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`toString`](#tostring-6) *** ### Container #### Extends - [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) #### Extended by - [`MockupContainer`](#mockupcontainer) - [`SurfaceContainer`](#surfacecontainer) #### Constructors ##### Constructor ```ts new Container(initialItems?, name?): Container; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`Container`](#container) ###### Overrides [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`constructor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#constructor) #### Properties ##### id ```ts id: string; ``` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`id`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#id) ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ##### translationKey ```ts translationKey: string; ``` ##### type ```ts readonly type: string = Container.type; ``` ##### type ```ts static type: string = "Container"; ``` #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`name`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#name) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`tags`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#tags) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceMockup`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/SurfaceMockup.md#surfacemockup).[`version`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/SurfaceMockup.md#version) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`addPropertyChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#addpropertychanged) ##### clone() ```ts clone(generateNewIds?): Container; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`Container`](#container) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#equals) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Overrides [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`generateNewIds`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#generatenewids) ##### getSimplifiedObject() ```ts getSimplifiedObject(): Object; ``` ###### Returns `Object` ###### Overrides [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`getSimplifiedObject`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#getsimplifiedobject) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`removePropertyChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#removepropertychanged) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`toString`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#tostring) *** ### FullColorContainer #### Extends - [`SurfaceContainer`](#surfacecontainer) #### Constructors ##### Constructor ```ts new FullColorContainer(initialItems?, name?): FullColorContainer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`FullColorContainer`](#fullcolorcontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`constructor`](#constructor-6) #### Properties ##### colorProfile ```ts colorProfile: string; ``` ##### colorSpace ```ts colorSpace: ColorSpace; ``` ##### constraints ```ts constraints: ContainerConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`constraints`](#constraints-4) ##### id ```ts id: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`id`](#id-6) ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`parentComponent`](#parentcomponent-6) ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`printingTechniqueConstraints`](#printingtechniqueconstraints-4) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`renderingGroupName`](#renderinggroupname-6) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`translationKey`](#translationkey-6) ##### type ```ts readonly type: string = FullColorContainer.type; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-12) ##### type ```ts static type: string = "FullColorContainer"; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-13) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`items`](#items-6) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`locked`](#locked-6) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`name`](#name-6) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`region`](#region-6) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`renderingType`](#renderingtype-6) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`tags`](#tags-6) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`version`](#version-6) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`visible`](#visible-6) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`addPropertyChanged`](#addpropertychanged-6) ##### clone() ```ts clone(generateNewIds?): SurfaceContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`SurfaceContainer`](#surfacecontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`clone`](#clone-6) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`equals`](#equals-6) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`generateNewIds`](#generatenewids-6) ##### getSimplifiedObject() ```ts getSimplifiedObject(): object; ``` ###### Returns ###### colorProfile ```ts colorProfile: string; ``` ###### colorSpace ```ts colorSpace: ColorSpace; ``` ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`getSimplifiedObject`](#getsimplifiedobject-6) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`removePropertyChanged`](#removepropertychanged-6) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`toString`](#tostring-6) *** ### LimitedColorContainer #### Extends - [`SurfaceContainer`](#surfacecontainer) #### Constructors ##### Constructor ```ts new LimitedColorContainer(initialItems?, name?): LimitedColorContainer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`LimitedColorContainer`](#limitedcolorcontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`constructor`](#constructor-6) #### Properties ##### constraints ```ts constraints: ContainerConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`constraints`](#constraints-4) ##### id ```ts id: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`id`](#id-6) ##### maxColorNumber ```ts maxColorNumber: number; ``` ##### paletteUId ```ts paletteUId: string; ``` ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`parentComponent`](#parentcomponent-6) ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`printingTechniqueConstraints`](#printingtechniqueconstraints-4) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`renderingGroupName`](#renderinggroupname-6) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`translationKey`](#translationkey-6) ##### type ```ts readonly type: string = LimitedColorContainer.type; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-12) ##### type ```ts static type: string = "LimitedColorContainer"; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-13) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`items`](#items-6) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`locked`](#locked-6) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`name`](#name-6) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`region`](#region-6) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`renderingType`](#renderingtype-6) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`tags`](#tags-6) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`version`](#version-6) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`visible`](#visible-6) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`addPropertyChanged`](#addpropertychanged-6) ##### clone() ```ts clone(generateNewIds?): SurfaceContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`SurfaceContainer`](#surfacecontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`clone`](#clone-6) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`equals`](#equals-6) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`generateNewIds`](#generatenewids-6) ##### getSimplifiedObject() ```ts getSimplifiedObject(): object; ``` ###### Returns ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### maxColorNumber ```ts maxColorNumber: number; ``` ###### paletteUId ```ts paletteUId: string; ``` ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`getSimplifiedObject`](#getsimplifiedobject-6) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`removePropertyChanged`](#removepropertychanged-6) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`toString`](#tostring-6) *** ### MockupContainer #### Extends - [`Container`](#container) #### Constructors ##### Constructor ```ts new MockupContainer(initialItems?, name?): MockupContainer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`MockupContainer`](#mockupcontainer) ###### Overrides [`Container`](#container).[`constructor`](#constructor-1) #### Properties ##### id ```ts id: string; ``` ###### Inherited from [`Container`](#container).[`id`](#id-1) ##### noPrint ```ts noPrint: boolean = false; ``` ##### noShow ```ts noShow: boolean = false; ``` ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`Container`](#container).[`parentComponent`](#parentcomponent-1) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`Container`](#container).[`renderingGroupName`](#renderinggroupname-1) ##### size ```ts size: SizeF = null; ``` ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`Container`](#container).[`translationKey`](#translationkey-1) ##### type ```ts readonly type: string = Container.type; ``` ###### Inherited from [`Container`](#container).[`type`](#type-2) ##### type ```ts static type: string = "Container"; ``` ###### Inherited from [`Container`](#container).[`type`](#type-3) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`Container`](#container).[`items`](#items-1) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`locked`](#locked-1) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`name`](#name-1) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`Container`](#container).[`region`](#region-1) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Inherited from [`Container`](#container).[`renderingType`](#renderingtype-1) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`Container`](#container).[`tags`](#tags-1) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`Container`](#container).[`version`](#version-1) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`visible`](#visible-1) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`addPropertyChanged`](#addpropertychanged-1) ##### clone() ```ts clone(generateNewIds?): MockupContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`MockupContainer`](#mockupcontainer) ###### Overrides [`Container`](#container).[`clone`](#clone-1) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`Container`](#container).[`equals`](#equals-1) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`Container`](#container).[`generateNewIds`](#generatenewids-1) ##### getSimplifiedObject() ```ts getSimplifiedObject(): Object; ``` ###### Returns `Object` ###### Inherited from [`Container`](#container).[`getSimplifiedObject`](#getsimplifiedobject-1) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`removePropertyChanged`](#removepropertychanged-1) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`Container`](#container).[`toString`](#tostring-1) *** ### SpotColorContainer #### Extends - [`SurfaceContainer`](#surfacecontainer) #### Constructors ##### Constructor ```ts new SpotColorContainer(): SpotColorContainer; ``` ###### Returns [`SpotColorContainer`](#spotcolorcontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`constructor`](#constructor-6) #### Properties ##### constraints ```ts constraints: ContainerConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`constraints`](#constraints-4) ##### id ```ts id: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`id`](#id-6) ##### outputColor ```ts outputColor: Color; ``` ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`parentComponent`](#parentcomponent-6) ##### previewColor ```ts previewColor: RgbColor; ``` ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`printingTechniqueConstraints`](#printingtechniqueconstraints-4) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`renderingGroupName`](#renderinggroupname-6) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`translationKey`](#translationkey-6) ##### type ```ts readonly type: string = SpotColorContainer.type; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-12) ##### type ```ts static type: string = "SpotColorContainer"; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-13) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`items`](#items-6) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`locked`](#locked-6) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`name`](#name-6) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`region`](#region-6) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`renderingType`](#renderingtype-6) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`tags`](#tags-6) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`version`](#version-6) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`visible`](#visible-6) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`addPropertyChanged`](#addpropertychanged-6) ##### clone() ```ts clone(generateNewIds?): SpotColorContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`SpotColorContainer`](#spotcolorcontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`clone`](#clone-6) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`equals`](#equals-6) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`generateNewIds`](#generatenewids-6) ##### getSimplifiedObject() ```ts getSimplifiedObject(): object; ``` ###### Returns ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`getSimplifiedObject`](#getsimplifiedobject-6) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`removePropertyChanged`](#removepropertychanged-6) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`toString`](#tostring-6) *** ### SurfaceContainer #### Extends - [`Container`](#container) #### Extended by - [`ColorLessContainer`](#colorlesscontainer) - [`LimitedColorContainer`](#limitedcolorcontainer) - [`FullColorContainer`](#fullcolorcontainer) - [`SpotColorContainer`](#spotcolorcontainer) - [`TextureContainer`](#texturecontainer) #### Constructors ##### Constructor ```ts new SurfaceContainer(initialItems?, name?): SurfaceContainer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `initialItems?` | [`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)[] | | `name?` | `string` | ###### Returns [`SurfaceContainer`](#surfacecontainer) ###### Overrides [`Container`](#container).[`constructor`](#constructor-1) #### Properties ##### constraints ```ts constraints: ContainerConstraints; ``` ##### id ```ts id: string; ``` ###### Inherited from [`Container`](#container).[`id`](#id-1) ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`Container`](#container).[`parentComponent`](#parentcomponent-1) ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`Container`](#container).[`renderingGroupName`](#renderinggroupname-1) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`Container`](#container).[`translationKey`](#translationkey-1) ##### type ```ts readonly type: string = SurfaceContainer.type; ``` ###### Overrides [`Container`](#container).[`type`](#type-2) ##### type ```ts static type: string = "SurfaceContainer"; ``` ###### Overrides [`Container`](#container).[`type`](#type-3) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`Container`](#container).[`items`](#items-1) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`locked`](#locked-1) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`name`](#name-1) ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`Container`](#container).[`region`](#region-1) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Inherited from [`Container`](#container).[`renderingType`](#renderingtype-1) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`Container`](#container).[`tags`](#tags-1) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`Container`](#container).[`version`](#version-1) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`visible`](#visible-1) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`addPropertyChanged`](#addpropertychanged-1) ##### clone() ```ts clone(generateNewIds?): SurfaceContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`SurfaceContainer`](#surfacecontainer) ###### Overrides [`Container`](#container).[`clone`](#clone-1) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`Container`](#container).[`equals`](#equals-1) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`Container`](#container).[`generateNewIds`](#generatenewids-1) ##### getSimplifiedObject() ```ts getSimplifiedObject(): object; ``` ###### Returns ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Overrides [`Container`](#container).[`getSimplifiedObject`](#getsimplifiedobject-1) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`Container`](#container).[`removePropertyChanged`](#removepropertychanged-1) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`Container`](#container).[`toString`](#tostring-1) *** ### TextureContainer #### Extends - [`SurfaceContainer`](#surfacecontainer) #### Constructors ##### Constructor ```ts new TextureContainer(): TextureContainer; ``` ###### Returns [`TextureContainer`](#texturecontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`constructor`](#constructor-6) #### Properties ##### constraints ```ts constraints: ContainerConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`constraints`](#constraints-4) ##### id ```ts id: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`id`](#id-6) ##### outputColor ```ts outputColor: Color; ``` ##### parentComponent ```ts parentComponent: ModelComponent = null; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`parentComponent`](#parentcomponent-6) ##### previewTextureName ```ts previewTextureName: string; ``` ##### previewTextureSource ```ts previewTextureSource: ImageSource; ``` ##### printingTechniqueConstraints ```ts printingTechniqueConstraints: PrintingTechniqueConstraints; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`printingTechniqueConstraints`](#printingtechniqueconstraints-4) ##### renderingGroupName? ```ts optional renderingGroupName?: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`renderingGroupName`](#renderinggroupname-6) ##### translationKey ```ts translationKey: string; ``` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`translationKey`](#translationkey-6) ##### type ```ts readonly type: string = TextureContainer.type; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-12) ##### type ```ts static type: string = "TextureContainer"; ``` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`type`](#type-13) #### Accessors ##### items ###### Get Signature ```ts get items(): Collection; ``` ###### Returns [`Collection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Collection.md#collection)\<[`BaseItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/BaseItem.md#baseitem)\> ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`items`](#items-6) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`locked`](#locked-6) ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`name`](#name-6) ##### previewTextureSource ###### Get Signature ```ts get previewTextureSource(): ImageSource; ``` ###### Returns [`ImageSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ImageItem.Namespace.ImageItem.md#imagesource) ###### Set Signature ```ts set previewTextureSource(previewTextureSource): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `previewTextureSource` | [`ImageSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ImageItem.Namespace.ImageItem.md#imagesource) | ###### Returns `void` ##### region ###### Get Signature ```ts get region(): RectangleF; ``` ###### Returns [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) ###### Set Signature ```ts set region(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`RectangleF`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RectangleF.md#rectanglef) | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`region`](#region-6) ##### renderingType ###### Get Signature ```ts get renderingType(): RenderingType; ``` ###### Returns [`RenderingType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RenderingType.md#renderingtype) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`renderingType`](#renderingtype-6) ##### tags ###### Get Signature ```ts get tags(): object; ``` ###### Returns `object` ###### Set Signature ```ts set tags(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | \{ \[`key`: `string`\]: `any`; \} | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`tags`](#tags-6) ##### version ###### Get Signature ```ts get version(): string; ``` ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`version`](#version-6) ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`visible`](#visible-6) #### Methods ##### addPropertyChanged() ```ts addPropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`addPropertyChanged`](#addpropertychanged-6) ##### clone() ```ts clone(generateNewIds?): TextureContainer; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `generateNewIds` | `boolean` | `false` | ###### Returns [`TextureContainer`](#texturecontainer) ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`clone`](#clone-6) ##### equals() ```ts equals(other): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `other` | [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent) | ###### Returns `boolean` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`equals`](#equals-6) ##### generateNewIds() ```ts generateNewIds(): void; ``` ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`generateNewIds`](#generatenewids-6) ##### getSimplifiedObject() ```ts getSimplifiedObject(omitProperties?): object; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `omitProperties?` | `string` \| `string`[] | ###### Returns ###### constraints ```ts constraints: object; ``` ###### constraints.maxArtworkSize ```ts maxArtworkSize: object; ``` ###### constraints.maxArtworkSize.height ```ts height: number; ``` ###### constraints.maxArtworkSize.shapeType ```ts shapeType: ArtworkShapeType; ``` ###### constraints.maxArtworkSize.width ```ts width: number; ``` ###### constructor ```ts constructor: Function; ``` The initial value of Object.prototype.constructor is the standard built-in Object constructor. ###### printingTechniqueConstraints ```ts printingTechniqueConstraints: object; ``` ###### printingTechniqueConstraints.allowRasterElements ```ts allowRasterElements: boolean; ``` ###### printingTechniqueConstraints.minFontSize ```ts minFontSize: number; ``` ###### printingTechniqueConstraints.minWidth ```ts minWidth: number; ``` ###### printingTechniqueConstraints.targetDpi ```ts targetDpi: number; ``` ###### hasOwnProperty() ```ts hasOwnProperty(v): boolean; ``` Determines whether an object has a property with the specified name. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### isPrototypeOf() ```ts isPrototypeOf(v): boolean; ``` Determines whether an object exists in another object's prototype chain. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `Object` | Another object whose prototype chain is to be checked. | ###### Returns `boolean` ###### propertyIsEnumerable() ```ts propertyIsEnumerable(v): boolean; ``` Determines whether a specified property is enumerable. ###### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `v` | `PropertyKey` | A property name. | ###### Returns `boolean` ###### toLocaleString() ```ts toLocaleString(): string; ``` Returns a date converted to a string using the current locale. ###### Returns `string` ###### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### valueOf() ```ts valueOf(): Object; ``` Returns the primitive value of the specified object. ###### Returns `Object` ###### Overrides [`SurfaceContainer`](#surfacecontainer).[`getSimplifiedObject`](#getsimplifiedobject-6) ##### removePropertyChanged() ```ts removePropertyChanged(listener): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `listener` | (`sender`, `eventArgs`) => `void` | ###### Returns `void` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`removePropertyChanged`](#removepropertychanged-6) ##### toString() ```ts toString(): string; ``` Returns a string representation of an object. ###### Returns `string` ###### Inherited from [`SurfaceContainer`](#surfacecontainer).[`toString`](#tostring-6)