# GC.Spread.Sheets.Outlines.OutlineInfo

## Content

# Class: OutlineInfo

[Sheets](../modules/GC.Spread.Sheets).[Outlines](../modules/GC.Spread.Sheets.Outlines).OutlineInfo

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Outlines.OutlineInfo#constructor)

### Properties

- [children](GC.Spread.Sheets.Outlines.OutlineInfo#children)
- [end](GC.Spread.Sheets.Outlines.OutlineInfo#end)
- [level](GC.Spread.Sheets.Outlines.OutlineInfo#level)
- [model](GC.Spread.Sheets.Outlines.OutlineInfo#model)
- [parent](GC.Spread.Sheets.Outlines.OutlineInfo#parent)
- [start](GC.Spread.Sheets.Outlines.OutlineInfo#start)

### Methods

- [addChild](GC.Spread.Sheets.Outlines.OutlineInfo#addchild)
- [contains](GC.Spread.Sheets.Outlines.OutlineInfo#contains)
- [state](GC.Spread.Sheets.Outlines.OutlineInfo#state)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new OutlineInfo**(`model`, `start`, `end`, `level`)

Represents the outline (range group) information.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `model` | [`Outline`](GC.Spread.Sheets.Outlines.Outline) | The owner of the outline. |
| `start` | `number` | The start index of the outline. |
| `end` | `number` | The end index of the outline. |
| `level` | `number` | The level of the outline. |

## Properties

### <a id="children" name="children"></a> children

• **children**: `any`[]

The children of the group.

___

### <a id="end" name="end"></a> end

• **end**: `number`

The end index of the group.

___

### <a id="level" name="level"></a> level

• **level**: `number`

The level of the group.

___

### <a id="model" name="model"></a> model

• **model**: [`Outline`](GC.Spread.Sheets.Outlines.Outline)

The owner of the group.

___

### <a id="parent" name="parent"></a> parent

• **parent**: [`OutlineInfo`](GC.Spread.Sheets.Outlines.OutlineInfo)

The parent of the group.

___

### <a id="start" name="start"></a> start

• **start**: `number`

The start index of the group.

## Methods

### <a id="addchild" name="addchild"></a> addChild

▸ **addChild**(`child`): `void`

Adds the child.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `child` | `Object` | The child. |

#### Returns

`void`

___

### <a id="contains" name="contains"></a> contains

▸ **contains**(`index`): `boolean`

Compares this instance to a specified OutlineInfo object and returns an indication of their relative values.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | `number` | The index of the group item. |

#### Returns

`boolean`

`true` if the range group contains the specified index; otherwise, `false`.

___

### <a id="state" name="state"></a> state

▸ **state**(`value?`): [`OutlineState`](../enums/GC.Spread.Sheets.Outlines.OutlineState)

Gets or sets the state of this outline (range group).

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | [`OutlineState`](../enums/GC.Spread.Sheets.Outlines.OutlineState) |

#### Returns

[`OutlineState`](../enums/GC.Spread.Sheets.Outlines.OutlineState)

The state of this outline (range group).