Container

Classes

ColorLessContainer

Extends

• SurfaceContainer

Constructors

Constructor

new ColorLessContainer(initialItems?, name?): ColorLessContainer;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

ColorLessContainer

Overrides

SurfaceContainer.constructor

Properties

constraints

constraints: ContainerConstraints;

Inherited from

SurfaceContainer.constraints

dpi

dpi: number;

id

id: string;

Inherited from

SurfaceContainer.id

opaque

opaque: boolean;

outputColor

outputColor: Color;

parentComponent

parentComponent: ModelComponent = null;

Inherited from

SurfaceContainer.parentComponent

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

Inherited from

SurfaceContainer.printingTechniqueConstraints

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

SurfaceContainer.renderingGroupName

translationKey

translationKey: string;

Inherited from

SurfaceContainer.translationKey

type

readonly type: string = ColorLessContainer.type;

Overrides

SurfaceContainer.type

visualization

visualization: ContainerVisualization;

type

static type: string = "ColorLessContainer";

Overrides

SurfaceContainer.type

Accessors

amount

Get Signature

get amount(): number;

Returns

number

Set Signature

set amount(value): void;

Parameters

Parameter	Type
value	number

Returns

void

dither

Get Signature

get dither(): Dither;

Returns

Dither

Set Signature

set dither(value): void;

Parameters

Parameter	Type
value	Dither

Returns

void

format

Get Signature

get format(): Format;

Returns

Format

Set Signature

set format(value): void;

Parameters

Parameter	Type
value	Format

Returns

void

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

SurfaceContainer.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

SurfaceContainer.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

SurfaceContainer.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Overrides

SurfaceContainer.renderingType

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

SurfaceContainer.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

SurfaceContainer.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.addPropertyChanged

clone()

clone(generateNewIds?): SurfaceContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

SurfaceContainer

Overrides

SurfaceContainer.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

SurfaceContainer.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

SurfaceContainer.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

amount

amount: number;

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

dither

dither: Dither;

dpi

dpi: number;

format

format: Format;

opaque

opaque: boolean;

outputColor

outputColor: IColor;

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

visualization

visualization: object;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Overrides

SurfaceContainer.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

SurfaceContainer.toString

---

Container

Extends

• ModelComponent

Extended by

• MockupContainer
• SurfaceContainer

Constructors

Constructor

new Container(initialItems?, name?): Container;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

Container

Overrides

ModelComponent.constructor

Properties

id

id: string;

Inherited from

ModelComponent.id

parentComponent

parentComponent: ModelComponent = null;

renderingGroupName?

optional renderingGroupName?: string;

translationKey

translationKey: string;

type

readonly type: string = Container.type;

type

static type: string = "Container";

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

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

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

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

SurfaceMockup.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

ModelComponent.addPropertyChanged

clone()

clone(generateNewIds?): Container;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

Container

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

ModelComponent.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Overrides

ModelComponent.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): Object;

Returns

Object

Overrides

ModelComponent.getSimplifiedObject

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

---

FullColorContainer

Extends

• SurfaceContainer

Constructors

Constructor

new FullColorContainer(initialItems?, name?): FullColorContainer;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

FullColorContainer

Overrides

SurfaceContainer.constructor

Properties

colorProfile

colorProfile: string;

colorSpace

colorSpace: ColorSpace;

constraints

constraints: ContainerConstraints;

Inherited from

SurfaceContainer.constraints

id

id: string;

Inherited from

SurfaceContainer.id

parentComponent

parentComponent: ModelComponent = null;

Inherited from

SurfaceContainer.parentComponent

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

Inherited from

SurfaceContainer.printingTechniqueConstraints

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

SurfaceContainer.renderingGroupName

translationKey

translationKey: string;

Inherited from

SurfaceContainer.translationKey

type

readonly type: string = FullColorContainer.type;

Overrides

SurfaceContainer.type

type

static type: string = "FullColorContainer";

Overrides

SurfaceContainer.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

SurfaceContainer.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

SurfaceContainer.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

SurfaceContainer.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Overrides

SurfaceContainer.renderingType

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

SurfaceContainer.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

SurfaceContainer.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.addPropertyChanged

clone()

clone(generateNewIds?): SurfaceContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

SurfaceContainer

Overrides

SurfaceContainer.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

SurfaceContainer.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

SurfaceContainer.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

colorProfile

colorProfile: string;

colorSpace

colorSpace: ColorSpace;

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Overrides

SurfaceContainer.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

SurfaceContainer.toString

---

LimitedColorContainer

Extends

• SurfaceContainer

Constructors

Constructor

new LimitedColorContainer(initialItems?, name?): LimitedColorContainer;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

LimitedColorContainer

Overrides

SurfaceContainer.constructor

Properties

constraints

constraints: ContainerConstraints;

Inherited from

SurfaceContainer.constraints

id

id: string;

Inherited from

SurfaceContainer.id

maxColorNumber

maxColorNumber: number;

paletteUId

paletteUId: string;

parentComponent

parentComponent: ModelComponent = null;

Inherited from

SurfaceContainer.parentComponent

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

Inherited from

SurfaceContainer.printingTechniqueConstraints

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

SurfaceContainer.renderingGroupName

translationKey

translationKey: string;

Inherited from

SurfaceContainer.translationKey

type

readonly type: string = LimitedColorContainer.type;

Overrides

SurfaceContainer.type

type

static type: string = "LimitedColorContainer";

Overrides

SurfaceContainer.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

SurfaceContainer.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

SurfaceContainer.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

SurfaceContainer.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Overrides

SurfaceContainer.renderingType

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

SurfaceContainer.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

SurfaceContainer.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.addPropertyChanged

clone()

clone(generateNewIds?): SurfaceContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

SurfaceContainer

Overrides

SurfaceContainer.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

SurfaceContainer.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

SurfaceContainer.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

maxColorNumber

maxColorNumber: number;

paletteUId

paletteUId: string;

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Overrides

SurfaceContainer.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

SurfaceContainer.toString

---

MockupContainer

Extends

• Container

Constructors

Constructor

new MockupContainer(initialItems?, name?): MockupContainer;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

MockupContainer

Overrides

Container.constructor

Properties

id

id: string;

Inherited from

Container.id

noPrint

noPrint: boolean = false;

noShow

noShow: boolean = false;

parentComponent

parentComponent: ModelComponent = null;

Inherited from

Container.parentComponent

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

Container.renderingGroupName

size

size: SizeF = null;

translationKey

translationKey: string;

Inherited from

Container.translationKey

type

readonly type: string = Container.type;

Inherited from

Container.type

type

static type: string = "Container";

Inherited from

Container.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

Container.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Container.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

Container.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

Container.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

Container.renderingType

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

Container.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

Container.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Container.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Container.addPropertyChanged

clone()

clone(generateNewIds?): MockupContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

MockupContainer

Overrides

Container.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

Container.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

Container.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): Object;

Returns

Object

Inherited from

Container.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Container.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

Container.toString

---

SpotColorContainer

Extends

• SurfaceContainer

Constructors

Constructor

new SpotColorContainer(): SpotColorContainer;

Returns

SpotColorContainer

Overrides

SurfaceContainer.constructor

Properties

constraints

constraints: ContainerConstraints;

Inherited from

SurfaceContainer.constraints

id

id: string;

Inherited from

SurfaceContainer.id

outputColor

outputColor: Color;

parentComponent

parentComponent: ModelComponent = null;

Inherited from

SurfaceContainer.parentComponent

previewColor

previewColor: RgbColor;

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

Inherited from

SurfaceContainer.printingTechniqueConstraints

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

SurfaceContainer.renderingGroupName

translationKey

translationKey: string;

Inherited from

SurfaceContainer.translationKey

type

readonly type: string = SpotColorContainer.type;

Overrides

SurfaceContainer.type

type

static type: string = "SpotColorContainer";

Overrides

SurfaceContainer.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

SurfaceContainer.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

SurfaceContainer.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

SurfaceContainer.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Overrides

SurfaceContainer.renderingType

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

SurfaceContainer.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

SurfaceContainer.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.addPropertyChanged

clone()

clone(generateNewIds?): SpotColorContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

SpotColorContainer

Overrides

SurfaceContainer.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

SurfaceContainer.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

SurfaceContainer.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Inherited from

SurfaceContainer.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

SurfaceContainer.toString

---

SurfaceContainer

Extends

• Container

Extended by

• ColorLessContainer
• LimitedColorContainer
• FullColorContainer
• SpotColorContainer
• TextureContainer

Constructors

Constructor

new SurfaceContainer(initialItems?, name?): SurfaceContainer;

Parameters

Parameter	Type
initialItems?	BaseItem[]
name?	string

Returns

SurfaceContainer

Overrides

Container.constructor

Properties

constraints

constraints: ContainerConstraints;

id

id: string;

Inherited from

Container.id

parentComponent

parentComponent: ModelComponent = null;

Inherited from

Container.parentComponent

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

Container.renderingGroupName

translationKey

translationKey: string;

Inherited from

Container.translationKey

type

readonly type: string = SurfaceContainer.type;

Overrides

Container.type

type

static type: string = "SurfaceContainer";

Overrides

Container.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

Container.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Container.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

Container.name

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

Container.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

Container.renderingType

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

Container.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

Container.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Container.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Container.addPropertyChanged

clone()

clone(generateNewIds?): SurfaceContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

SurfaceContainer

Overrides

Container.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

Container.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

Container.generateNewIds

getSimplifiedObject()

getSimplifiedObject(): object;

Returns

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Overrides

Container.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Container.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

Container.toString

---

TextureContainer

Extends

• SurfaceContainer

Constructors

Constructor

new TextureContainer(): TextureContainer;

Returns

TextureContainer

Overrides

SurfaceContainer.constructor

Properties

constraints

constraints: ContainerConstraints;

Inherited from

SurfaceContainer.constraints

id

id: string;

Inherited from

SurfaceContainer.id

outputColor

outputColor: Color;

parentComponent

parentComponent: ModelComponent = null;

Inherited from

SurfaceContainer.parentComponent

previewTextureName

previewTextureName: string;

previewTextureSource

previewTextureSource: ImageSource;

printingTechniqueConstraints

printingTechniqueConstraints: PrintingTechniqueConstraints;

Inherited from

SurfaceContainer.printingTechniqueConstraints

renderingGroupName?

optional renderingGroupName?: string;

Inherited from

SurfaceContainer.renderingGroupName

translationKey

translationKey: string;

Inherited from

SurfaceContainer.translationKey

type

readonly type: string = TextureContainer.type;

Overrides

SurfaceContainer.type

type

static type: string = "TextureContainer";

Overrides

SurfaceContainer.type

Accessors

items

Get Signature

get items(): Collection<BaseItem>;

Returns

Collection<BaseItem>

Inherited from

SurfaceContainer.items

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.locked

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

SurfaceContainer.name

previewTextureSource

Get Signature

get previewTextureSource(): ImageSource;

Returns

ImageSource

Set Signature

set previewTextureSource(previewTextureSource): void;

Parameters

Parameter	Type
previewTextureSource	ImageSource

Returns

void

region

Get Signature

get region(): RectangleF;

Returns

RectangleF

Set Signature

set region(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

SurfaceContainer.region

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Overrides

SurfaceContainer.renderingType

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

SurfaceContainer.tags

version

Get Signature

get version(): string;

Returns

string

Inherited from

SurfaceContainer.version

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

SurfaceContainer.visible

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.addPropertyChanged

clone()

clone(generateNewIds?): TextureContainer;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false

Returns

TextureContainer

Overrides

SurfaceContainer.clone

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	ModelComponent

Returns

boolean

Inherited from

SurfaceContainer.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

SurfaceContainer.generateNewIds

getSimplifiedObject()

getSimplifiedObject(omitProperties?): object;

Parameters

Parameter	Type
omitProperties?	string | string[]

Returns

constraints

constraints: object;

constraints.maxArtworkSize

maxArtworkSize: object;

constraints.maxArtworkSize.height

height: number;

constraints.maxArtworkSize.shapeType

shapeType: ArtworkShapeType;

constraints.maxArtworkSize.width

width: number;

constructor

constructor: Function;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

printingTechniqueConstraints

printingTechniqueConstraints: object;

printingTechniqueConstraints.allowRasterElements

allowRasterElements: boolean;

printingTechniqueConstraints.minFontSize

minFontSize: number;

printingTechniqueConstraints.minWidth

minWidth: number;

printingTechniqueConstraints.targetDpi

targetDpi: number;

hasOwnProperty()

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()

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()

propertyIsEnumerable(v): boolean;

Determines whether a specified property is enumerable.

Parameters

Parameter	Type	Description
v	PropertyKey	A property name.

Returns

boolean

toLocaleString()

toLocaleString(): string;

Returns a date converted to a string using the current locale.

Returns

string

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

valueOf()

valueOf(): Object;

Returns the primitive value of the specified object.

Returns

Object

Overrides

SurfaceContainer.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

SurfaceContainer.removePropertyChanged

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

SurfaceContainer.toString