ImageItem

Namespaces

• ImageItem

Classes

ImageItem

Extends

• ContentItem

Constructors

Constructor

new ImageItem(
   sourceStorageId?, 
   location?, 
   width?, 
   height?, 
   ratioWidthToHeight?): ImageItem;

Parameters

Parameter	Type
sourceStorageId?	string
location?	PointF
width?	number
height?	number
ratioWidthToHeight?	number

Returns

ImageItem

Overrides

ContentItem.constructor

Properties

allowedSubfolder

allowedSubfolder: string = null;

allowedTabs

allowedTabs: string[] = null;

containerName

containerName: string;

Inherited from

ContentItem.containerName

id

id: string;

Inherited from

ContentItem.id

isUserImage

isUserImage: boolean = false;

mviKeepTemplateTransform

mviKeepTemplateTransform: boolean = false;

ndEffects

ndEffects: NDEffects;

originalImageSource

originalImageSource: ImageSource;

ratioWidthToHeight

ratioWidthToHeight: number = null;

sourcePathId

sourcePathId: string = null;

Inherited from

ContentItem.sourcePathId

sourcePathLoaded

sourcePathLoaded: boolean = false;

Inherited from

ContentItem.sourcePathLoaded

themeBinding

themeBinding: ThemeBinding;

Inherited from

ContentItem.themeBinding

type

type: string = ImageItem.type;

Overrides

ContentItem.type

unconvertedSource

unconvertedSource: ImageSource = null;

values

values: ImageItemValue[] = [];

type

static type: string = "ImageItem";

Overrides

ContentItem.type

Accessors

altBorderColor

Get Signature

get altBorderColor(): Color;

Returns

Color

Set Signature

set altBorderColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

ContentItem.altBorderColor

blendMode

Get Signature

get blendMode(): BlendMode;

Returns

BlendMode

Set Signature

set blendMode(value): void;

Parameters

Parameter	Type
value	BlendMode

Returns

void

Inherited from

ContentItem.blendMode

borderColor

Get Signature

get borderColor(): Color;

Returns

Color

Set Signature

set borderColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

ContentItem.borderColor

borderWidth

Get Signature

get borderWidth(): number;

Returns

number

Set Signature

set borderWidth(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

ContentItem.borderWidth

class

Get Signature

get class(): string;

Returns

string

Set Signature

set class(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

ContentItem.class

dash

Get Signature

get dash(): number[];

Returns

number[]

Set Signature

set dash(value): void;

Parameters

Parameter	Type
value	number[]

Returns

void

Inherited from

ContentItem.dash

displayName

Get Signature

get displayName(): string;

Returns

string

Set Signature

set displayName(value): void;

Parameters

Parameter	Type
value	string

Returns

void

effect

Get Signature

get effect(): ImageEffect;

Returns

ImageEffect

Set Signature

set effect(value): void;

Parameters

Parameter	Type
value	ImageEffect

Returns

void

fillColor

Get Signature

get fillColor(): Color;

Returns

Color

Set Signature

set fillColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

ContentItem.fillColor

fixedBorderWidth

Get Signature

get fixedBorderWidth(): boolean;

Returns

boolean

Set Signature

set fixedBorderWidth(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.fixedBorderWidth

fromLayout

Get Signature

get fromLayout(): boolean;

Returns

boolean

Set Signature

set fromLayout(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.fromLayout

frontendPermissions

Get Signature

get frontendPermissions(): FrontendPermissions;

Returns

FrontendPermissions

Set Signature

set frontendPermissions(value): void;

Parameters

Parameter	Type
value	FrontendPermissions

Returns

void

Inherited from

ContentItem.frontendPermissions

imagePermissions

Get Signature

get imagePermissions(): ImagePermissions;

Returns

ImagePermissions

Set Signature

set imagePermissions(value): void;

Parameters

Parameter	Type
value	ImagePermissions

Returns

void

isRenderTypeIsNormal

Get Signature

get isRenderTypeIsNormal(): boolean;

Returns

boolean

Inherited from

ContentItem.isRenderTypeIsNormal

isVariable

Get Signature

get isVariable(): boolean;

Returns

boolean

Set Signature

set isVariable(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.isVariable

itemPermissions

Get Signature

get itemPermissions(): ItemPermissions;

Returns

ItemPermissions

Set Signature

set itemPermissions(value): void;

Parameters

Parameter	Type
value	ItemPermissions

Returns

void

Inherited from

ContentItem.itemPermissions

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.locked

manipulationPermissions

Get Signature

get manipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set manipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

Inherited from

ContentItem.manipulationPermissions

mask

Get Signature

get mask(): ItemMask;

Returns

ItemMask

Set Signature

set mask(value): void;

Parameters

Parameter	Type
value	ItemMask

Returns

void

Inherited from

ContentItem.mask

maskOpacity

Get Signature

get maskOpacity(): number;

Returns

number

Set Signature

set maskOpacity(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

ContentItem.maskOpacity

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

ContentItem.name

opacity

Get Signature

get opacity(): number;

Returns

number

Set Signature

set opacity(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

ContentItem.opacity

overlayEffect

Get Signature

get overlayEffect(): OverlayEffect;

Returns

OverlayEffect

Set Signature

set overlayEffect(value): void;

Parameters

Parameter	Type
value	OverlayEffect

Returns

void

overprintFill

Get Signature

get overprintFill(): boolean;

Returns

boolean

Set Signature

set overprintFill(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.overprintFill

overprintStroke

Get Signature

get overprintStroke(): boolean;

Returns

boolean

Set Signature

set overprintStroke(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.overprintStroke

parentContainer

Get Signature

get parentContainer(): Container;

Returns

Container

Set Signature

set parentContainer(value): void;

Parameters

Parameter	Type
value	Container

Returns

void

Inherited from

ContentItem.parentContainer

parentGroupItem

Get Signature

get parentGroupItem(): GroupItem;

Returns

GroupItem

Set Signature

set parentGroupItem(value): void;

Parameters

Parameter	Type
value	GroupItem

Returns

void

Inherited from

ContentItem.parentGroupItem

parentPlaceholder

Get Signature

get parentPlaceholder(): PlaceholderItem;

Returns

PlaceholderItem

Set Signature

set parentPlaceholder(value): void;

Parameters

Parameter	Type
value	PlaceholderItem

Returns

void

Inherited from

ContentItem.parentPlaceholder

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

ContentItem.renderingType

shapePermissions

Get Signature

get shapePermissions(): ShapePermissions;

Returns

ShapePermissions

Set Signature

set shapePermissions(value): void;

Parameters

Parameter	Type
value	ShapePermissions

Returns

void

Inherited from

ContentItem.shapePermissions

source

Get Signature

get source(): ImageSource;

Returns

ImageSource

Set Signature

set source(value): void;

Parameters

Parameter	Type
value	ImageSource

Returns

void

sourcePath

Get Signature

get sourcePath(): Path;

Returns

Path

Set Signature

set sourcePath(value): void;

Parameters

Parameter	Type
value	Path

Returns

void

Inherited from

ContentItem.sourcePath

sourceRectangle

Get Signature

get sourceRectangle(): RectangleF;

Returns

RectangleF

Set Signature

set sourceRectangle(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

ContentItem.sourceRectangle

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

ContentItem.tags

textWrappingMode

Get Signature

get textWrappingMode(): WrappingMode;

Returns

WrappingMode

Set Signature

set textWrappingMode(value): void;

Parameters

Parameter	Type
value	WrappingMode

Returns

void

Inherited from

ContentItem.textWrappingMode

transform

Get Signature

get transform(): Transform;

Returns

Transform

Set Signature

set transform(value): void;

Parameters

Parameter	Type
value	Transform

Returns

void

Inherited from

ContentItem.transform

version

Get Signature

get version(): string;

Returns

string

Inherited from

ContentItem.version

violationSettings

Get Signature

get violationSettings(): ImageViolationSettings;

Returns

ImageViolationSettings

Set Signature

set violationSettings(value): void;

Parameters

Parameter	Type
value	ImageViolationSettings

Returns

void

Overrides

ContentItem.violationSettings

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ContentItem.visible

visualizationPermissions

Get Signature

get visualizationPermissions(): VisualizationPermissions;

Returns

VisualizationPermissions

Set Signature

set visualizationPermissions(value): void;

Parameters

Parameter	Type
value	VisualizationPermissions

Returns

void

Inherited from

ContentItem.visualizationPermissions

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

ContentItem.addPropertyChanged

applyPermissionsConstrain()

applyPermissionsConstrain(): void;

Returns

void

Overrides

ContentItem.applyPermissionsConstrain

canSetIsVariable()

canSetIsVariable(): boolean;

Returns

boolean

Inherited from

ContentItem.canSetIsVariable

clone()

clone(generateNewIds?, appropriateParentContainer?): ImageItem;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false
appropriateParentContainer	boolean	false

Returns

ImageItem

Overrides

ContentItem.clone

copyTo()

copyTo(destination): void;

Parameters

Parameter	Type
destination	BaseItem

Returns

void

Inherited from

ContentItem.copyTo

equals()

equals(other): any;

Parameters

Parameter	Type
other	ImageItem

Returns

any

Overrides

ContentItem.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

ContentItem.generateNewIds

getItemChangedEvent()

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

EventWithAutoSenderArg<Item, Item>

Inherited from

ContentItem.getItemChangedEvent

getItemChangingEvent()

getItemChangingEvent(): EventObject<Item>;

Returns

EventObject<Item>

Inherited from

ContentItem.getItemChangingEvent

getOriginalImageSize()

getOriginalImageSize(): ISize;

Returns

ISize

getPathLoadedEvent()

getPathLoadedEvent(): EventObject<unknown>;

Returns

EventObject<unknown>

Inherited from

ContentItem.getPathLoadedEvent

getSimplifiedObject()

getSimplifiedObject(omitProperties?): Object;

Parameters

Parameter	Type
omitProperties?	string | string[]

Returns

Object

Overrides

ContentItem.getSimplifiedObject

getSource()

getSource(): string;

Returns

string

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

ContentItem.removePropertyChanged

SetHeight()

SetHeight(value, calculateWidth?): void;

Parameters

Parameter	Type
value	number
calculateWidth?	boolean

Returns

void

setTransform()

setTransform(value, suppressOnChanged?): void;

Parameters

Parameter	Type	Default value
value	Transform	undefined
suppressOnChanged	boolean	false

Returns

void

Inherited from

ContentItem.setTransform

SetWidth()

SetWidth(value, calculateHeight?): void;

Parameters

Parameter	Type
value	number
calculateHeight?	boolean

Returns

void

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

ContentItem.toString

update()

update(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

Inherited from

ContentItem.update