useEngine

useEngine hook. A hook allowing you to connect to a Qlik engine

Usage

Hooks are a new addition in React. They let you use state and other React features without writing a class. To learn more abou hook in react please read : https://reactjs.org/docs/hooks-intro.html

The motivation for introducing hooks in React are:

  • It’s hard to reuse stateful logic between components
  • Complex components become hard to understand
  • Classes confuse both people and machines
  • Complex components become hard to understand

To solve these problems, Hooks let you use more of React’s features without classes.

We have tried to expose hooks used in the libary so that you can create your own visualisations if you wish.

import { useEngine } from @motor-js/core
//...
const { engine, engineError } = useEngine(config);

Once the engine has been successfully conencted to you can perform functions such as creating hypercubes for data visualisations and creating list objects for listboxes.

Props

info

You do not need to set the Config prop if the component is a child of the Motor component

PropDescriptionOptions / Example
configConfiguration object to connect to the Qlik Engine, only set this if used outside of the Motor component.object
config = {
host: "xxxxxxxxx",
secure: false,
port: xxxxx,
prefix: "",
appId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", }

Sample Syntax

useEngine configuration

import { useEngine } from '@motor-js/core'
const config={{
host: "xxxxxxxxx",
secure: false,
port: xxxxx,
prefix: "",
appId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
}}
const { engine, engineError } = useEngine(config);
......
/>