- Overview
- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ThreadedComments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.Collaboration
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.NamedCellTemplates
- GC.Spread.Sheets.Scenarios
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.AI
- Collaboration
- GC.Spread.Excel
GC.Spread.Sheets.Scenarios.ScenarioPanel
Class: ScenarioPanel
Sheets.Scenarios.ScenarioPanel
Table of contents
Constructors
Methods
Constructors
constructor
• new ScenarioPanel(host, workbook?)
Represents a scenario panel that displays and manages workbook scenarios.
example
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 |
The workbook associated with the scenario panel. |
Methods
attach
▸ attach(workbook): void
Attaches the scenario panel to a workbook.
example
scenarioPanel.attach(spread);
Parameters
| Name | Type | Description |
|---|---|---|
workbook |
Workbook |
The workbook to attach. |
Returns
void
destroy
▸ destroy(): void
Destroys the scenario panel.
example
scenarioPanel.destroy();
Returns
void
detach
▸ detach(): void
Detaches the scenario panel from the current workbook.
example
scenarioPanel.detach();
Returns
void
refresh
▸ refresh(): void
Refreshes the scenario panel view.
example
scenarioPanel.refresh();
Returns
void
findControl
▸ Static findControl(host): null | ScenarioPanel
Gets the ScenarioPanel instance by the host element.
example
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
The ScenarioPanel instance.