Class LayoutItem

Inheritance

ModelComponent

BaseItem

Item

GroupItem

LayoutItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(items, layoutSettings)

Constructs a new instance of the LayoutItem class

Declaration

constructor(items?: Item[], layoutSettings?: DefaultLayoutSettings);

Parameters

Type	Name	Description
Item[]	items
DefaultLayoutSettings	layoutSettings

Properties

layoutSettings

Declaration

get layoutSettings(): DefaultLayoutSettings;

set layoutSettings(value: DefaultLayoutSettings);

Property Value

Type	Description
DefaultLayoutSettings

sourceRectangle

Declaration

get sourceRectangle(): RectangleF;

set sourceRectangle(value: RectangleF);

Property Value

Type	Description
RectangleF

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

Methods

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
LayoutItem	source
LayoutItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_copyItemsOrder(source, destination)

Declaration

protected _copyItemsOrder(source: LayoutItem, destination: LayoutItem): void;

Parameters

Type	Name	Description
LayoutItem	source
LayoutItem	destination

Returns

Type	Description
void

addItem(item, targetIndex, orderIndex)

Declaration

addItem(item: Item, targetIndex?: number, orderIndex?: number): void;

Parameters

Type	Name	Description
Item	item
number	targetIndex
number	orderIndex

Returns

Type	Description
void

addItems(items, targetIndex, orderIndex)

Declaration

addItems(items: Item[], targetIndex?: number, orderIndex?: number): void;

Parameters

Type	Name	Description
Item[]	items
number	targetIndex
number	orderIndex

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
LayoutItem

equals(other)

Declaration

equals(other: LayoutItem): boolean;

Parameters

Type	Name	Description
LayoutItem	other

Returns

Type	Description
boolean

generateAutoLayoutSettings(rectangles, alignItems, orientation, margin, justifyContent)

Declaration

static generateAutoLayoutSettings(rectangles: RectangleF[], alignItems?: AutoLayoutAlignItems, orientation?: AutoLayoutOrientation, margin?: number, justifyContent?: AutoLayoutJustifyContent): AutoLayoutSettings;

Parameters

Type	Name	Description
RectangleF[]	rectangles
AutoLayoutAlignItems	alignItems
AutoLayoutOrientation	orientation
number	margin
AutoLayoutJustifyContent	justifyContent

Returns

Type	Description
AutoLayoutSettings

getItemOrderIndex(item)

Declaration

getItemOrderIndex(item: Item): number;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
number

getItemsOrder()

Declaration

getItemsOrder(): string[];

Returns

Type	Description
string[]

getSimplifiedObject(omitProperties)

Declaration

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

Parameters

Type	Name	Description
string[] | string	omitProperties

Returns

Type	Description
Object

getSortedItems()

Declaration

getSortedItems(): Item[];

Returns

Type	Description
Item[]

isChildVisible(item)

Declaration

isChildVisible(item: Item): boolean;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
boolean

removeItems(items)

Declaration

removeItems(items: Item[]): void;

Parameters

Type	Name	Description
Item[]	items

Returns

Type	Description
void

setItemsOrder(ids)

Declaration

setItemsOrder(ids: string[]): void;

Parameters

Type	Name	Description
string[]	ids

Returns

Type	Description
void