QueryDefinition

Defines a query that a plugin can handle. Other plugins or the grid can send this query type to retrieve data.

Example

// In manifest
queries: [
  {
    type: 'canMoveColumn',
    description: 'Check if a column can be moved/reordered',
  },
]

// In plugin class
handleQuery(query: PluginQuery): unknown {
  if (query.type === 'canMoveColumn') {
    return this.canMoveColumn(query.context);
  }
}

Properties

Property	Type	Description
type	string	The query type identifier (e.g., ‘canMoveColumn’, ‘getContextMenuItems’). Should be unique across all plugins.
description?	string	Human-readable description of what the query does.