Class Surface

Inheritance

ModelComponent

Surface

Package: @aurigma/design-atoms-model

Constructors

(constructor)(width, height, mockup, printAreas, id, name, initDefaultContainers)

Constructs a new instance of the Surface class

Declaration

constructor(width?: number, height?: number, mockup?: SurfaceMockup, printAreas?: PrintArea[], id?: string, name?: string, initDefaultContainers?: boolean);

Parameters

Type	Name	Description
number	width
number	height
SurfaceMockup	mockup
PrintArea[]	printAreas
string	id
string	name
boolean	initDefaultContainers

Properties

containers

Declaration

get containers(): Collection<SurfaceContainer>;

set containers(value: Collection<SurfaceContainer>);

Property Value

Type	Description
Collection<SurfaceContainer>

height

Declaration

get height(): number;

set height(value: number);

Property Value

Type	Description
number

interactiveZones

Declaration

get interactiveZones(): Collection<InteractiveZone>;

set interactiveZones(value: Collection<InteractiveZone>);

Property Value

Type	Description
Collection<InteractiveZone>

mockup

Declaration

get mockup(): SurfaceMockup;

set mockup(value: SurfaceMockup);

Property Value

Type	Description
SurfaceMockup

nonChannelContainerItems

Declaration

get nonChannelContainerItems(): Item[];

Property Value

Type	Description
Item[]

parentProduct

Declaration

parentProduct: Product;

Property Value

Type	Description
Product

previewMockups

Declaration

get previewMockups(): Collection<SurfaceMockup>;

set previewMockups(value: Collection<SurfaceMockup>);

Property Value

Type	Description
Collection<SurfaceMockup>

printAreas

Declaration

get printAreas(): Collection<PrintArea>;

set printAreas(value: Collection<PrintArea>);

Property Value

Type	Description
Collection<PrintArea>

rotateAngle

Declaration

get rotateAngle(): number;

set rotateAngle(value: number);

Property Value

Type	Description
number

watermark

Declaration

watermark: Watermark;

Property Value

Type	Description
Watermark

width

Declaration

get width(): number;

set width(value: number);

Property Value

Type	Description
number

Methods

_copy(source, destination, generateNewIds)

Declaration

protected _copy(source: Surface, destination: Surface, generateNewIds: boolean): void;

Parameters

Type	Name	Description
Surface	source
Surface	destination
boolean	generateNewIds

Returns

Type	Description
void

add_printAreaAdded(h)

Declaration

add_printAreaAdded(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

add_printAreaRemoved(h)

Declaration

add_printAreaRemoved(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

clone(generateNewIds)

Declaration

clone(generateNewIds?: boolean): Surface;

Parameters

Type	Name	Description
boolean	generateNewIds

Returns

Type	Description
Surface

generateNewIds()

Declaration

generateNewIds(): void;

Returns

Type	Description
void

getAllItems(options)

Declaration

getAllItems(options?: IGetAllItemsOptions): Enumerable.IEnumerable<Item>;

Parameters

Type	Name	Description
IGetAllItemsOptions	options

Returns

Type	Description
Enumerable.IEnumerable<Item>

getAllItems(surfaces, options)

Declaration

static getAllItems(surfaces: Enumerable.IEnumerable<Surface> | Surface[], options?: IGetAllItemsOptions): Enumerable.IEnumerable<Item>;

Parameters

Type	Name	Description
Enumerable.IEnumerable<Surface> | Surface[]	surfaces
IGetAllItemsOptions	options

Returns

Type	Description
Enumerable.IEnumerable<Item>

getBackgroundItem()

Declaration

getBackgroundItem(): Item;

Returns

Type	Description
Item

getItems(surfaces, options)

Declaration

static getItems(surfaces: Enumerable.IEnumerable<Surface> | Surface[], options: IGetAllItemsOptions): Item[];

Parameters

Type	Name	Description
Enumerable.IEnumerable<Surface> | Surface[]	surfaces
IGetAllItemsOptions	options

Returns

Type	Description
Item[]

getSimplifiedObject()

Declaration

getSimplifiedObject(): {};

Returns

Type	Description
{}

remove_printAreaAdded(h)

Declaration

remove_printAreaAdded(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

remove_printAreaRemoved(h)

Declaration

remove_printAreaRemoved(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void