# GC.Spread.Sheets.Scenarios.ScenarioPanel

## Content

# Class: ScenarioPanel

[Sheets](../modules/GC.Spread.Sheets).[Scenarios](../modules/GC.Spread.Sheets.Scenarios).ScenarioPanel

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Scenarios.ScenarioPanel#constructor)

### Methods

- [attach](GC.Spread.Sheets.Scenarios.ScenarioPanel#attach)
- [destroy](GC.Spread.Sheets.Scenarios.ScenarioPanel#destroy)
- [detach](GC.Spread.Sheets.Scenarios.ScenarioPanel#detach)
- [refresh](GC.Spread.Sheets.Scenarios.ScenarioPanel#refresh)
- [findControl](GC.Spread.Sheets.Scenarios.ScenarioPanel#findcontrol)

## Constructors

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

• **new ScenarioPanel**(`host`, `workbook?`)

Represents a scenario panel that displays and manages workbook scenarios.

**`example`**
```javascript
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var scenarioPanel = new GC.Spread.Sheets.Scenarios.ScenarioPanel(document.getElementById("scenarioPanel"), spread);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `host` | `string` \| `HTMLElement` | The host element or host element id. |
| `workbook?` | [`Workbook`](GC.Spread.Sheets.Workbook) | The workbook associated with the scenario panel. |

## Methods

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

▸ **attach**(`workbook`): `void`

Attaches the scenario panel to a workbook.

**`example`**
```javascript
scenarioPanel.attach(spread);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workbook` | [`Workbook`](GC.Spread.Sheets.Workbook) | The workbook to attach. |

#### Returns

`void`

___

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

▸ **destroy**(): `void`

Destroys the scenario panel.

**`example`**
```javascript
scenarioPanel.destroy();
```

#### Returns

`void`

___

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

▸ **detach**(): `void`

Detaches the scenario panel from the current workbook.

**`example`**
```javascript
scenarioPanel.detach();
```

#### Returns

`void`

___

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

▸ **refresh**(): `void`

Refreshes the scenario panel view.

**`example`**
```javascript
scenarioPanel.refresh();
```

#### Returns

`void`

___

### <a id="findcontrol" name="findcontrol"></a> findControl

▸ `Static` **findControl**(`host`): ``null`` \| [`ScenarioPanel`](GC.Spread.Sheets.Scenarios.ScenarioPanel)

Gets the ScenarioPanel instance by the host element.

**`example`**
```javascript
var scenarioPanel = new GC.Spread.Sheets.Scenarios.ScenarioPanel(document.getElementById("scenarioPanel"), spread);
var scenarioPanelInstance = GC.Spread.Sheets.Scenarios.ScenarioPanel.findControl("scenarioPanel");
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `host` | `string` \| `HTMLElement` | The host element or the host element id. |

#### Returns

``null`` \| [`ScenarioPanel`](GC.Spread.Sheets.Scenarios.ScenarioPanel)

The ScenarioPanel instance.