Type Alias ChartWorkerRetrievalSettings

Type declaration

• id: string

  Used to uniquely identify additional retrieval settings. Data returned for this retrieval setting will be listed under the same id. For example,

    const additionalRetrievalApi = await gsApi.dashboard.retrieval('myRetrieval').alsoRetrieveWhenRefreshed([{
        id: 'myAdditionalRetrieval',
        type: 'control',
        splitBy: ['characteristic'],
        groupBy: 'anchorPoint'
    }]);
  
    additionalRetrievalApi.onRetrieved(event => {
        // Fired when the retrieval is fetched, containing data with the provided ID
        console.log(event.data.response.control?.myAdditionalRetrieval)
    });gsApi.retrieval('my retrieval').
  Copy