[]
DEMOS DOC DESIGNER API
DOWNLOAD
(Showing Draft Content)

GC.Spread.Sheets.ThreadedComments.ThreadedCommentPanel

Class: ThreadedCommentPanel

Sheets.ThreadedComments.ThreadedCommentPanel

Table of contents

Constructors

Methods

Constructors

constructor

• new ThreadedCommentPanel(host, workbook)

Represents the threaded comment panel for managing and navigating threaded comments in a workbook.

example

const spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
const panelHost = document.getElementById("threadedCommentPanel");
const threadedCommentPanel = new GC.Spread.Sheets.ThreadedComments.ThreadedCommentPanel(panelHost, spread);

Parameters

Name Type Description
host string | HTMLElement Indicates the container element or the ID of the container element where the panel will be rendered.
workbook Workbook Indicates the workbook instance to which the threaded comment panel is attached.

Methods

attach

▸ attach(workbook): any

description attach to a workbook for threaded comment panel.

Parameters

Name Type Description
workbook Workbook Indicates the workbook which is attached.

Returns

any

void

destroy

▸ destroy(): any

description destroy the PivotPanel.

Returns

any

detach

▸ detach(): void

description detach the workbook for threaded comment panel.

Returns

void

void

findControl

▸ findControl(host): ThreadedCommentPanel

Gets the ThreadedCommentPanel instance by the host element.

example

window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
     var threadedCommentPanel = new GC.Spread.Sheets.ThreadedComments.ThreadedCommentPanel(document.getElementById("threadedCommentPanel"));
     threadedCommentPanel.workbook(spread);
     var threadedCommentPanelInstance = GC.Spread.Sheets.ThreadedComments.ThreadedCommentPanel.findControl("threadedCommentPanel");
}

Parameters

Name Type Description
host string | HTMLElement The host element or the host element id.

Returns

ThreadedCommentPanel

The ThreadedCommentPanel instance.

refresh

▸ refresh(): void

refresh the threaded comment panel.

Returns

void