Class PlaceholderItem

Inheritance

ModelComponent

BaseItem

Item

ShapeItem

PlaceholderItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(sourceRec)

Constructs a new instance of the PlaceholderItem class

Declaration

constructor(sourceRec?: RectangleF);

Parameters

Type	Name	Description
RectangleF	sourceRec

Properties

allowedSubfolder

Declaration

allowedSubfolder: string;

Property Value

Type	Description
string

allowedTabs

Declaration

allowedTabs: string[];

Property Value

Type	Description
string[]

barcodeFormat

Declaration

barcodeFormat: BarcodeFormat;

Property Value

Type	Description
BarcodeFormat

bottomFrames

Declaration

get bottomFrames(): ContentItem[];

set bottomFrames(value: ContentItem[]);

Property Value

Type	Description
ContentItem[]

content

Declaration

get content(): ContentItem;

set content(value: ContentItem);

Property Value

Type	Description
ContentItem

contentEffect

Declaration

get contentEffect(): number;

set contentEffect(value: number);

Property Value

Type	Description
number

contentFillColor

Declaration

get contentFillColor(): Color;

set contentFillColor(value: Color);

Property Value

Type	Description
Color

contentHorizontalAlignment

Declaration

contentHorizontalAlignment: HorizontalContentAlignment;

Property Value

Type	Description
HorizontalContentAlignment

contentOverlayEffect

Declaration

get contentOverlayEffect(): OverlayEffect;

set contentOverlayEffect(value: OverlayEffect);

Property Value

Type	Description
OverlayEffect

contentPermissions

Declaration

get contentPermissions(): ContentPermissions;

set contentPermissions(value: ContentPermissions);

Property Value

Type	Description
ContentPermissions

contentResizeMode

Declaration

get contentResizeMode(): ResizeMode.Fit | ResizeMode.Fit | ResizeMode;

set contentResizeMode(value: ResizeMode);

Property Value

Type	Description
ResizeMode.Fit | ResizeMode.Fit | ResizeMode

contentVerticalAlignment

Declaration

contentVerticalAlignment: VerticalContentAlignment;

Property Value

Type	Description
VerticalContentAlignment

fixedStubContentSize

Declaration

fixedStubContentSize: boolean;

Property Value

Type	Description
boolean

imageContent

Declaration

get imageContent(): ImageItem;

Property Value

Type	Description
ImageItem

isBarcodePlaceholder

Declaration

get isBarcodePlaceholder(): boolean;

Property Value

Type	Description
boolean

isCoverMode

Declaration

get isCoverMode(): boolean;

set isCoverMode(value: boolean);

Property Value

Type	Description
boolean

isEmptyContent

Declaration

get isEmptyContent(): boolean;

Property Value

Type	Description
boolean

isFrame

Declaration

get isFrame(): boolean;

Property Value

Type	Description
boolean

isStubContent

Declaration

get isStubContent(): boolean;

set isStubContent(value: boolean);

Property Value

Type	Description
boolean

isStubOrEmpty

Declaration

get isStubOrEmpty(): boolean;

Property Value

Type	Description
boolean

linkId

Declaration

linkId: string;

Property Value

Type	Description
string

placeholderPermissions

Declaration

get placeholderPermissions(): PlaceholderPermissions;

set placeholderPermissions(value: PlaceholderPermissions);

Property Value

Type	Description
PlaceholderPermissions

stubStorageMeta

Declaration

stubStorageMeta: ImageMetaData;

Property Value

Type	Description
ImageMetaData

topFrames

Declaration

get topFrames(): ContentItem[];

set topFrames(value: ContentItem[]);

Property Value

Type	Description
ContentItem[]

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

violationSettings

Declaration

get violationSettings(): ImageViolationSettings;

set violationSettings(value: ImageViolationSettings);

Property Value

Type	Description
ImageViolationSettings

Methods

_canSetIsVariable()

Declaration

protected _canSetIsVariable(): boolean;

Returns

Type	Description
boolean

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
PlaceholderItem	source
PlaceholderItem	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): PlaceholderItem;

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
PlaceholderItem

equals(other)

Declaration

equals(other: PlaceholderItem): boolean;

Parameters

Type	Name	Description
PlaceholderItem	other

Returns

Type	Description
boolean

getImagePermissions()

Declaration

getImagePermissions(): import("./ImagePermissions").ImagePermissions;

Returns

Type	Description
import("./ImagePermissions").ImagePermissions

getSimplifiedObject()

Declaration

getSimplifiedObject(): Object;

Returns

Type	Description
Object

updateContentAndFrames(func)

Declaration

updateContentAndFrames(func: (x: ContentItem) => void): void;

Parameters

Type	Name	Description
(x: ContentItem) => void	func

Returns

Type	Description
void