FGroup

The facade class for a slide group element.

Access

Access through:

• FSlide.getGroups()
• FSlide.group()

Inheritance

Extends FPageElement. Its inherited members are available on this object.

Setup

Register @univerjs-pro/slides or a preset that includes it. In plugin mode, import @univerjs-pro/slides/facade. Additional methods below require their listed plugin packages. See Facade setup.

@univerjs-pro/slides

FGroup.getChildren

Get the direct children of this group.

getChildren(): FSlidePageElement[]

Returns

The direct child elements in group order.

Examples

const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const groups = fSlide.getGroups()console.log(groups[0]?.getChildren())

Types: FSlidePageElement

Package: @univerjs-pro/slides · Type definitions

FGroup.ungroup

Ungroup this group and return the released child element facades.

ungroup(): FSlidePageElement[]

Returns

The direct child elements that were released.

Examples

const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const group = fSlide.getGroups()[0]if (group) {  group.ungroup()}

Types: FSlidePageElement

Package: @univerjs-pro/slides · Type definitions