PresenceOverlay | @sheetwrite/core

@sheetwrite/coreinterface

Ephemeral collaborator selection rendered above the grid. Presence never enters document operations, snapshots, dirty state, or undo history.

Package: @sheetwrite/core
Source: packages/core/src/types/coordinates.ts#L39

Members 5

actorId

actorId: string;

displayName

displayName?: string;

color

color: string;

activeSheet

activeSheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;

ranges

ranges: readonly Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →[];

Declaration

View full TypeScript declaration

export interface PresenceOverlay {
  actorId: string;
  displayName?: string;
  color: string;
  activeSheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;
  ranges: readonly Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →[];
}