Class GroupItem

Inheritance

ModelComponent

BaseItem

Item

GroupItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(items)

Constructs a new instance of the GroupItem class

Declaration

constructor(items?: Item[]);

Parameters

Type	Name	Description
Item[]	items

Properties

groupItemPermissions

Declaration

get groupItemPermissions(): GroupItemPermissions;

set groupItemPermissions(value: GroupItemPermissions);

Property Value

Type	Description
GroupItemPermissions

groupManipulationPermissions

Declaration

get groupManipulationPermissions(): ManipulationPermissions;

set groupManipulationPermissions(value: ManipulationPermissions);

Property Value

Type	Description
ManipulationPermissions

items

Declaration

readonly items: Collection<Item>;

Property Value

Type	Description
Collection<Item>

manipulationPermissions

Declaration

get manipulationPermissions(): ManipulationPermissions;

set manipulationPermissions(value: ManipulationPermissions);

Property Value

Type	Description
ManipulationPermissions

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: GroupItem, destination: GroupItem, generateNewIds: boolean, appropriateParentContainer: boolean): void;

Parameters

Type	Name	Description
GroupItem	source
GroupItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_onContainerChanged()

Declaration

_onContainerChanged(): void;

Returns

Type	Description
void

addItem(item, targetIndex)

Declaration

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

Parameters

Type	Name	Description
Item	item
number	targetIndex

Returns

Type	Description
void

addItems(items, targetIndex)

Declaration

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

Parameters

Type	Name	Description
Item[]	items
number	targetIndex

Returns

Type	Description
void

applyPermissionsConstrain()

Declaration

applyPermissionsConstrain(): void;

Returns

Type	Description
void

applyToItems(func)

Declaration

applyToItems(func: (item: Item) => any): void;

Parameters

Type	Name	Description
(item: Item) => any	func

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
GroupItem

equals(other)

Declaration

equals(other: GroupItem): boolean;

Parameters

Type	Name	Description
GroupItem	other

Returns

Type	Description
boolean

getNestedItems(excludeGroupItems)

Declaration

getNestedItems(excludeGroupItems?: boolean): Item[];

Parameters

Type	Name	Description
boolean	excludeGroupItems

Returns

Type	Description
Item[]

getSimplifiedObject(omitProperties)

Declaration

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

Parameters

Type	Name	Description
string[] | string	omitProperties

Returns

Type	Description
Object

isChildVisible(child)

Declaration

isChildVisible(child: Item): boolean;

Parameters

Type	Name	Description
Item	child

Returns

Type	Description
boolean

removeItems(items)

Declaration

removeItems(items: Item[]): void;

Parameters

Type	Name	Description
Item[]	items

Returns

Type	Description
void