Class TableEditPlugin

TableEdit plugin, provides the ability to resize a table by drag-and-drop

Hierarchy

TableEditPlugin

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new TableEditPlugin(anchorContainerSelector?: string, onTableEditorCreated?: OnTableEditorCreatedCallback, disableFeatures?: TableEditFeatureName[]): TableEditPlugin

- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:16
Construct a new instance of TableResize plugin

Parameters
- Optional anchorContainerSelector: string
  
  An optional selector string to specify the container to host the plugin. The container must not be affected by transform: scale(), otherwise the position calculation will be wrong. If not specified, the plugin will be inserted in document.body
- Optional onTableEditorCreated: OnTableEditorCreatedCallback
  
  An optional callback to customize the Table Editors elements when created.
- Optional disableFeatures: TableEditFeatureName[]
  
  An optional array of TableEditFeatures to disable
Returns TableEditPlugin

Methods

dispose

dispose(): void

Implementation of EditorPlugin.dispose
- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:69
Dispose this plugin

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:35
Get a friendly name of this plugin

Returns string

initialize

initialize(editor: IEditor): void

Implementation of EditorPlugin.initialize
- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:43
Initialize this plugin. This should only be called from Editor

Parameters
- editor: IEditor
  
  Editor instance
Returns void

onPluginEvent

onPluginEvent(e: PluginEvent): void

Implementation of EditorPlugin.onPluginEvent
- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:84
Handle events triggered from editor

Parameters
- e: PluginEvent
Returns void

setTableEditor

setTableEditor(table: HTMLTableElement, event?: MouseEvent): void

- Defined in roosterjs-content-model-plugins/lib/tableEdit/TableEditPlugin.ts:136
internal

Public only for unit test

Parameters
- table: HTMLTableElement
  
  Table to use when setting the Editors
- Optional event: MouseEvent
  
  (Optional) Mouse event
Returns void

Generated using TypeDoc