Class Product

Inheritance

ModelComponent

Product

Package: @aurigma/design-atoms-model

Constructors

(constructor)(surfaces)

Constructs a new instance of the Product class

Declaration

constructor(surfaces?: Surface[]);

Parameters

Type	Name	Description
Surface[]	surfaces

Properties

defaultCropMarks

Declaration

get defaultCropMarks(): Collection<CropMark>;

set defaultCropMarks(value: Collection<CropMark>);

Property Value

Type	Description
Collection<CropMark>

defaultDesignLocation

Declaration

defaultDesignLocation: PointF;

Property Value

Type	Description
PointF

defaultSafetyLines

Declaration

get defaultSafetyLines(): Collection<SafetyLine>;

set defaultSafetyLines(value: Collection<SafetyLine>);

Property Value

Type	Description
Collection<SafetyLine>

palette

Declaration

palette: Palette;

Property Value

Type	Description
Palette

preferredFonts

Declaration

get preferredFonts(): string[];

set preferredFonts(value: string[]);

Property Value

Type	Description
string[]

surfaces

Declaration

get surfaces(): Collection<Surface>;

set surfaces(value: Collection<Surface>);

Property Value

Type	Description
Collection<Surface>

watermarkConfig

Declaration

watermarkConfig: WatermarkConfig;

Property Value

Type	Description
WatermarkConfig

Methods

_copy(source, destination, generateNewIds)

Declaration

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

Parameters

Type	Name	Description
Product	source
Product	destination
boolean	generateNewIds

Returns

Type	Description
void

clone(generateNewIds)

Declaration

clone(generateNewIds?: boolean): Product;

Parameters

Type	Name	Description
boolean	generateNewIds

Returns

Type	Description
Product

generateNewIds()

Declaration

generateNewIds(): void;

Returns

Type	Description
void

getAllItems(options)

Declaration

getAllItems(options?: IGetAllItemsOptions): Item[];

Parameters

Type	Name	Description
IGetAllItemsOptions	options

Returns

Type	Description
Item[]

getSurface(key)

Get surface by name or index.

Declaration

getSurface(key: string): any;

Parameters

Type	Name	Description
string	key	Surface name or index.

Returns

Type	Description
any

serialize(serializer, forServer)

Declaration

serialize(serializer: IProductSerializer, forServer?: boolean): string;

Parameters

Type	Name	Description
IProductSerializer	serializer
boolean	forServer

Returns

Type	Description
string