Class ImageItem

Inheritance

ModelComponent

BaseItem

Item

ShapeItem

RectangleItem

ContentItem

ImageItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(sourceStorageId, location, width, height, ratioWidthToHeight)

Constructs a new instance of the ImageItem class

Declaration

constructor(sourceStorageId?: string, location?: PointF, width?: number, height?: number, ratioWidthToHeight?: number);

Parameters

Type	Name	Description
string	sourceStorageId
PointF	location
number	width
number	height
number	ratioWidthToHeight

Properties

allowedSubfolder

Declaration

allowedSubfolder: string;

Property Value

Type	Description
string

allowedTabs

Declaration

allowedTabs: string[];

Property Value

Type	Description
string[]

displayName

Declaration

get displayName(): string;

set displayName(value: string);

Property Value

Type	Description
string

effect

Declaration

get effect(): ImageEffect;

set effect(value: ImageEffect);

Property Value

Type	Description
ImageEffect

imagePermissions

Declaration

get imagePermissions(): ImagePermissions;

set imagePermissions(value: ImagePermissions);

Property Value

Type	Description
ImagePermissions

isUserImage

Declaration

isUserImage: boolean;

Property Value

Type	Description
boolean

mviKeepTemplateTransform

Declaration

mviKeepTemplateTransform: boolean;

Property Value

Type	Description
boolean

ndEffects

Declaration

ndEffects: NDEffects;

Property Value

Type	Description
NDEffects

originalImageSource

Declaration

originalImageSource: ImageItem.ImageSource;

Property Value

Type	Description
ImageSource

overlayEffect

Declaration

get overlayEffect(): OverlayEffect;

set overlayEffect(value: OverlayEffect);

Property Value

Type	Description
OverlayEffect

ratioWidthToHeight

Declaration

ratioWidthToHeight: number;

Property Value

Type	Description
number

source

Declaration

get source(): ImageItem.ImageSource;

set source(value: ImageItem.ImageSource);

Property Value

Type	Description
ImageSource

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

unconvertedSource

Declaration

unconvertedSource: ImageItem.ImageSource;

Property Value

Type	Description
ImageSource

values

Declaration

values: ImageItem.ImageItemValue[];

Property Value

Type	Description
ImageItem.ImageItemValue[]

violationSettings

Declaration

get violationSettings(): ImageViolationSettings;

set violationSettings(value: ImageViolationSettings);

Property Value

Type	Description
ImageViolationSettings

Methods

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
ImageItem	source
ImageItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_setViolationSettings(value, skipTypeCheck)

Declaration

protected _setViolationSettings(value: ImageViolationSettings, skipTypeCheck?: boolean): void;

Parameters

Type	Name	Description
ImageViolationSettings	value
boolean	skipTypeCheck

Returns

Type	Description
void

applyPermissionsConstrain()

Declaration

applyPermissionsConstrain(): void;

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

clone(generateNewIds?: boolean, appropriateParentContainer?: boolean): ImageItem;

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
ImageItem

equals(other)

Declaration

equals(other: ImageItem): boolean;

Parameters

Type	Name	Description
ImageItem	other

Returns

Type	Description
boolean

getOriginalImageSize()

Declaration

getOriginalImageSize(): ISize;

Returns

Type	Description
ISize

getSimplifiedObject(omitProperties)

Declaration

getSimplifiedObject(omitProperties?: string[] | string): Object;

Parameters

Type	Name	Description
string[] | string	omitProperties

Returns

Type	Description
Object

getSource()

Declaration

getSource(): string;

Returns

Type	Description
string

SetHeight(value, calculateWidth)

Declaration

SetHeight(value: number, calculateWidth?: boolean): void;

Parameters

Type	Name	Description
number	value
boolean	calculateWidth

Returns

Type	Description
void

SetWidth(value, calculateHeight)

Declaration

SetWidth(value: number, calculateHeight?: boolean): void;

Parameters

Type	Name	Description
number	value
boolean	calculateHeight

Returns

Type	Description
void