Function GetNlgQueryResult Beta

GetNlgQueryResult(props, deprecatedLegacyContext?): null | ReactElement< any, any >

React component that fetches and displays a collapsible analysis of the provided query using natural language generation (NLG). Specifying a query is similar to providing parameters to a useExecuteQuery hook, using dimensions, measures, and filters.

Note

This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.

Parameters

Parameter	Type	Description
props	GetNlgQueryResultProps	GetNlgQueryResultProps
deprecatedLegacyContext?	any	::: warning Deprecated ::: See React Docs (opens new window)

Returns

null | ReactElement< any, any >

Collapsible container wrapping a text summary

Example

<GetNlgQueryResult
  dataSource="Sample ECommerce"
  dimensions={[DM.Commerce.Date.Years]}
  measures={[measureFactory.sum(DM.Commerce.Revenue)]}
/>