# GridCollaboratorInfo

Fields, allowed values, and APIs that use GridCollaboratorInfo.

Canonical: https://grid.syidax.com/docs/types/GridCollaboratorInfo/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface GridCollaboratorInfo {
  id: string;
  name?: string;
  color?: string;
  cursor?: { row: number; col: number } | null;
  selection?: GridCollabSelection | null;
}
```

<a id="used-by"></a>

## APIs using this type

- [getCollaborators](https://grid.syidax.com/docs/methods/getCollaborators.md) — Reads current collaboration participant information.
- [collaboratorJoined](https://grid.syidax.com/docs/events/collaboratorJoined.md) — Emitted when a participant joins the collaboration room.

<a id="parents"></a>

## Contracts containing this type

- [GridPresenceChangedDetail](https://grid.syidax.com/docs/types/GridPresenceChangedDetail.md)
- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)
- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [GridCollabSelection](https://grid.syidax.com/docs/types/GridCollabSelection.md)