[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [controls](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls) / [tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools) / [editors](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#editors) / [commands](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#commands) / [group](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls.tools.editors.commands.group) / Group

# Class: Group

[commands](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#commands).[group](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls.tools.editors.commands.group).Group

Command to group nodes into a single parent node

## Hierarchy

- [`AbstractCommand`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand)
↳ **`Group`**


## Table of contents

Constructors
- [new Group()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.editors.commands.group.group.md#new group())


Methods
| [createInverse](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#createinverse) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#getclassname) | [getEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#geteventname) |
|  --- | --- | --- |
| [getGroup](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#getgroup) | [getNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#getnode) | [getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#getoptions) |
| [isRejected](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#isrejected) | [isSeparate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#isseparate) | [merge](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#merge) |
| [reject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#reject) | [setGroup](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#setgroup) | [setNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#setnode) |
| [setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#setoptions) | [setSeparate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#setseparate) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group#getclassname-1) |


## Contents

Constructors
#### new Group()

• **new Group**()

#### Overrides

AbstractCommand.constructor

Methods
#### createInverse

▸ **createInverse**(): [`AbstractCommand`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand)

Returns inverse command

#### Returns

[`AbstractCommand`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand)

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[createInverse](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#createinverse)

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#getclassname)

#### getEventName

▸ **getEventName**(): `string`

Returns event to be fired when command is applied

#### Returns

`string`

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[getEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#geteventname)

#### getGroup

▸ **getGroup**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

Returns common parent node

#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

#### getNode

▸ **getNode**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[]

Returns target command node

#### Returns

[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[]

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[getNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#getnode)

#### getOptions

▸ **getOptions**(): `Record`<`string`, `any`&gt;

Returns command options

#### Returns

`Record`<`string`, `any`&gt;

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#getoptions)

#### isRejected

▸ **isRejected**(): `boolean`

Returns rejected state

#### Returns

`boolean`

the state

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[isRejected](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#isrejected)

#### isSeparate

▸ **isSeparate**(): `boolean`

Returns true if command is separate, false otherwise

#### Returns

`boolean`

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[isSeparate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#isseparate)

#### merge

▸ **merge**(`command`): `boolean`

Tries to merge current with another command. If successful, return true and second command won't be stored in history.
Returns false otherwise.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `command` | [`AbstractCommand`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand) | command to merge |


#### Returns

`boolean`

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[merge](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#merge)

#### reject

▸ **reject**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

Rejects action

#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

this

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[reject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#reject)

#### setGroup

▸ **setGroup**(`group`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

Sets group to use as a common parent node

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `group` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt; | group to contain all the children |


#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

this

#### setNode

▸ **setNode**(`node`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

Sets target node for the command

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[] | node(s) for applying the command |


#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

this

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[setNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#setnode)

#### setOptions

▸ **setOptions**(`options`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

Sets extra options to be stored in command

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `options` | `Record`<`string`, `any`&gt; | some extra options for the command to store |


#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

this

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#setoptions)

#### setSeparate

▸ **setSeparate**(`isSeparate`): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

Sets command to be separate or not (true by default). Not separate commands are ignored by history undo/redo actions
and considered as a part of the last separate command.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `isSeparate` | `boolean` | true if command should be considered as a separate operation (in undo/redo history), false otherwise |


#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.group.group)

this

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[setSeparate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#setseparate)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractCommand](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.editors.commands.abstractcommand.abstractcommand#getclassname-1)