LayoutItem

Enumerations

AutoLayoutAlignItems

Enumeration Members

Enumeration Member	Value
center	1
end	3
none	0
start	2

---

AutoLayoutAnchorPoint

Enumeration Members

Enumeration Member	Value
center	1
end	2
start	0

---

AutoLayoutJustifyContent

Enumeration Members

Enumeration Member	Value
spaceBetween	1
stretch	0

---

AutoLayoutOrientation

Enumeration Members

Enumeration Member	Value
horizontal	1
vertical	0

---

LayoutType

Enumeration Members

Enumeration Member	Value
auto	1
default	0

Classes

AutoLayoutSettings

Extends

• DefaultLayoutSettings

Constructors

Constructor

new AutoLayoutSettings(): AutoLayoutSettings;

Returns

AutoLayoutSettings

Inherited from

DefaultLayoutSettings.constructor

Properties

propertyChanged

propertyChanged: EventObject<unknown>;

Inherited from

DefaultLayoutSettings.propertyChanged

type

type: string = AutoLayoutSettings.type;

Overrides

DefaultLayoutSettings.type

type

static type: string = "AutoLayoutSettings";

Overrides

DefaultLayoutSettings.type

Accessors

alignItems

Get Signature

get alignItems(): AutoLayoutAlignItems;

Returns

AutoLayoutAlignItems

Set Signature

set alignItems(value): void;

Parameters

Parameter	Type
value	AutoLayoutAlignItems

Returns

void

anchorPoint

Get Signature

get anchorPoint(): AutoLayoutAnchorPoint;

Returns

AutoLayoutAnchorPoint

Set Signature

set anchorPoint(value): void;

Parameters

Parameter	Type
value	AutoLayoutAnchorPoint

Returns

void

justifyContent

Get Signature

get justifyContent(): AutoLayoutJustifyContent;

Returns

AutoLayoutJustifyContent

Set Signature

set justifyContent(value): void;

Parameters

Parameter	Type
value	AutoLayoutJustifyContent

Returns

void

margin

Get Signature

get margin(): number;

Returns

number

Set Signature

set margin(value): void;

Parameters

Parameter	Type
value	number

Returns

void

orientation

Get Signature

get orientation(): AutoLayoutOrientation;

Returns

AutoLayoutOrientation

Set Signature

set orientation(value): void;

Parameters

Parameter	Type
value	AutoLayoutOrientation

Returns

void

Methods

clone()

clone(): AutoLayoutSettings;

Returns

AutoLayoutSettings

Overrides

DefaultLayoutSettings.clone

equals()

equals(other): any;

Parameters

Parameter	Type
other	AutoLayoutSettings

Returns

any

Overrides

DefaultLayoutSettings.equals

getSimplifiedObject()

getSimplifiedObject(): Object;

Returns

Object

Overrides

DefaultLayoutSettings.getSimplifiedObject

---

DefaultLayoutSettings

Extended by

• AutoLayoutSettings

Constructors

Constructor

new DefaultLayoutSettings(): DefaultLayoutSettings;

Returns

DefaultLayoutSettings

Properties

propertyChanged

propertyChanged: EventObject<unknown>;

type

type: string = DefaultLayoutSettings.type;

type

static type: string = "DefaultLayoutSettings";

Methods

clone()

clone(): DefaultLayoutSettings;

Returns

DefaultLayoutSettings

equals()

equals(other): any;

Parameters

Parameter	Type
other	DefaultLayoutSettings

Returns

any

getSimplifiedObject()

getSimplifiedObject(): Object;

Returns

Object

---

LayoutItem

Extends

• GroupItem

Constructors

Constructor

new LayoutItem(items?, layoutSettings?): LayoutItem;

Parameters

Parameter	Type
items?	Item[]
layoutSettings?	DefaultLayoutSettings

Returns

LayoutItem

Overrides

GroupItem.constructor

Properties

containerName

containerName: string;

Inherited from

GroupItem.containerName

id

id: string;

Inherited from

GroupItem.id

items

readonly items: Collection<Item>;

Inherited from

GroupItem.items

themeBinding

themeBinding: ThemeBinding;

Inherited from

GroupItem.themeBinding

type

type: string = LayoutItem.type;

Overrides

GroupItem.type

type

static type: string = "LayoutItem";

Overrides

GroupItem.type

Accessors

blendMode

Get Signature

get blendMode(): BlendMode;

Returns

BlendMode

Set Signature

set blendMode(value): void;

Parameters

Parameter	Type
value	BlendMode

Returns

void

Inherited from

GroupItem.blendMode

class

Get Signature

get class(): string;

Returns

string

Set Signature

set class(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

GroupItem.class

fromLayout

Get Signature

get fromLayout(): boolean;

Returns

boolean

Set Signature

set fromLayout(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

GroupItem.fromLayout

frontendPermissions

Get Signature

get frontendPermissions(): FrontendPermissions;

Returns

FrontendPermissions

Set Signature

set frontendPermissions(value): void;

Parameters

Parameter	Type
value	FrontendPermissions

Returns

void

Inherited from

GroupItem.frontendPermissions

groupItemPermissions

Get Signature

get groupItemPermissions(): GroupItemPermissions;

Returns

GroupItemPermissions

Set Signature

set groupItemPermissions(value): void;

Parameters

Parameter	Type
value	GroupItemPermissions

Returns

void

Inherited from

GroupItem.groupItemPermissions

groupManipulationPermissions

Get Signature

get groupManipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set groupManipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

Inherited from

GroupItem.groupManipulationPermissions

isRenderTypeIsNormal

Get Signature

get isRenderTypeIsNormal(): boolean;

Returns

boolean

Inherited from

GroupItem.isRenderTypeIsNormal

isVariable

Get Signature

get isVariable(): boolean;

Returns

boolean

Set Signature

set isVariable(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

GroupItem.isVariable

itemPermissions

Get Signature

get itemPermissions(): ItemPermissions;

Returns

ItemPermissions

Set Signature

set itemPermissions(value): void;

Parameters

Parameter	Type
value	ItemPermissions

Returns

void

Inherited from

GroupItem.itemPermissions

layoutSettings

Get Signature

get layoutSettings(): DefaultLayoutSettings;

Returns

DefaultLayoutSettings

Set Signature

set layoutSettings(value): void;

Parameters

Parameter	Type
value	DefaultLayoutSettings

Returns

void

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

GroupItem.locked

manipulationPermissions

Get Signature

get manipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set manipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

Inherited from

GroupItem.manipulationPermissions

mask

Get Signature

get mask(): ItemMask;

Returns

ItemMask

Set Signature

set mask(value): void;

Parameters

Parameter	Type
value	ItemMask

Returns

void

Inherited from

GroupItem.mask

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

GroupItem.name

opacity

Get Signature

get opacity(): number;

Returns

number

Set Signature

set opacity(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

GroupItem.opacity

parentContainer

Get Signature

get parentContainer(): Container;

Returns

Container

Set Signature

set parentContainer(value): void;

Parameters

Parameter	Type
value	Container

Returns

void

Inherited from

GroupItem.parentContainer

parentGroupItem

Get Signature

get parentGroupItem(): GroupItem;

Returns

GroupItem

Set Signature

set parentGroupItem(value): void;

Parameters

Parameter	Type
value	GroupItem

Returns

void

Inherited from

GroupItem.parentGroupItem

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

GroupItem.renderingType

sourceRectangle

Get Signature

get sourceRectangle(): RectangleF;

Returns

RectangleF

Set Signature

set sourceRectangle(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

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

GroupItem.tags

textWrappingMode

Get Signature

get textWrappingMode(): WrappingMode;

Returns

WrappingMode

Set Signature

set textWrappingMode(value): void;

Parameters

Parameter	Type
value	WrappingMode

Returns

void

Inherited from

GroupItem.textWrappingMode

transform

Get Signature

get transform(): Transform;

Returns

Transform

Set Signature

set transform(value): void;

Parameters

Parameter	Type
value	Transform

Returns

void

Inherited from

GroupItem.transform

version

Get Signature

get version(): string;

Returns

string

Inherited from

GroupItem.version

violationSettings

Get Signature

get violationSettings(): ViolationSettings;

Returns

ViolationSettings

Set Signature

set violationSettings(value): void;

Parameters

Parameter	Type
value	ViolationSettings

Returns

void

Inherited from

GroupItem.violationSettings

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

GroupItem.visible

visualizationPermissions

Get Signature

get visualizationPermissions(): VisualizationPermissions;

Returns

VisualizationPermissions

Set Signature

set visualizationPermissions(value): void;

Parameters

Parameter	Type
value	VisualizationPermissions

Returns

void

Inherited from

GroupItem.visualizationPermissions

Methods

addItem()

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

Parameters

Parameter	Type
item	Item
targetIndex?	number
orderIndex?	number

Returns

void

Overrides

GroupItem.addItem

addItems()

addItems(
   items, 
   targetIndex?, 
   orderIndex?): void;

Parameters

Parameter	Type
items	Item[]
targetIndex?	number
orderIndex?	number

Returns

void

Overrides

GroupItem.addItems

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

GroupItem.addPropertyChanged

applyPermissionsConstrain()

applyPermissionsConstrain(): void;

Returns

void

Inherited from

GroupItem.applyPermissionsConstrain

applyToItems()

applyToItems(func): void;

Parameters

Parameter	Type
func	(item) => any

Returns

void

Inherited from

GroupItem.applyToItems

canSetIsVariable()

canSetIsVariable(): boolean;

Returns

boolean

Inherited from

GroupItem.canSetIsVariable

clone()

clone(generateNewIds?, appropriateParentContainer?): LayoutItem;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false
appropriateParentContainer	boolean	false

Returns

LayoutItem

Overrides

GroupItem.clone

copyTo()

copyTo(destination): void;

Parameters

Parameter	Type
destination	BaseItem

Returns

void

Inherited from

GroupItem.copyTo

equals()

equals(other): any;

Parameters

Parameter	Type
other	LayoutItem

Returns

any

Overrides

GroupItem.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Overrides

GroupItem.generateNewIds

getItemChangedEvent()

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

EventWithAutoSenderArg<Item, Item>

Inherited from

GroupItem.getItemChangedEvent

getItemChangingEvent()

getItemChangingEvent(): EventObject<Item>;

Returns

EventObject<Item>

Inherited from

GroupItem.getItemChangingEvent

getItemOrderIndex()

getItemOrderIndex(item): number;

Parameters

Parameter	Type
item	Item

Returns

number

getItemsOrder()

getItemsOrder(): string[];

Returns

string[]

getNestedItems()

getNestedItems(excludeGroupItems?): Item[];

Parameters

Parameter	Type	Default value
excludeGroupItems	boolean	false

Returns

Item[]

Inherited from

GroupItem.getNestedItems

getSimplifiedObject()

getSimplifiedObject(omitProperties?): Object;

Parameters

Parameter	Type	Default value
omitProperties	string | string[]	[]

Returns

Object

Overrides

GroupItem.getSimplifiedObject

getSortedItems()

getSortedItems(): Item[];

Returns

Item[]

isChildVisible()

isChildVisible(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

Overrides

GroupItem.isChildVisible

onContainerChanged()

onContainerChanged(): void;

Returns

void

Inherited from

GroupItem.onContainerChanged

removeItems()

removeItems(items): void;

Parameters

Parameter	Type
items	Item[]

Returns

void

Overrides

GroupItem.removeItems

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

GroupItem.removePropertyChanged

setItemsOrder()

setItemsOrder(ids): void;

Parameters

Parameter	Type
ids	string[]

Returns

void

setTransform()

setTransform(value, suppressOnChanged?): void;

Parameters

Parameter	Type	Default value
value	Transform	undefined
suppressOnChanged	boolean	false

Returns

void

Inherited from

GroupItem.setTransform

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

GroupItem.toString

update()

update(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

Inherited from

GroupItem.update

generateAutoLayoutSettings()

static generateAutoLayoutSettings(
   rectangles, 
   alignItems?, 
   orientation?, 
   margin?, 
   justifyContent?): AutoLayoutSettings;

Parameters

Parameter	Type
rectangles	RectangleF[]
alignItems?	AutoLayoutAlignItems
orientation?	AutoLayoutOrientation
margin?	number
justifyContent?	AutoLayoutJustifyContent

Returns

AutoLayoutSettings