- 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.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.CellTypes.CheckBox
Class: CheckBox
Hierarchy
-
↳
CheckBox
Table of contents
Constructors
Properties
Methods
- activateEditor
- boxSize
- caption
- createEditorElement
- deactivateEditor
- focus
- format
- fromJSON
- getAutoFitHeight
- getAutoFitWidth
- getEditorValue
- getHitInfo
- hitTestMode
- isEditingValueChanged
- isImeAware
- isReservedKey
- isThreeState
- mode
- paint
- paintContent
- parse
- processKeyDown
- processKeyUp
- processMouseDown
- processMouseEnter
- processMouseLeave
- processMouseMove
- processMouseUp
- selectAll
- setEditorValue
- textAlign
- textEditable
- textFalse
- textIndeterminate
- textTrue
- toJSON
- toggleOptions
- updateEditor
- updateEditorContainer
- updateImeMode
Constructors
constructor
• new CheckBox()
Represents a check box cell.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Overrides
Properties
typeName
• typeName: string
Represents the type name string used for supporting serialization.
Inherited from
Methods
activateEditor
▸ activateEditor(editorContext, cellStyle, cellRect, context?): void
Activates the editor, including setting properties or attributes for the editor and binding events for the editor.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
cellStyle |
Style |
The cell's actual style. |
cellRect |
Rect |
The cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
boxSize
▸ boxSize(value?): any
Gets or sets a value that indicates the check box size
example
// This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string | number |
The size of check box. this value support number and "auto". |
Returns
any
If no value is set, returns the size of check box.
caption
▸ caption(value?): any
Gets or sets the caption of the cell type.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string |
The caption of the cell type. |
Returns
any
If no value is set, returns the caption; otherwise, returns the check box cell type.
createEditorElement
▸ createEditorElement(context?): HTMLElement
Creates a DOM element then returns it.
Parameters
| Name | Type | Description |
|---|---|---|
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
HTMLElement
Returns a DOM element.
Inherited from
deactivateEditor
▸ deactivateEditor(editorContext, context?): void
Deactivates the editor, such as unbinding events for editor.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
focus
▸ focus(editorContext, context?): void
Focuses the editor DOM element.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
format
▸ format(value, format, formattedData?, context?): string
Formats a value with the specified format to a string.
Parameters
| Name | Type | Description |
|---|---|---|
value |
any |
The object value to format. |
format |
string | GeneralFormatter |
The format. |
formattedData? |
FormattedData |
the formatted data. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
string
Returns the formatted string.
Inherited from
fromJSON
▸ fromJSON(settings): void
Loads the object state from the specified JSON string.
Parameters
| Name | Type | Description |
|---|---|---|
settings |
any |
The cell type data from deserialization. |
Returns
void
Inherited from
getAutoFitHeight
▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number
Gets a cell's height that can be used to handle the row's automatic fit.
Parameters
| Name | Type | Description |
|---|---|---|
value |
any |
The cell's value. |
text |
string |
The cell's text. |
cellStyle |
Style |
The cell's actual value. |
zoomFactor |
number |
The current sheet's zoom factor. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
number
Returns the cell's height that can be used to handle the row's automatic fit.
Inherited from
getAutoFitWidth
▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number
Gets a cell's width that can be used to handle the column's automatic fit.
Parameters
| Name | Type | Description |
|---|---|---|
value |
any |
The cell's value. |
text |
string |
The cell's text. |
cellStyle |
Style |
The cell's actual value. |
zoomFactor |
number |
The current sheet's zoom factor. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
number
Returns the cell's width that can be used to handle the column's automatic fit.
Inherited from
getEditorValue
▸ getEditorValue(editorContext, context?): any
Gets the editor's value.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
any
Returns the editor's value.
Inherited from
getHitInfo
▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo
Gets the cell type's hit information.
Parameters
| Name | Type | Description |
|---|---|---|
x |
number |
x-coordinate of pointer's current location relative to the canvas. |
y |
number |
y-coordinate of pointer's current location relative to the canvas. |
cellStyle |
Style |
The current cell's actual style. |
cellRect |
Rect |
The current cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
Returns an object that contains the x, y, row, col, cellRect, and sheetArea parameters, and a value to indicate isReservedLocation.
isReservedLocation is true if the hit test is in a special area that the cell type needs to handle; otherwise, false.
Inherited from
hitTestMode
▸ hitTestMode(value?): CheckBox | CheckBoxHitTestMode
Gets or sets a value that indicates the hit test mode of the checkbox cell type in checkbox and modern mode. This controls which area of the cell will respond to mouse interactions (clicks, cursor changes).
example
// This example creates a check box cell with checkbox mode hit testing.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.textTrue("Yes");
cellType1.textFalse("No");
cellType1.hitTestMode("checkbox"); // Only the checkbox area responds to clicks
activeSheet.getCell(1, 1).cellType(cellType1);
example
// This example creates a check box cell with cell mode hit testing (default).
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType2.textTrue("Checked");
cellType2.textFalse("Unchecked");
cellType2.hitTestMode("cell"); // The entire cell area responds to clicks
activeSheet.getCell(2, 1).cellType(cellType2);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
CheckBoxHitTestMode |
The hit test mode. 'cell' means the entire cell area responds to interactions; 'checkbox' means only the checkbox area responds to interactions. |
Returns
CheckBox | CheckBoxHitTestMode
If no value is set, returns the hit test mode of the checkbox cell type; otherwise, returns the checkbox cell type.
isEditingValueChanged
▸ isEditingValueChanged(oldValue, newValue, context?): boolean
Whether the editing value has changed.
Parameters
| Name | Type | Description |
|---|---|---|
oldValue |
any |
Old editing value. |
newValue |
any |
New editing value. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
boolean
true if oldValue equals newValue; otherwise, false.
Inherited from
isImeAware
▸ isImeAware(context?): boolean
Whether this cell type is aware of IME.
Parameters
| Name | Type | Description |
|---|---|---|
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
boolean
true if the cell type is aware of IME; otherwise, false.
Inherited from
isReservedKey
▸ isReservedKey(e, context?): boolean
Whether the cell type handles the keyboard event itself.
Parameters
| Name | Type | Description |
|---|---|---|
e |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
boolean
Returns true if the cell type handles the keyboard event itself; otherwise, false.
Inherited from
isThreeState
▸ isThreeState(value?): any
Gets or sets a value that indicates whether the check box supports three states.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
Whether the check box supports three states. |
Returns
any
If no value is set, returns whether the check box supports three states; otherwise, returns the check box cell type.
mode
▸ mode(value?): any
Gets or sets a value that indicates the mode of the checkbox cell type.
example
// This example creates a check box cell with toggle mode.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.mode("toggle");
activeSheet.getCell(1, 1).cellType(cellType1);
example
// This example creates a check box cell with modern mode.
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType2.caption("Modern Checkbox");
cellType2.mode("modern");
activeSheet.getCell(2, 1).cellType(cellType2);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
CheckBoxMode |
The mode of the checkbox cell type. 'checkbox' is the default classic mode with square borders, 'toggle' is an animated switch button, and 'modern' is a rounded corner style with SVG rendering. |
Returns
any
If no value is set, returns the mode of the checkbox cell type.
paint
▸ paint(ctx, value, x, y, w, h, style, context?): void
Paints a cell on the canvas.
Parameters
| Name | Type | Description |
|---|---|---|
ctx |
CanvasRenderingContext2D |
The canvas's two-dimensional context. |
value |
any |
The cell's value. |
x |
number |
x-coordinate relative to the canvas. |
y |
number |
y-coordinate relative to the canvas. |
w |
number |
The cell's width. |
h |
number |
The cell's height. |
style |
Style |
The cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
paintContent
▸ paintContent(ctx, value, x, y, w, h, style, context?): void
Paints the cell content area on the canvas.
Parameters
| Name | Type | Description |
|---|---|---|
ctx |
CanvasRenderingContext2D |
The canvas's two-dimensional context. |
value |
any |
The cell's value. |
x |
number |
x-coordinate relative to the canvas. |
y |
number |
y-coordinate relative to the canvas. |
w |
number |
The cell content area's width. |
h |
number |
The cell content area's height. |
style |
Style |
The cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
parse
▸ parse(text, formatStr, context?): any
Parses the text with the specified format string to an object.
Parameters
| Name | Type | Description |
|---|---|---|
text |
string |
The parse text string. |
formatStr |
string |
The parse format string. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
any
The parsed object.
Inherited from
processKeyDown
▸ processKeyDown(event, context?): boolean
Processes key down in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
event |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processKeyUp
▸ processKeyUp(event, context?): boolean
Processes key up in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
event |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processMouseDown
▸ processMouseDown(hitInfo): boolean
Processes mouse down in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processMouseEnter
▸ processMouseEnter(hitInfo): boolean
Processes mouse enter in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processMouseLeave
▸ processMouseLeave(hitInfo): boolean
Processes mouse leave in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processMouseMove
▸ processMouseMove(hitInfo): boolean
Processes mouse move in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
processMouseUp
▸ processMouseUp(hitInfo): boolean
Processes mouse up in display mode.
Parameters
| Name | Type | Description |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
Returns
boolean
Returns true if the process is successful; otherwise, false.
Inherited from
selectAll
▸ selectAll(editorContext, context?): void
Selects all the text in the editor DOM element.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
setEditorValue
▸ setEditorValue(editorContext, value, context?): void
Sets the editor's value.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
value |
any |
The value returned from the active cell. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void
Inherited from
textAlign
▸ textAlign(value?): any
Gets or sets the text alignment relative to the check box.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
CheckBoxTextAlign |
The text alignment relative to the check box. |
Returns
any
If no value is set, returns the text alignment relative to the check box; otherwise, returns the check box cell type.
textEditable
▸ textEditable(value?): boolean | CheckBox
Gets or sets a value that indicates whether the checkbox cell type allows text editing in checkbox and modern mode. When set to false, the checkbox behaves like toggle mode and cannot enter text editing mode (double-click or F2).
example
// This example creates a check box cell with non-editable text.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.textTrue("Yes");
cellType1.textFalse("No");
cellType1.textEditable(false); // Cannot double-click to edit text
activeSheet.getCell(1, 1).cellType(cellType1);
example
// This example creates a check box cell with editable text (default).
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType2.textTrue("Checked");
cellType2.textFalse("Unchecked");
cellType2.textEditable(true); // Can double-click to edit text
activeSheet.getCell(2, 1).cellType(cellType2);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
Whether the checkbox text is editable. Default is true. |
Returns
boolean | CheckBox
If no value is set, returns whether the checkbox text is editable; otherwise, returns the checkbox cell type.
textFalse
▸ textFalse(value?): any
Gets or sets the text in the cell when the cell's value is false.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string |
The text in the cell when the cell's value is false. |
Returns
any
If no value is set, returns the text in the cell when the cell's value is false. If a value is set, returns the check box cell type.
textIndeterminate
▸ textIndeterminate(value?): any
Gets or sets the text in the cell when the cell's value is indeterminate (neither true nor false).
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string |
The text in the cell when the cell's value is indeterminate. |
Returns
any
If no value is set, returns the text in the cell when the cell's value is indeterminate. If a value is set, returns the check box cell type.
textTrue
▸ textTrue(value?): any
Gets or sets the text in the cell when the cell's value is true.
example
//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
string |
The text when the cell's value is true. |
Returns
any
If no value is set, returns the text when the cell's value is true. If a value is set, returns the check box cell type.
toJSON
▸ toJSON(): any
Saves the object state to a JSON string.
Returns
any
The cell type data.
Inherited from
toggleOptions
▸ toggleOptions(value?): any
Gets or sets a value that indicates the toggle options
example
// This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("ON");
cellType1.textFalse("OFF");
cellType1.mode("toggle");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.inside);
cellType1.toggleOptions({
width: 60,
height: 30,
trackColorOn: '#4CAF50',
trackColorOff: '#767577',
sliderColorOn: '#ffffff',
sliderColorOff: '#ffffff',
sliderMargin: 2,
animationDuration: 100,
trackRadius: 8,
sliderRadius: 4
});
activeSheet.getCell(1, 1).cellType(cellType1);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
IToggleOptions |
The toggle options. |
Returns
any
If no value is set, returns the toggle options.
updateEditor
▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect
Updates the editor's size.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
cellStyle |
Style |
The cell's actual style. |
cellRect |
Rect |
The cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
Returns the new size for cell wrapper element, it should contain two properties 'width' and 'height'.
Inherited from
updateEditorContainer
▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void
Updates the cell wrapper element size.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
editorBounds |
Rect |
The cell wrapper element's new size. |
cellStyle |
Style |
The cell's actual style. |
Returns
void
Inherited from
updateImeMode
▸ updateImeMode(editorContext, imeMode, context?): void
Updates the editor's ime-mode.
Parameters
| Name | Type | Description |
|---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
imeMode |
ImeMode |
The ime-mode from cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns
void