handsontable/plugins/comments/comments.d.ts

Handsontable is a JavaScript Data Grid available for React, Angular and Vue.

import Core from '../../core';
import { BasePlugin } from '../base';
import CellCoords from '../../3rdparty/walkontable/src/cell/coords';

export interface CommentObject {
  value?: string;
  readOnly?: boolean;
  style?: {
    height?: number;
    width?: number;
  };
}
export interface DetailedSettings {
  displayDelay?: number;
}

export type Settings = boolean | DetailedSettings;

export interface CommentConfig {
  row: number;
  col: number;
  comment: CommentObject;
}

export interface CommentsRangeObject {
  from: CellCoords;
  to?: CellCoords;
}

export class Comments extends BasePlugin {
  constructor(hotInstance: Core);

  range: CommentsRangeObject;

  isEnabled(): boolean;
  focusEditor(): void;
  setRange(range: CommentsRangeObject): void;
  clearRange(): void;
  setComment(value: string): void;
  setCommentAtCell(row: number, column: number, value: string): void;
  removeComment(forceRender?: boolean): void;
  removeCommentAtCell(row: number, column: number, forceRender?: boolean): void;
  getComment(): string;
  getCommentAtCell(row: number, column: number): string;
  show(): boolean;
  showAtCell(row: number, column: number): boolean;
  hide(): void;
  refreshEditor(force?: boolean): void;
  updateCommentMeta(row: number, column: number, metaObject: object): void;
  getCommentMeta(row: number, column: number, property: string): any;
}