Class ImageItemHandler

Inheritance

ItemHandler

BaseRectangleItemHandler

ShapeItemHandler

RectangleItemHandler

ContentItemHandler

ImageItemHandler

Package: @aurigma/design-atoms

Constructors

(constructor)(item, textWhizz, apiClient, colorPreviewService, options)

Constructs a new instance of the ImageItemHandler class

Declaration

constructor(item?: ImageItem, textWhizz?: typeof TextWhizz, apiClient?: IDesignAtomsApiClient, colorPreviewService?: IListenableColorPreviewService, options?: IPlaceholderHandlerOptions);

Parameters

Type	Name	Description
ImageItem	item
typeof TextWhizz	textWhizz
IDesignAtomsApiClient	apiClient
IListenableColorPreviewService	colorPreviewService
IPlaceholderHandlerOptions	options

Properties

_actualSize

Declaration

protected _actualSize: boolean;

Property Value

Type	Description
boolean

_imageResizedEvent

Declaration

protected _imageResizedEvent: EventWithSenderArg<this, IImageResizedData>;

Property Value

Type	Description
EventWithSenderArg<this, IImageResizedData>

_qualityChangeContainer

Declaration

protected _qualityChangeContainer: HTMLElement;

Property Value

Type	Description
HTMLElement

_qualityChangeInfoBar

Declaration

protected _qualityChangeInfoBar: HTMLElement;

Property Value

Type	Description
HTMLElement

_qualityChangeScaleBar

Declaration

protected _qualityChangeScaleBar: HTMLElement;

Property Value

Type	Description
HTMLElement

_saveAspectRatio

Declaration

protected _saveAspectRatio: boolean;

Property Value

Type	Description
boolean

_sourceUrl

Declaration

protected _sourceUrl: string;

Property Value

Type	Description
string

_takeIntoAccountImageDpi

Declaration

protected _takeIntoAccountImageDpi: boolean;

Property Value

Type	Description
boolean

isQualityChangeBarEmpty

Declaration

get isQualityChangeBarEmpty(): boolean;

Property Value

Type	Description
boolean

item

Declaration

get item(): ImageItem;

set item(item: ImageItem);

Property Value

Type	Description
ImageItem

needToDownloadImage

Declaration

get needToDownloadImage(): boolean;

set needToDownloadImage(v: boolean);

Property Value

Type	Description
boolean

qualityChangeContainer

Declaration

get qualityChangeContainer(): HTMLElement;

set qualityChangeContainer(v: HTMLElement);

Property Value

Type	Description
HTMLElement

qualityChangeInfoBar

Declaration

get qualityChangeInfoBar(): HTMLElement;

set qualityChangeInfoBar(v: HTMLElement);

Property Value

Type	Description
HTMLElement

qualityChangeScaleBar

Declaration

get qualityChangeScaleBar(): HTMLElement;

set qualityChangeScaleBar(v: HTMLElement);

Property Value

Type	Description
HTMLElement

sourceImageHorizontalResolution

Declaration

get sourceImageHorizontalResolution(): number;

set sourceImageHorizontalResolution(value: number);

Property Value

Type	Description
number

sourceImageVerticalResolution

Declaration

get sourceImageVerticalResolution(): number;

set sourceImageVerticalResolution(value: number);

Property Value

Type	Description
number

takeIntoAccountImageDpi

Declaration

get takeIntoAccountImageDpi(): boolean;

set takeIntoAccountImageDpi(v: boolean);

Property Value

Type	Description
boolean

typeName

Declaration

static readonly typeName: string;

Property Value

Type	Description
string

Methods

_createDataInstance(itemHandler)

Declaration

protected _createDataInstance(itemHandler?: ImageItemHandler): ImageHandlerData;

Parameters

Type	Name	Description
ImageItemHandler	itemHandler

Returns

Type	Description
ImageHandlerData

_createImageUrl()

Declaration

protected _createImageUrl(): string;

Returns

Type	Description
string

_getDefaultPermissions()

Declaration

protected _getDefaultPermissions(): IPermissions;

Returns

Type	Description
IPermissions

_getDrawingFillColor()

Declaration

protected _getDrawingFillColor(): Color;

Returns

Type	Description
Color

_onItemPropertyChanged(sender, propertyName)

Declaration

protected _onItemPropertyChanged(sender: ImageItem, propertyName: string): void;

Parameters

Type	Name	Description
ImageItem	sender
string	propertyName

Returns

Type	Description
void

_setDataItem(item, itemHandlerData)

Declaration

protected _setDataItem(item: ImageItem, itemHandlerData: any): void;

Parameters

Type	Name	Description
ImageItem	item
any	itemHandlerData

Returns

Type	Description
void

_updateImageUrl()

Declaration

protected _updateImageUrl(): void;

Returns

Type	Description
void

_updateImpl(beforeUpdate, afterUpdate)

Declaration

protected _updateImpl(beforeUpdate?: Function, afterUpdate?: Function): Promise<void>;

Parameters

Type	Name	Description
Function	beforeUpdate
Function	afterUpdate

Returns

Type	Description
Promise<void>

addImageResized(handler)

Declaration

addImageResized(handler: (sender?: ImageItemHandler, data?: IImageResizedData) => any): void;

Parameters

Type	Name	Description
(sender?: ImageItemHandler, data?: IImageResizedData) => any	handler

Returns

Type	Description
void

loadImage(sourceUrl, options)

Loads an image from the external source using the specified parameters.

Declaration

loadImage(sourceUrl: string, options?: ImageLoadOptions): Promise<string>;

Parameters

Type	Name	Description
string	sourceUrl	The URL to load image from.
ImageLoadOptions	options

Returns

Type	Description
Promise<string>	storage id of loaded image

loadImageFromRemoteUrl(remoteUrl, appDomainUrl)

Declaration

loadImageFromRemoteUrl(remoteUrl: string, appDomainUrl?: string): Promise<void>;

Parameters

Type	Name	Description
string	remoteUrl
string	appDomainUrl

Returns

Type	Description
Promise<void>

onResized()

Declaration

onResized(): boolean;

Returns

Type	Description
boolean

removeImageResized(handler)

Declaration

removeImageResized(handler: (sender?: ImageItemHandler, data?: IImageResizedData) => any): void;

Parameters

Type	Name	Description
(sender?: ImageItemHandler, data?: IImageResizedData) => any	handler

Returns

Type	Description
void

setBadToGoodChangeScaleBarClass()

Declaration

setBadToGoodChangeScaleBarClass(): void;

Returns

Type	Description
void

setBadToWarningChangeScaleBarClass()

Declaration

setBadToWarningChangeScaleBarClass(): void;

Returns

Type	Description
void

setQualityChangeInfoBarText(value)

Declaration

setQualityChangeInfoBarText(value: string): void;

Parameters

Type	Name	Description
string	value

Returns

Type	Description
void

setQualityChangeScaleBarWidth(progress)

Declaration

setQualityChangeScaleBarWidth(progress: number): void;

Parameters

Type	Name	Description
number	progress

Returns

Type	Description
void

setWarningToGoodChangeScaleBarClass()

Declaration

setWarningToGoodChangeScaleBarClass(): void;

Returns

Type	Description
void

showEditButton()

Declaration

showEditButton(): boolean;

Returns

Type	Description
boolean

updateRectangle(keepLocation, resizeMode, parentPlaceholder, hiResOutputDpi)

Declaration

updateRectangle(keepLocation?: boolean, resizeMode?: ResizeMode, parentPlaceholder?: PlaceholderItemHandler, hiResOutputDpi?: number): void;

Parameters

Type	Name	Description
boolean	keepLocation
ResizeMode	resizeMode
PlaceholderItemHandler	parentPlaceholder
number	hiResOutputDpi

Returns

Type	Description
void