Skip to main content

Product

Classes

Product

Extends

Constructors

Constructor
new Product(surfaces?): Product;
Parameters
ParameterTypeDefault value
surfacesSurface[][]
Returns

Product

Overrides

ModelComponent.constructor

Properties

defaultDesignLocation
defaultDesignLocation: PointF;
id
id: string;
Inherited from

ModelComponent.id

palette
palette: Palette;
watermarkConfig
watermarkConfig: WatermarkConfig;

Accessors

defaultCropMarks
Get Signature
get defaultCropMarks(): Collection<CropMark>;
Returns

Collection<CropMark>

Set Signature
set defaultCropMarks(value): void;
Parameters
ParameterType
valueCollection<CropMark>
Returns

void

defaultSafetyLines
Get Signature
get defaultSafetyLines(): Collection<SafetyLine>;
Returns

Collection<SafetyLine>

Set Signature
set defaultSafetyLines(value): void;
Parameters
ParameterType
valueCollection<SafetyLine>
Returns

void

name
Get Signature
get name(): string;
Returns

string

Set Signature
set name(value): void;
Parameters
ParameterType
valuestring
Returns

void

Inherited from

ModelComponent.name

preferredFonts
Get Signature
get preferredFonts(): string[];
Returns

string[]

Set Signature
set preferredFonts(value): void;
Parameters
ParameterType
valuestring[]
Returns

void

surfaces
Get Signature
get surfaces(): Collection<Surface>;
Returns

Collection<Surface>

Set Signature
set surfaces(value): void;
Parameters
ParameterType
valueCollection<Surface>
Returns

void

tags
Get Signature
get tags(): object;
Returns

object

Set Signature
set tags(value): void;
Parameters
ParameterType
value{ [key: string]: any; }
Returns

void

Inherited from

ModelComponent.tags

version
Get Signature
get version(): string;
Returns

string

Inherited from

ModelComponent.version

Methods

addPropertyChanged()
addPropertyChanged(listener): void;
Parameters
ParameterType
listener(sender, eventArgs) => void
Returns

void

Inherited from

ModelComponent.addPropertyChanged

clone()
clone(generateNewIds?): Product;
Parameters
ParameterTypeDefault value
generateNewIdsbooleanfalse
Returns

Product

equals()
equals(other): boolean;
Parameters
ParameterType
otherModelComponent
Returns

boolean

Inherited from

ModelComponent.equals

generateNewIds()
generateNewIds(): void;
Returns

void

Overrides

ModelComponent.generateNewIds

getAllItems()
getAllItems(options?): Item[];
Parameters
ParameterType
optionsIGetAllItemsOptions
Returns

Item[]

getSimplifiedObject()
getSimplifiedObject(omitProperties?): object;
Parameters
ParameterType
omitProperties?string | string[]
Returns

object

Inherited from

ModelComponent.getSimplifiedObject

getSurface()
getSurface(key): Surface;

Get surface by name or index.

Parameters
ParameterTypeDescription
keystringSurface name or index.
Returns

Surface

removePropertyChanged()
removePropertyChanged(listener): void;
Parameters
ParameterType
listener(sender, eventArgs) => void
Returns

void

Inherited from

ModelComponent.removePropertyChanged

serialize()
serialize(serializer, forServer?): string;
Parameters
ParameterType
serializerIProductSerializer
forServer?boolean
Returns

string

toString()
toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

ModelComponent.toString

Was this page helpful?