Skip to main content

useCubeQuery

useCubeQueryTData›(query: Query | Query[], options?: UseCubeQueryOptions): UseCubeQueryResult‹Query, TData›
A React hook for executing Cube queries
Type parameters:
  • TData

UseCubeQueryOptions

UseCubeQueryResult

isQueryPresent

isQueryPresent(query: Query | Query[]): boolean
Checks whether the query is ready

QueryBuilder

QueryBuilder extends React.ComponentQueryBuilderProps, QueryBuilderState›:
<QueryBuilder /> is used to build interactive analytics query builders. It abstracts state management and API calls to Cube API. It uses render prop technique and doesn’t render anything itself, but calls the render function instead. Example Open in CodeSandbox

QueryBuilderProps

QueryBuilderRenderProps

QueryBuilderState

QueryBuilderState: VizState & object

QueryRenderer

QueryRenderer extends React.ComponentQueryRendererProps›:
<QueryRenderer /> a react component that accepts a query, fetches the given query, and uses the render prop to render the resulting data

QueryRendererProps

QueryRendererRenderProps

CubeProvider

CubeProvider: React.FC‹CubeProviderProps
Cube context provider

CubeContext

CubeContext: Context‹CubeContextProps
In case when you need direct access to cubeApi you can use CubeContext anywhere in your app

Types

ChartType

ChartType: “line” | “bar” | “table” | “area”

CubeContextProps

CubeProviderProps

CubeProviderOptions

MemberUpdater

You can use the following methods for member manipulaltion
NOTE: if you need to add or remove more than one member at a time you should use updateQuery prop of QueryBuilderRenderProps

TLoadingState

VizState