useCubeQuery
useCubeQuery‹TData›(query: Query | Query[], options?: UseCubeQueryOptions): UseCubeQueryResult‹Query, TData›A React hook for executing Cube queries
- TData
UseCubeQueryOptions
UseCubeQueryResult
isQueryPresent
isQueryPresent(query: Query | Query[]): booleanChecks whether the query is ready
QueryBuilder
QueryBuilder extends React.Component ‹QueryBuilderProps, 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.Component ‹QueryRendererProps›:
<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
updateQuery prop of QueryBuilderRenderProps