Api

IShapesGroupControllerApi

Download Markdown

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

createGroupFromSelection

createGroupFromSelection(): ShapesGroupId;

Use the type signature above and the integration guide for the owning capability.

removeGroup

removeGroup(groupId: ShapesGroupId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

groups

groups(): readonly ShapesGroupId[];

Use the type signature above and the integration guide for the owning capability.

shapesInGroup

shapesInGroup(groupId: ShapesGroupId): readonly EntityId[];

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

excludeShapeFromGroup

excludeShapeFromGroup(groupId: ShapesGroupId, shapeId: EntityId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`shapeId`	`EntityId`	Yes

addShapeToGroup

addShapeToGroup(groupId: ShapesGroupId, shapeId: EntityId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`shapeId`	`EntityId`	Yes

availableZOrderOperations

availableZOrderOperations(groupId: ShapesGroupId): AvailableZOrderOperations;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

bringToFront

bringToFront(groupId: ShapesGroupId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

sendToBack

sendToBack(groupId: ShapesGroupId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

bringForward

bringForward(groupId: ShapesGroupId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

sendBackward

sendBackward(groupId: ShapesGroupId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

insertAfter

insertAfter(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`target`	`ShapesGroupId \| EntityId`	Yes

insertBefore

insertBefore(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`target`	`ShapesGroupId \| EntityId`	Yes

setGroupVisibility

setGroupVisibility(groupId: ShapesGroupId, value: boolean): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`value`	`boolean`	Yes

groupVisibility

groupVisibility(groupId: ShapesGroupId): GroupVisibilityState;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

setGroupLock

setGroupLock(groupId: ShapesGroupId, value: boolean): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`value`	`boolean`	Yes

groupLock

groupLock(groupId: ShapesGroupId): GroupLockState;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

getGroupName

getGroupName(groupId: ShapesGroupId): string;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes

setGroupName

setGroupName(groupId: ShapesGroupId, name: string): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`groupId`	`ShapesGroupId`	Yes
`name`	`string`	Yes

canBeGroupped

canBeGroupped(shapes: readonly EntityId[]): boolean;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`shapes`	`readonly EntityId[]`	Yes