# FGroup

> Language fallback: requested `zh-CN`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/zh-CN/reference/facade/group](https://docs.univer.ai/zh-CN/reference/facade/group)

- Agent Markdown: [https://docs.univer.ai/zh-CN/reference/facade/group.md](https://docs.univer.ai/zh-CN/reference/facade/group.md)

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [facade/group.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/group.mdx)

---

The facade class for a slide group element.

## Access

Access through:

* [`FSlide.getGroups()`](https://docs.univer.ai/zh-CN/reference/facade/slide.md#getgroups)
* [`FSlide.group()`](https://docs.univer.ai/zh-CN/reference/facade/slide.md#group)

## Inheritance

Extends [`FPageElement`](https://docs.univer.ai/zh-CN/reference/facade/page-element.md). Its inherited members are available on this object.

## Setup

Register [`@univerjs-pro/slides`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/slides.md) 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](https://docs.univer.ai/zh-CN/guides/slides/getting-started/facade.md).

## `@univerjs-pro/slides`

### `FGroup.getChildren`

Get the direct children of this group.

```typescript
getChildren(): FSlidePageElement[]
```

**Returns**

The direct child elements in group order.

**Examples**

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

**Types:** [`FSlidePageElement`](https://unpkg.com/@univerjs-pro/slides@1.0.0-rc.0/lib/types/facade/f-slide.d.ts)

**Package:** [`@univerjs-pro/slides`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/slides.md) · [Type definitions](https://unpkg.com/@univerjs-pro/slides@1.0.0-rc.0/lib/types/facade/f-group.d.ts)

### `FGroup.ungroup`

Ungroup this group and return the released child element facades.

```typescript
ungroup(): FSlidePageElement[]
```

**Returns**

The direct child elements that were released.

**Examples**

```ts
const fPresentation = univerAPI.getActivePresentation()
const fSlide = fPresentation.getSlideByIndex(0)

const group = fSlide.getGroups()[0]
if (group) {
  group.ungroup()
}
```

**Types:** [`FSlidePageElement`](https://unpkg.com/@univerjs-pro/slides@1.0.0-rc.0/lib/types/facade/f-slide.d.ts)

**Package:** [`@univerjs-pro/slides`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/slides.md) · [Type definitions](https://unpkg.com/@univerjs-pro/slides@1.0.0-rc.0/lib/types/facade/f-group.d.ts)
