Home > @i2analyze/i2connect > addVisualQueryService
addVisualQueryService() function
Adds a visual query service that provides an acquire callback and an optional validate callback to the connector.
Signature:
export declare function addVisualQueryService<TServiceConfig extends services.IVisualQueryServiceConfig>(config: TServiceConfig, callbacks: services.IVisualQueryServiceCallbacks<TServiceConfig>): void;
Introduced: API version 2.3
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TServiceConfig | extends services.IVisualQueryServiceConfig | The type of the service configuration. |
Parameters
| Parameter | Type | Description |
|---|---|---|
| config | TServiceConfig | The service configuration, which determines the name and description of the service that users see, and some aspects of its behavior. |
| callbacks | services.IVisualQueryServiceCallbacks<TServiceConfig> | An object that contains the callbacks. |
Returns:
void