Surface

Classes

Surface

Extends

• ModelComponent

Constructors

Constructor

new Surface(
   width?, 
   height?, 
   mockup?, 
   printAreas?, 
   id?, 
   name?, 
   initDefaultContainers?): Surface;

Parameters

Parameter	Type	Default value
width?	number	undefined
height?	number	undefined
mockup?	SurfaceMockup	undefined
printAreas?	PrintArea[]	[]
id?	string	undefined
name?	string	undefined
initDefaultContainers?	boolean	undefined

Returns

Surface

Overrides

ModelComponent.constructor

Properties

id

id: string;

Inherited from

ModelComponent.id

parentProduct

parentProduct: Product;

watermark

watermark: Watermark = null;

Accessors

containers

Get Signature

get containers(): Collection<Container>;

Returns

Collection<Container>

Set Signature

set containers(value): void;

Parameters

Parameter	Type
value	Collection<Container>

Returns

void

height

Get Signature

get height(): number;

Returns

number

Set Signature

set height(value): void;

Parameters

Parameter	Type
value	number

Returns

void

interactiveZones

Get Signature

get interactiveZones(): Collection<InteractiveZone>;

Returns

Collection<InteractiveZone>

Set Signature

set interactiveZones(value): void;

Parameters

Parameter	Type
value	Collection<InteractiveZone>

Returns

void

mockup

Get Signature

get mockup(): SurfaceMockup;

Returns

SurfaceMockup

Set Signature

set mockup(value): void;

Parameters

Parameter	Type
value	SurfaceMockup

Returns

void

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

ModelComponent.name

nonChannelContainerItems

Get Signature

get nonChannelContainerItems(): Item[];

Returns

Item[]

previewMockups

Get Signature

get previewMockups(): Collection<SurfaceMockup>;

Returns

Collection<SurfaceMockup>

Set Signature

set previewMockups(value): void;

Parameters

Parameter	Type
value	Collection<SurfaceMockup>

Returns

void

printAreas

Get Signature

get printAreas(): Collection<PrintArea>;

Returns

Collection<PrintArea>

Set Signature

set printAreas(value): void;

Parameters

Parameter	Type
value	Collection<PrintArea>

Returns

void

rotateAngle

Get Signature

get rotateAngle(): number;

Returns

number

Set Signature

set rotateAngle(value): void;

Parameters

Parameter	Type
value	number

Returns

void

tags

Get Signature

get tags(): object;

Returns

object

Set Signature

set tags(value): void;

Parameters

Parameter	Type
value	{ [key: string]: any; }

Returns

void

Inherited from

ModelComponent.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

ModelComponent.version

width

Get Signature

get width(): number;

Returns

number

Set Signature

set width(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

ModelComponent.addPropertyChanged

clone()

clone(generateNewIds?): Surface;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

Surface

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

ModelComponent.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Overrides

ModelComponent.generateNewIds

getAllItems()

getAllItems(options?): IEnumerable<Item>;

Parameters

Parameter	Type
options	IGetAllItemsOptions

Returns

IEnumerable<Item>

getBackgroundItem()

getBackgroundItem(): Item;

Returns

Item

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

object

Overrides

ModelComponent.getSimplifiedObject

printAreaAdded()

printAreaAdded(h): void;

Parameters

Parameter	Type
h	any

Returns

void

printAreaAdded()

printAreaAdded(h): void;

Parameters

Parameter	Type
h	any

Returns

void

printAreaRemoved()

printAreaRemoved(h): void;

Parameters

Parameter	Type
h	any

Returns

void

printAreaRemoved()

printAreaRemoved(h): void;

Parameters

Parameter	Type
h	any

Returns

void

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

ModelComponent.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

ModelComponent.toString

getAllItems()

static getAllItems(surfaces, options?): IEnumerable<Item>;

Parameters

Parameter	Type
surfaces	any
options	IGetAllItemsOptions

Returns

IEnumerable<Item>

getItems()

static getItems(surfaces, options): Item[];

Parameters

Parameter	Type
surfaces	any
options	IGetAllItemsOptions

Returns

Item[]