nebula.js: stardust
Product and framework agnostic integration API for Qlik's Associative Engine, commonly used with enigma.js. Consider using the qlik-embed toolkit for an easier embedding experience, whilst building on the same core technologies.
Initiates a new Embed
instance using the specified enigma app
.
Parameters
- app qix.DocRequired
- instanceConfig Configuration
instanceConfig properties
- load LoadFallback
Fallback load function for missing types
load properties
- LoadFallback() functionRequired
Fallback load function for missing types
Parameters- Required
properties
- LoadType interfaceRequiredParameters
- type objectRequired
type properties
- name stringRequired
- version stringRequired
-
Returns- Promise < Visualization >Required
-
-
Returns- Promise < Visualization >Required
-
-
- context Context
Settings for the rendering instance
context properties
- theme string
- language string
- deviceType string
-
constraints properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
- interactions Interactions
interactions properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
- boolean
- disableCellPadding boolean
- dataViewType string
Type used for toggling to the data view (toggleDataView) This type need to be registered as well
-
- types Array< TypeInfo >
Visualization types to register
- themes Array< ThemeInfo >
Themes to register
- hostConfig object
Qlik api compatible host config, see https://github.com/qlik-oss/qlik-api-ts/blob/main/docs/authentication.md#the-host-config
- anything object
-
Returns
- Required
properties
- render() functionRequired
Renders a visualization or sheet into an HTMLElement. Visualizations can either be existing objects or created on the fly. Support for sense sheets is experimental.
Parameters- cfg RenderConfigRequired
The render configuration.
cfg properties
- element HTMLElementRequired
Target html element to render in to
- options object
Options passed into the visualisation
- plugins Array< Plugin >
plugins passed into the visualisation
- id string
For existing objects: Engine identifier of object to render
- type string
For creating objects: Type of visualisation to render
- version string
For creating objects: Version of visualization to render
- fields Array< Field >
For creating objects: Data fields to use
- extendProperties boolean
For creating objects: Whether to deeply extend properties or not. If false then subtrees will be overwritten.
- properties qix.GenericObjectProperties
For creating objects: Explicit properties to set
-
Returns-
A controller to the rendered visualization or sheet.
-
- create() functionRequired
Creates a visualization model
Parameters- cfg CreateConfigRequired
The create configuration.
cfg properties
- type stringRequired
- version string
- fields Array< Field >
- properties qix.GenericObjectProperties
-
Returns- Promise < qix.GenericObject >Required
An engima model
-
- generateProperties() functionRequired
Generates properties for a visualization object
Parameters- cfg CreateConfigRequired
The create configuration.
Returns- Promise < object >Required
The objects properties
-
- context() functionRequired
Updates the current context of this embed instance. Use this when you want to change some part of the current context, like theme.
Parameters- ctx ContextRequired
The context to update.
Returns- Promise < undefined >Required
-
- selections() functionRequired
Gets the app selections of this instance.
Returns- Promise < AppSelections >Required
-
- field() functionRequiredAvailable since: 1.1.0
Gets the listbox instance of the specified field
Parameters- fieldIdentifier string | LibraryField | QInfoRequired
Fieldname as a string, a Library dimension or an object id
Returns- Promise < FieldInstance >Required
-
- getRegisteredTypes() functionRequired
Gets a list of registered visualization types and versions
Returns- Array< Object >Required
types
-
-
embed
import { embed } from '@nebula.js/stardust'
const n = embed(app);
n.render({ id: 'abc' });
Creates a new embed
scope bound to the specified configuration
.
The configuration is merged with all previous scopes.
Parameters
- configuration ConfigurationRequired
The configuration object
Returns
- Required
properties
- createConfiguration() functionRequired
Creates a new
embed
scope bound to the specifiedconfiguration
.The configuration is merged with all previous scopes.
Parameters- configuration ConfigurationRequired
The configuration object
Returns- Required
-
-
createConfiguration
import { embed } from '@nebula.js/stardust';
// create a 'master' config which registers all types
const m = embed.createConfiguration({
types: [{
name: 'mekko',
version: '1.0.0',
load: () => Promise.resolve(mekko)
}],
});
// create an alternate config with dark theme
// and inherit the config from the previous
const d = m.createConfiguration({
context: {
theme: 'dark'
}
});
m(app).render({ type: 'mekko' }); // will render the object with default theme
d(app).render({ type: 'mekko' }); // will render the object with 'dark' theme
embed(app).render({ type: 'mekko' }); // will throw error since 'mekko' is not a register type on the default instance
Creates a stateful value.
Parameters
- initialState S | functionRequired
The initial state.
Returns
- Array< S , SetStateFn >Required
The value and a function to update it.
useState
import { useState } from '@nebula.js/stardust';
// ...
// initiate with simple primitive value
const [zoomed, setZoomed] = useState(false);
// update
setZoomed(true);
// lazy initiation
const [value, setValue] = useState(() => heavy());
Triggers a callback function when a dependent value changes.
Omitting the dependency array will have the hook run on each update and an empty dependency array runs only once.
Parameters
- effect EffectCallbackRequired
The callback.
effect properties
- EffectCallback() functionRequired
Callback function that should return a function that in turns gets called before the hook runs again or when the component is destroyed. For example to remove any listeners added in the callback itself.
Returns- void | functionRequired
-
-
- deps Array< any >
The dependencies that should trigger the callback.
useEffect
import { useEffect } from '@nebula.js/stardust';
// ...
useEffect(() => {
console.log('mounted');
return () => {
console.log('unmounted');
};
}, []);
useEffect(() => {
const clickHandler = () => { console.log('click') };
const button = element.querySelector('.button');
button.addEventListener('click', clickHandler);
return () => {
button.removeEventListener('click', clickHandler);
};
}, []);
Creates a stateful value when a dependent changes.
Parameters
- factory() functionRequired
The factory function.
Returns- TRequired
-
- deps Array< any >Required
The dependencies.
Returns
- TRequired
The value returned from the factory function.
useMemo
import { useMemo } from '@nebula.js/stardust';
// ...
const v = useMemo(() => {
return doSomeHeavyCalculation();
}), []);
Runs a callback function when a dependent changes.
Useful for async operations that otherwise cause no side effects. Do not add for example listeners withing the callback as there is no teardown function.
Parameters
- factory() functionRequired
The factory function that calls the promise.
Returns- Promise < P >Required
-
- deps Array< any >
The dependencies.
Returns
- Array< P , Error >Required
The resolved value or rejected error
usePromise
import { usePromise } from '@nebula.js/stardust';
import { useModel } from '@nebula.js/stardust';
// ...
const model = useModel();
const [resolved, rejected] = usePromise(() => model.getLayout(), [model]);
Gets the HTMLElement this visualization is rendered into.
Returns
- HTMLElementRequired
useElement
import { useElement } from '@nebula.js/stardust';
// ...
const el = useElement();
el.innerHTML = 'Hello!';
Gets the size of the HTMLElement the visualization is rendered into.
Returns
- Required
The size of the element.
properties
- top numberRequired
- left numberRequired
- width numberRequired
- height numberRequired
-
useRect
import { useRect } from '@nebula.js/stardust';
// ...
const rect = useRect();
useEffect(() => {
console.log('resize');
}, [rect.width, rect.height])
Gets the layout of the generic object associated with this visualization.
Returns
- qix.GenericObjectLayoutRequired
useLayout
import { useLayout } from '@nebula.js/stardust';
// ...
const layout = useLayout();
console.log(layout);
Gets the layout of the generic object associated with this visualization.
Unlike the regular layout, a stale layout is not changed when a generic object enters
the modal state. This is mostly notable in that qSelectionInfo.qInSelections
in the layout is
always false
.
The returned value from useStaleLayout()
and useLayout()
are identical when the object
is not in a modal state.
Returns
- qix.GenericObjectLayoutRequired
useStaleLayout
import { useStaleLayout } from '@nebula.js/stardust';
// ...
const staleLayout = useStaleLayout();
console.log(staleLayout);
Gets the layout of the app associated with this visualization.
Returns
- qix.NxAppLayoutRequired
The app layout
useAppLayout
import { useAppLayout } from '@nebula.js/stardust';
// ...
const appLayout = useAppLayout();
console.log(appLayout.qLocaleInfo);
Gets the generic object API of the generic object connected to this visualization.
Returns
- qix.GenericObject | undefinedRequired
useModel
import { useModel } from '@nebula.js/stardust';
// ...
const model = useModel();
useEffect(() => {
model.getInfo().then(info => {
console.log(info);
})
}, []);
useApp
import { useApp } from '@nebula.js/stardust';
// ...
const app = useApp();
useEffect(() => {
app.getAllInfos().then(infos => {
console.log(infos);
})
}, []);
useGlobal
import { useGlobal } from '@nebula.js/stardust';
// ...
const g = useGlobal();
useEffect(() => {
g.engineVersion().then(version => {
console.log(version);
})
}, []);
Gets the object selections.
Returns
- Required
The object selections.
properties
- addListener() functionRequired
Event listener function on instance
Parameters- eventType stringRequired
event type that function needs to listen
- callback() functionRequired
a callback function to run when event emits
-
- removeListener() functionRequired
Remove listener function on instance
Parameters- eventType stringRequired
event type that function needs to listen
- callback() functionRequired
a callback function to run when event emits
-
- begin() functionRequiredParameters
- paths Array< string >Required
Returns- Promise < undefined >Required
-
- clear() functionRequiredReturns
- Promise < undefined >Required
-
- confirm() functionRequiredReturns
- Promise < undefined >Required
-
- cancel() functionRequiredReturns
- Promise < undefined >Required
-
- select() functionRequiredParameters
- s objectRequired
s properties
- method stringRequired
- params Array< any >Required
-
Returns- Promise < boolean >Required
-
- canClear() functionRequiredReturns
- booleanRequired
-
- canConfirm() functionRequiredReturns
- booleanRequired
-
- canCancel() functionRequiredReturns
- booleanRequired
-
- isActive() functionRequiredReturns
- booleanRequired
-
- isModal() functionRequiredReturns
- booleanRequired
-
- goModal() functionRequiredParameters
- paths Array< string >Required
Returns- Promise < undefined >Required
-
- noModal() functionRequiredParameters
- accept boolean
Returns- Promise < undefined >Required
-
-
useSelections
import { useSelections } from '@nebula.js/stardust';
import { useElement } from '@nebula.js/stardust';
import { useEffect } from '@nebula.js/stardust';
// ...
const selections = useSelections();
const element = useElement();
useEffect(() => {
const onClick = () => {
selections.begin('/qHyperCubeDef');
};
element.addEventListener('click', onClick);
return () => {
element.removeEventListener('click', onClick);
};
}, []);
Gets the theme.
Returns
- Required
The theme.
properties
- name() functionRequired
Returns theme name
Returns- stringRequired
Current theme.
-
- getDataColorScales() functionRequiredReturns
- Array< ScalePalette >Required
-
- getDataColorPalettes() functionRequiredReturns
- Array< DataPalette >Required
-
- getDataColorPickerPalettes() functionRequiredReturns
- Array< ColorPickerPalette >Required
-
- getDataColorSpecials() functionRequiredReturns
- Required
properties
- primary stringRequired
- nil stringRequired
- others stringRequired
-
-
- getColorPickerColor() functionRequired
Resolve a color object using the color picker palette from the provided JSON theme.
Parameters- c objectRequired
c properties
- index number
- color string
-
- supportNone boolean
Shifts the palette index by one to account for the "none" color
Returns- stringRequired
The resolved color.
-
- getContrastingColorTo() functionRequired
Get the best contrasting color against the specified
color
. This is typically used to find a suitable text color for a label placed on an arbitrarily colored background.The returned colors are derived from the theme.
Parameters- color stringRequired
A color to measure the contrast against
Returns- stringRequired
- The color that has the best contrast against the specified
color
.
- The color that has the best contrast against the specified
-
- getStyle() functionRequired
Get the value of a style attribute in the theme by searching in the theme's JSON structure. The search starts at the specified base path and continues upwards until the value is found. If possible it will get the attribute's value using the given path. When attributes separated by dots are provided, such as 'hover.color', they are required in the theme JSON file
Parameters- basePath stringRequired
Base path in the theme's JSON structure to start the search in (specified as a name path separated by dots).
- path stringRequired
Expected path for the attribute (specified as a name path separated by dots).
- attribute stringRequired
Name of the style attribute. (specified as a name attribute separated by dots).
Returns- string | undefinedRequired
The style value or undefined if not found
-
-
useTheme
import { useTheme } from '@nebula.js/stardust';
const theme = useTheme();
console.log(theme.getContrastingColorTo('#ff0000'));
Gets the embed instance used.
Returns
- Required
The embed instance used.
properties
- render() functionRequired
Renders a visualization or sheet into an HTMLElement. Visualizations can either be existing objects or created on the fly. Support for sense sheets is experimental.
Parameters- cfg RenderConfigRequired
The render configuration.
cfg properties
- element HTMLElementRequired
Target html element to render in to
- options object
Options passed into the visualisation
- plugins Array< Plugin >
plugins passed into the visualisation
- id string
For existing objects: Engine identifier of object to render
- type string
For creating objects: Type of visualisation to render
- version string
For creating objects: Version of visualization to render
- fields Array< Field >
For creating objects: Data fields to use
- extendProperties boolean
For creating objects: Whether to deeply extend properties or not. If false then subtrees will be overwritten.
- properties qix.GenericObjectProperties
For creating objects: Explicit properties to set
-
Returns-
A controller to the rendered visualization or sheet.
-
- create() functionRequired
Creates a visualization model
Parameters- cfg CreateConfigRequired
The create configuration.
cfg properties
- type stringRequired
- version string
- fields Array< Field >
- properties qix.GenericObjectProperties
-
Returns- Promise < qix.GenericObject >Required
An engima model
-
- generateProperties() functionRequired
Generates properties for a visualization object
Parameters- cfg CreateConfigRequired
The create configuration.
Returns- Promise < object >Required
The objects properties
-
- context() functionRequired
Updates the current context of this embed instance. Use this when you want to change some part of the current context, like theme.
Parameters- ctx ContextRequired
The context to update.
ctx properties
- theme string
- language string
- deviceType string
-
constraints properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
- interactions Interactions
interactions properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
- boolean
- disableCellPadding boolean
- dataViewType string
Type used for toggling to the data view (toggleDataView) This type need to be registered as well
-
Returns- Promise < undefined >Required
-
- selections() functionRequired
Gets the app selections of this instance.
Returns- Promise < AppSelections >Required
-
- field() functionRequiredAvailable since: 1.1.0
Gets the listbox instance of the specified field
Parameters- fieldIdentifier string | LibraryField | QInfoRequired
Fieldname as a string, a Library dimension or an object id
Returns- Promise < FieldInstance >Required
-
- getRegisteredTypes() functionRequired
Gets a list of registered visualization types and versions
Returns- Array< Object >Required
types
-
-
useEmbed
import { useEmbed } from '@nebula.js/stardust';
const embed = useEmbed();
embed.render(...)
Gets the translator.
Returns
- Required
The translator.
properties
- language() functionRequired
Returns current locale.
Parameters- lang string
language Locale to updated the currentLocale value
Returns- stringRequired
current locale.
-
- add() functionRequired
Registers a string in multiple locales
Parameters- item objectRequired
item properties
- id stringRequired
- locale objectRequired
-
-
- get() functionRequired
Translates a string for current locale.
Parameters- str stringRequired
ID of the registered string.
- args Array< string >
Values passed down for string interpolation.
Returns- stringRequired
The translated string.
-
-
useTranslator
import { useTranslator } from '@nebula.js/stardust';
// ...
const translator = useTranslator();
console.log(translator.get('SomeString'));
Gets the device type. ('touch' or 'desktop')
Returns
- stringRequired
device type.
useDeviceType
import { useDeviceType } from '@nebula.js/stardust';
// ...
const deviceType = useDeviceType();
if (deviceType === 'touch') { ... };
Gets the navigation api to control sheet navigation. When useNavigation is used in Sense, it returns Sense.navigation.
Returns
- Required
navigation api.
properties
- functionRequiredExperimentalAvailable since: 5.4.0
Navigate to the supplied sheet and emit 'sheetChanged' event if the target sheet Id is valid. This allows a navigation object to synchronize its current sheet item with the active sheet.
Parameters- stringRequired
Id of the sheet to navigate to
-
- functionRequiredExperimentalAvailable since: 5.4.0
Return the current sheet id
Returns- string | falseRequired
The current sheet Id. false means there is no current sheet.
-
-
useNavigation
Gets the array of plugins provided when rendering the visualization.
Returns
- Array< Plugin >Required
array of plugins.
usePlugins
// provide plugins that can be used when rendering
embed(app).render({
element,
type: 'my-chart',
plugins: [plugin]
});
// It's up to the chart implementation to make use of plugins in any way
import { usePlugins } from '@nebula.js/stardust';
// ...
const plugins = usePlugins();
plugins.forEach((plugin) => {
// Invoke plugin
plugin.fn();
});
Registers a custom action.
Parameters
- factory() functionRequiredReturns
- Required
properties
- action ARequired
- boolean
- disabled boolean
- icon object
icon properties
- viewBox string
- shapes Array< object >Required
-
-
-
- deps Array< any >
Returns
- ARequired
useAction
import { useAction } from '@nebula.js/stardust';
// ...
const [zoomed, setZoomed] = useState(false);
const act = useAction(() => ({
hidden: false,
disabled: zoomed,
action() {
setZoomed(prev => !prev);
},
icon: {}
}), [zoomed]);
Gets the desired constraints that should be applied when rendering the visualization.
The constraints are set on the embed configuration before the visualization is rendered and should be respected when implementing the visualization.
Returns
- Required
properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
useConstraints
// configure embed to disallow active interactions when rendering
embed(app, {
context: {
constraints: {
active: true, // do not allow interactions
}
}
}).render({ element, id: 'sdfsdf' });
import { useConstraints } from '@nebula.js/stardust';
// ...
const constraints = useConstraints();
useEffect(() => {
if (constraints.active) {
// do not add any event listener if active constraint is set
return undefined;
}
const listener = () => {};
element.addEventListener('click', listener);
return () => {
element.removeEventListener('click', listener);
};
}, [constraints])
Gets the desired interaction states that should be applied when rendering the visualization.
The interactions are set on the embed configuration before the visualization is rendered and should be respected when implementing the visualization.
Returns
- Required
properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
useInteractionState
// configure embed to disallow active interactions when rendering
embed(app, {
context: {
interactions: {
active: false, // do not allow interactions
}
}
}).render({ element, id: 'sdfsdf' });
import { useInteractionState } from '@nebula.js/stardust';
// ...
const interactions = useInteractionState();
useEffect(() => {
if (!interactions.active) {
// do not add any event listener if active constraint is set
return undefined;
}
const listener = () => {};
element.addEventListener('click', listener);
return () => {
element.removeEventListener('click', listener);
};
}, [interactions])
Gets the options object provided when rendering the visualization.
This is an empty object by default but enables customization of the visualization through this object. Options are different from setting properties on the generic object in that options are only temporary settings applied to the visualization when rendered.
You have the responsibility to provide documentation of the options you support, if any.
Returns
- objectRequired
useOptions
// when embedding the visualization, anything can be set in options
embed(app).render({
element,
type: 'my-chart',
options: {
showNavigation: true,
}
});
// it is up to you use and implement the provided options
import { useOptions } from '@nebula.js/stardust';
import { useEffect } from '@nebula.js/stardust';
// ...
const options = useOptions();
useEffect(() => {
if (!options.showNavigation) {
// hide navigation
} else {
// show navigation
}
}, [options.showNavigation]);
This is an empty object by default, but enables you to provide a custom API of your visualization to make it possible to control after it has been rendered.
You can only use this hook once, calling it more than once is considered an error.
Parameters
- factory() functionRequiredReturns
- TRequired
-
- deps Array< any >
useImperativeHandle
import { useImperativeHandle } form '@nebula.js/stardust';
// ...
useImperativeHandle(() => ({
resetZoom() {
setZoomed(false);
}
}));
// when embedding the visualization, you can get a handle to this API
// and use it to control the visualization
const ctl = await embed(app).render({
element,
type: 'my-chart',
});
ctl.getImperativeHandle().resetZoom();
Registers a callback that is called when a snapshot is taken.
Parameters
- snapshotCallback() functionRequiredParameters
- qix.GenericObjectLayoutRequired
Returns- Promise < qix.GenericObjectLayout >Required
-
onTakeSnapshot
import { onTakeSnapshot } from '@nebula.js/stardust';
import { useState } from '@nebula.js/stardust';
import { useLayout } from '@nebula.js/stardust';
const layout = useLayout();
const [zoomed] = useState(layout.isZoomed || false);
onTakeSnapshot((copyOfLayout) => {
copyOfLayout.isZoomed = zoomed;
return Promise.resolve(copyOfLayout);
});
Gets render state instance.
Used to update properties and get a new layout without triggering onInitialRender.
Returns
- Required
The render state.
properties
- pending anyRequired
- restore anyRequired
-
useRenderState
import { useRenderState } from '@nebula.js/stardust';
const renderState = useRenderState();
useState(() => {
if(needPropertiesUpdate(...)) {
useRenderState.pending();
updateProperties(...);
} else {
useRenderState.restore();
...
}
}, [...]);
Gets an event emitter instance for the visualization.
Returns
- Required
properties
- Emitter classRequired
-
useEmitter
// In a Nebula visualization
import { useEmitter } from '@nebula.js/stardust';
useEffect(()=> {
// on some trigger
emitter.emit("trigger", params)
}, [...])
// In a mashup
const viz = await n.render({
element: el,
id: 'abcdef'
});
viz.addListener("trigger", ()=> {
// do something
})
Gets the desired keyboard settings and status to applied when rendering the visualization.
A visualization should in general only have tab stops if either keyboard.enabled
is false or if active is true.
This means that either Nebula isn't configured to handle keyboard input or the chart is currently focused.
Enabling or disabling keyboardNavigation are set on the embed configuration and
should be respected by the visualization.
Returns
- Required
properties
- enabled booleanRequired
Whether or not Nebula handles keyboard navigation or not.
- active booleanRequired
Set to true when the chart is activated, ie a user tabs to the chart and presses Enter or Space.
- blur() function
Function used by the visualization to tell Nebula it wants to relinquish focus
Parameters- booleanRequired
-
- focus() function
Function used by the visualization to tell Nebula it wants to focus
- focusSelection() function
Function used by the visualization to tell Nebula that focus the selection toolbar
Parameters- booleanRequired
-
-
useKeyboard
// configure nebula to enable navigation between charts
embed(app, {
context: {
keyboardNavigation: true, // tell Nebula to handle navigation
}
}).render({ element, id: 'sdfsdf' });
import { useKeyboard } from '@nebula.js/stardust';
// ...
const keyboard = useKeyboard();
useEffect(() => {
// Set a tab stop on our button if in focus or if Nebulas navigation is disabled
button.setAttribute('tabIndex', keyboard.active || !keyboard.enabled ? 0 : -1);
// If navigation is enabled and focus has shifted, lets focus the button
keyboard.enabled && keyboard.active && button.focus();
}, [keyboard])
Provides conversion functionality to extensions.
Properties
- hypercube hyperCubeConversionRequiredAvailable since: 1.1.0
Provides conversion functionality to extensions with hyperCubes.
hypercube properties
- hyperCubeConversion interfaceRequiredAvailable since: 1.1.0
-
Conversion
import { conversion } from '@nebula.js/stardust';
export default function() {
return {
qae: {
...
importProperties: ( exportFormat, initialProperties ) => conversion.hyperCube.importProperties(exportFormat, initialProperties),
exportProperties: ( fullPropertyTree ) => conversion.hyperCube.exportProperties(fullPropertyTree)
},
...
};
}
Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visualisation and specifies how it behaves. For example, what layout to use the data to present.
The generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for app.getObject(id)
. For example, the property getLayout
in the generic object is used to define app.getObject(id).getLayout()
. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).
The value for each property is either fixed (string / boolean / number / object) or a function. Arguments are forwarded to the function to allow for greater flexibility. For example, this can be used to return different hypercube data when scrolling in the chart.
Parameters
- genericObjects Array< object >Required
Generic objects controlling behaviour of visualizations.
- options EnigmaMockerOptions
Options
options properties
- delay numberRequired
Simulate delay (in ms) for calls in enigma-mocker.
-
Returns
- Promise < qix.Doc >Required
fromGenericObjects
const genericObject = {
getLayout() {
return {
qInfo: {
qId: 'qqj4zx',
qType: 'sn-grid-chart'
},
...
}
},
getHyperCubeData(path, page) {
return [ ... ];
}
};
const app = await EnigmaMocker.fromGenericObjects([genericObject]);
Properties
- key stringRequired
The key of the component. Currently supporting components "theme" and "selections".
Component
const n = embed(app);
const inst = await n.field('field_name');
inst.mount(document.querySelector('.listbox'), {
components: [{
key: 'theme',
header: {
fontColor: { color: '#f00' },
fontSize: 23,
},
content: {
fontSize: 16,
useContrastColor: false,
}
},{
key: 'selections',
colors: {
selected: { color: '#0f0' },
alternative: { color: '#ededed' },
excluded: { color: '#ccc' },
selectedExcluded: { color: '#bbb' },
possible: { color: '#fefefe' },
possible: { color: '#fefefe' },
}
}]
});
Fallback load function for missing types
Parameters
- Required
properties
- LoadType interfaceRequiredParameters
- type objectRequired
type properties
- name stringRequired
- version stringRequired
-
Returns- Promise < Visualization >Required
-
-
Returns
- Promise < Visualization >Required
Properties
- load LoadFallback
Fallback load function for missing types
load properties
- LoadFallback() functionRequired
Fallback load function for missing types
Parameters- Required
properties
- LoadType interfaceRequiredParameters
- type objectRequired
type properties
- name stringRequired
- version stringRequired
-
Returns- Promise < Visualization >Required
-
-
Returns- Promise < Visualization >Required
-
-
- context Context
Settings for the rendering instance
context properties
- theme string
- language string
- deviceType string
-
constraints properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
- interactions Interactions
interactions properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
- boolean
- disableCellPadding boolean
- dataViewType string
Type used for toggling to the data view (toggleDataView) This type need to be registered as well
-
- types Array< TypeInfo >
Visualization types to register
- themes Array< ThemeInfo >
Themes to register
- hostConfig object
Qlik api compatible host config, see https://github.com/qlik-oss/qlik-api-ts/blob/main/docs/authentication.md#the-host-config
- anything object
Configuration
import { embed } from '@nebula.js/stardust'
n = embed(app, {
context: {
keyboardNavigation: true,
theme: 'purple',
},
load: ({ name, version }) => {
if (name === 'linechart') {
return Promise.resolve(line);
}
},
types: [
{
name: 'bar',
load: () => Promise.resolve(bar),
},
],
themes: [
{
id: 'purple',
load: () => Promise.resolve(purpleThemeJson),
},
],
});
Properties
- theme string
- language string
- deviceType string
-
constraints properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
- interactions Interactions
interactions properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
- boolean
- disableCellPadding boolean
- dataViewType string
Type used for toggling to the data view (toggleDataView) This type need to be registered as well
Properties
- translator TranslatorRequired
translator properties
- language() functionRequired
Returns current locale.
Parameters- lang string
language Locale to updated the currentLocale value
Returns- stringRequired
current locale.
-
- add() functionRequired
Registers a string in multiple locales
Parameters- item objectRequired
item properties
- id stringRequired
- locale objectRequired
-
-
- get() functionRequired
Translates a string for current locale.
Parameters- str stringRequired
ID of the registered string.
- args Array< string >
Values passed down for string interpolation.
Returns- stringRequired
The translated string.
-
-
- flags FlagsRequired
flags properties
- isEnabled() functionRequired
Checks whether the specified flag is enabled.
Parameters- flag stringRequired
The value flag to check.
Returns- booleanRequired
True if the specified flag is enabled, false otherwise.
-
-
- deviceType stringRequired
- hostConfig objectRequired
- anything objectRequired
Renders a visualization or sheet into an HTMLElement. Visualizations can either be existing objects or created on the fly. Support for sense sheets is experimental.
Parameters
- cfg RenderConfigRequired
The render configuration.
cfg properties
- element HTMLElementRequired
Target html element to render in to
- options object
Options passed into the visualisation
- plugins Array< Plugin >
plugins passed into the visualisation
- id string
For existing objects: Engine identifier of object to render
- type string
For creating objects: Type of visualisation to render
- version string
For creating objects: Version of visualization to render
- fields Array< Field >
For creating objects: Data fields to use
- extendProperties boolean
For creating objects: Whether to deeply extend properties or not. If false then subtrees will be overwritten.
- properties qix.GenericObjectProperties
For creating objects: Explicit properties to set
-
render
// render from existing object
n.render({
element: el,
id: 'abcdef'
});
// render on the fly
n.render({
element: el,
type: 'barchart',
fields: ['Product', { qLibraryId: 'u378hn', type: 'measure' }]
});
Creates a visualization model
Parameters
- cfg CreateConfigRequired
The create configuration.
cfg properties
- type stringRequired
- version string
- fields Array< Field >
- properties qix.GenericObjectProperties
-
Returns
- Promise < qix.GenericObject >Required
An engima model
create
// create a barchart in the app and return the model
const model = await n.create({
type: 'barchart',
fields: ['Product', { qLibraryId: 'u378hn', type: 'measure' }],
properties: { showTitle: true }
}
);
Generates properties for a visualization object
Parameters
- cfg CreateConfigRequired
The create configuration.
Returns
- Promise < object >Required
The objects properties
generateProperties
// generate properties for a barchart
const properties = await n.generateProperties({
type: 'barchart',
fields: ['Product', { qLibraryId: 'u378hn', type: 'measure' }],
properties: { showTitle: true }
},
);
Updates the current context of this embed instance. Use this when you want to change some part of the current context, like theme.
Parameters
- ctx ContextRequired
The context to update.
ctx properties
- theme string
- language string
- deviceType string
-
constraints properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
-
- interactions Interactions
interactions properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
-
- boolean
- disableCellPadding boolean
- dataViewType string
Type used for toggling to the data view (toggleDataView) This type need to be registered as well
-
Returns
- Promise < undefined >Required
context
// change theme
n.context({ theme: 'dark'});
// change interactions
n.context({ interactions: { select: false } });
Gets the app selections of this instance.
Returns
- Promise < AppSelections >Required
selections
const selections = await n.selections();
selections.mount(element);
Gets the listbox instance of the specified field
Parameters
- fieldIdentifier string | LibraryField | QInfoRequired
Fieldname as a string, a Library dimension or an object id
Returns
- Promise < FieldInstance >Required
field
const fieldInstance = await n.field("MyField");
fieldInstance.mount(element, { title: "Hello Field"});
Gets a list of registered visualization types and versions
Returns
- Array< Object >Required
types
getRegisteredTypes
const types = n.getRegisteredTypes();
// Contains
//[
// {
// name: "barchart"
// versions:[undefined, "1.2.0"]
// }
//]
Event listener function on instance
Parameters
- eventType FieldEventTypesRequired
event type that function needs to listen
eventType properties
- FieldEventTypes 'selectionActivated' | 'selectionDeactivated'Required
-
- callback() functionRequired
a callback function to run when event emits
on
const handleSomeEvent () => {...};
fieldInstance.on('someEvent', handleSomeEvent);
...
fieldInstance.removeListener('someEvent', handleSomeEvent);
Remove listener on instance
Parameters
- eventType FieldEventTypesRequired
event type
- callback() functionRequired
handler
Mounts the field as a listbox into the provided HTMLElement.
Parameters
- element HTMLElementRequired
- options object
Settings for the embedded listbox
options properties
- title string
Custom title, defaults to fieldname (not applicable for existing objects)
- direction Direction
Direction setting ltr|rtl.
direction properties
- Direction 'ltr' | 'rtl'Required
-
- listLayout ListLayout
Layout direction vertical|horizontal (not applicable for existing objects)
listLayout properties
- ListLayout 'vertical' | 'horizontal'Required
-
- frequencyMode FrequencyMode
Show frequency none|value|percent|relative
frequencyMode properties
- FrequencyMode 'none' | 'value' | 'percent' | 'relative'Required
-
- histogram boolean
Show histogram bar (not applicable for existing objects)
- search SearchMode
Show the search bar permanently, using the toggle button or when in selection: false|true|toggle
search properties
- SearchMode boolean | 'toggle'Required
-
- showLock boolean
Show the button for toggling locked state.
- toolbar boolean
Show the toolbar
- checkboxes boolean
Show values as checkboxes instead of as fields (not applicable for existing objects)
- dense boolean
Reduces padding and text size (not applicable for existing objects)
- stateName string
Sets the state to make selections in (not applicable for existing objects)
- components Array< Component >
Override individual components' styling, otherwise set by the theme or the default style.
- properties object
Properties object to extend default properties with
-
Returns
- Promise < void >Required
A promise that resolves when the data is fetched.
mount
fieldInstance.mount(element);
unmount
listbox.unmount();
A function that should return a Promise that resolves to a raw JSON theme.
Returns
- Promise < ThemeJSON >Required
A controller to further modify a visualization after it has been rendered.
Properties
- id stringRequired
The id of this sheets's generic object.
- model stringRequired
This sheets Enigma model, a representation of the generic object.
- RequiredExperimentalAvailable since: 5.4.0
The navigation api to control sheet navigation.
navigation properties
- functionRequiredExperimentalAvailable since: 5.4.0
Navigate to the supplied sheet and emit 'sheetChanged' event if the target sheet Id is valid. This allows a navigation object to synchronize its current sheet item with the active sheet.
Parameters- stringRequired
Id of the sheet to navigate to
-
- functionRequiredExperimentalAvailable since: 5.4.0
Return the current sheet id
Returns- string | falseRequired
The current sheet Id. false means there is no current sheet.
-
-
Sheet
const sheet = await embed(app).render({
element,
id: "jD5Gd"
});
sheet.destroy();
destroy
const sheet = await embed(app).render({
element,
id: "jD5Gd"
});
sheet.destroy();
A controller to further modify a visualization after it has been rendered.
Properties
- id stringRequired
The id of this visualization's generic object.
- model qix.GenericObjectRequired
This visualizations Enigma model, a representation of the generic object.
Viz
const viz = await embed(app).render({
element,
type: 'barchart'
});
viz.destroy();
destroy
const viz = await embed(app).render({
element,
id: 'abc'
});
viz.destroy();
Converts the visualization to a different registered type.
Will update properties if permissions allow, else will patch (can be forced with forcePatch parameter)
Not all chart types are compatible, similar structures are required.
Parameters
- newType stringRequired
Which registered type to convert to.
- forceUpdate boolean
Whether to apply the change or not, else simply returns the resulting properties, defaults to true.
- forcePatch boolean
Whether to always patch the change instead of making a permanent change
Returns
- Promise < object >Required
Promise object that resolves to the full property tree of the converted visualization.
convertTo
const viz = await embed(app).render({
element,
id: 'abc'
});
await viz.convertTo('barChart');
// Change the barchart to a linechart, only in the current session
const newProperties = await viz.convertTo('lineChart', false, true);
// Remove the conversion by clearing the patches
await viz.model.clearSoftPatches();
Toggles the chart to a data view of the chart.
The chart will be toggled to the type defined in the nebula context (dataViewType).
The default dataViewType for nebula is sn-table. The specified chart type needs to be registered as well, in order to make it possible to render the data view.
Parameters
- showDataView boolean
If included, forces the chart into a specific state. True will show data view, and false will show the original chart. If not included it will always toggle between the two views.
Listens to custom events from inside the visualization. See useEmitter
Parameters
- eventName stringRequired
Event name to listen to
- listener() functionRequired
Callback function to invoke
Removes a listener
Parameters
- eventName stringRequired
Event name to remove from
- listener() functionRequired
Callback function to remove
Gets the specific api that a Viz exposes.
Returns
- Promise < object >Required
object that contains the internal Viz api.
Checks whether the specified flag is enabled.
Parameters
- flag stringRequired
The value flag to check.
Returns
- booleanRequired
True if the specified flag is enabled, false otherwise.
Mounts the app selection UI into the provided HTMLElement.
Parameters
- element HTMLElementRequired
mount
selections.mount(element);
unmount
selections.unmount();
Event listener function on instance
Parameters
- eventType stringRequired
event type that function needs to listen
- callback() functionRequired
a callback function to run when event emits
addListener
api.addListener('someEvent', () => {...});
Remove listener function on instance
Parameters
- eventType stringRequired
event type that function needs to listen
- callback() functionRequired
a callback function to run when event emits
removeListener
api.removeListener('someEvent', () => {...});
Parameters
- paths Array< string >Required
Returns
- Promise < undefined >Required
Parameters
- s objectRequired
s properties
- method stringRequired
- params Array< any >Required
-
Returns
- Promise < boolean >Required
Parameters
- paths Array< string >Required
Returns
- Promise < undefined >Required
Parameters
- accept boolean
Returns
- Promise < undefined >Required
Field string | qix.NxDimension | qix.NxMeasure | LibraryField
Rendering configuration for creating and rendering a new object
Properties
- type stringRequired
- version string
- fields Array< Field >
- properties qix.GenericObjectProperties
Configuration for rendering a visualisation, either creating or fetching an existing object.
Properties
- element HTMLElementRequired
Target html element to render in to
- options object
Options passed into the visualisation
- plugins Array< Plugin >
plugins passed into the visualisation
- id string
For existing objects: Engine identifier of object to render
- type string
For creating objects: Type of visualisation to render
- version string
For creating objects: Version of visualization to render
- fields Array< Field >
For creating objects: Data fields to use
- extendProperties boolean
For creating objects: Whether to deeply extend properties or not. If false then subtrees will be overwritten.
- properties qix.GenericObjectProperties
For creating objects: Explicit properties to set
RenderConfig
// A config for Creating objects:
const createConfig = {
type: 'bar',
element: document.querySelector('.bar'),
extendProperties: true,
fields: ['[Country names]', '=Sum(Sales)'],
properties: {
legend: {
show: false,
},
}
};
nebbie.render(createConfig);
// A config for rendering an existing object:
const createConfig = {
id: 'jG5LP',
element: document.querySelector('.line'),
};
nebbie.render(createConfig);
An object literal containing meta information about the plugin and a function containing the plugin implementation.
Properties
- info objectRequired
Object that can hold various meta info about the plugin
info properties
- name stringRequired
The name of the plugin
-
- fn functionRequired
The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.
Plugin
const plugin = {
info: {
name: "example-plugin",
type: "meta-type",
},
fn: () => {
// Plugin implementation goes here
}
};
Parameters
- type objectRequired
type properties
- name stringRequired
- version stringRequired
-
Returns
- Promise < Visualization >Required
Properties
- name stringRequired
- version string
- load LoadTypeRequired
load properties
- LoadType interfaceRequiredParameters
- type objectRequired
type properties
- name stringRequired
- version stringRequired
-
Returns- Promise < Visualization >Required
-
-
- meta object
Navigation
Navigate to the supplied sheet and emit 'sheetChanged' event if the target sheet Id is valid. This allows a navigation object to synchronize its current sheet item with the active sheet.
Parameters
- stringRequired
Id of the sheet to navigate to
Return the current sheet id
Returns
- string | falseRequired
The current sheet Id. false means there is no current sheet.
Properties
- className 'njs-action-toolbar-popover'Required
Properties
- className 'njs-cell-action'Required
Properties
- 'njs-cell-footer'Required
Properties
- className 'njs-cell-title'Required
Properties
- className 'njs-cell-sub-title'Required
Properties
- className 'njs-sheet'Required
Properties
- attributes VizElementAttributesRequired
attributes properties
- data-render-count stringRequired
-
- className 'njs-viz'Required
The entry point for defining a visualization.
Parameters
- galaxy GalaxyRequired
galaxy properties
- translator TranslatorRequired
translator properties
- language() functionRequired
Returns current locale.
Parameters- lang string
language Locale to updated the currentLocale value
Returns- stringRequired
current locale.
-
- add() functionRequired
Registers a string in multiple locales
Parameters- item objectRequired
item properties
- id stringRequired
- locale objectRequired
-
-
- get() functionRequired
Translates a string for current locale.
Parameters- str stringRequired
ID of the registered string.
- args Array< string >
Values passed down for string interpolation.
Returns- stringRequired
The translated string.
-
-
- flags FlagsRequired
flags properties
- isEnabled() functionRequired
Checks whether the specified flag is enabled.
Parameters- flag stringRequired
The value flag to check.
Returns- booleanRequired
True if the specified flag is enabled, false otherwise.
-
-
- deviceType stringRequired
- hostConfig objectRequired
- anything objectRequired
-
Returns
- Required
properties
- qae QAEDefinitionRequired
qae properties
- properties qix.GenericObjectProperties
- data object
data properties
- targets Array< DataTarget >Required
-
- importProperties importProperties
importProperties properties
- importProperties() functionRequiredAvailable since: 1.1.0
Imports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- exportFormat ExportFormatRequired
The export object which is the output of exportProperties.
- initialProperties Object
Initial properties of the target chart.
- dataDefinition Object
Data definition of the target chart.
- defaultPropertyValues Object
Default values for a number of properties of the target chart.
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- ObjectRequired
A properties tree
-
-
- exportProperties exportProperties
exportProperties properties
- exportProperties() functionRequiredAvailable since: 1.1.0
Exports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- propertyTree ObjectRequired
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- Required
properties
- data Array< ExportDataDef >
- properties object
-
-
-
-
- component() functionRequiredReturns
- voidRequired
-
-
Visualization
import { useElement, useLayout } from '@nebula.js/stardust';
export default function() {
return {
qae: {
properties: {
dude: 'Heisenberg',
}
},
component() {
const el = useElement();
const layout = useLayout();
el.innerHTML = `What's my name? ${layout.dude}!!!`;
}
};
}
Properties
- qae QAEDefinitionRequired
qae properties
- properties qix.GenericObjectProperties
- data object
data properties
- targets Array< DataTarget >Required
-
- importProperties importProperties
importProperties properties
- importProperties() functionRequiredAvailable since: 1.1.0
Imports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- exportFormat ExportFormatRequired
The export object which is the output of exportProperties.
- initialProperties Object
Initial properties of the target chart.
- dataDefinition Object
Data definition of the target chart.
- defaultPropertyValues Object
Default values for a number of properties of the target chart.
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- ObjectRequired
A properties tree
-
-
- exportProperties exportProperties
exportProperties properties
- exportProperties() functionRequiredAvailable since: 1.1.0
Exports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- propertyTree ObjectRequired
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- Required
properties
- data Array< ExportDataDef >
- properties object
-
-
-
-
Callback function that should return a function that in turns gets called before the hook runs again or when the component is destroyed. For example to remove any listeners added in the callback itself.
Returns
- void | functionRequired
Properties
- top numberRequired
- left numberRequired
- width numberRequired
- height numberRequired
Properties
- action ARequired
- boolean
- disabled boolean
- icon object
icon properties
- viewBox string
- shapes Array< object >Required
-
Properties
- passive boolean
Whether or not passive constraints are on. Should block any passive interaction by users, ie: tooltips
- active boolean
Whether or not active constraints are on. Should block any active interaction by users, ie: scroll, click
- select boolean
Whether or not select constraints are on. Should block any selection action. Implied when active is true.
- edit boolean
Whether or not edit actions are available. Should block any edit action.
Properties
- passive boolean
Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
- active boolean
Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
- select boolean
Whether or not select interactions are on. Allows selection actions. Implied when active is false.
- edit boolean
Whether or not edit actions are on. Allows edit actions.
The emitter instance. Implements https://nodejs.org/api/events.html#class-eventemitter.
Properties
- enabled booleanRequired
Whether or not Nebula handles keyboard navigation or not.
- active booleanRequired
Set to true when the chart is activated, ie a user tabs to the chart and presses Enter or Space.
Function used by the visualization to tell Nebula it wants to relinquish focus
Parameters
- booleanRequired
Function used by the visualization to tell Nebula that focus the selection toolbar
Parameters
- booleanRequired
Imports properties for a chart with a hypercube.
Parameters
- args objectRequired
args properties
- exportFormat ExportFormatRequired
The export object which is the output of exportProperties.
exportFormat properties
- data Array< ExportDataDef >
- properties object
-
- initialProperties Object
Initial properties of the target chart.
- dataDefinition Object
Data definition of the target chart.
- defaultPropertyValues Object
Default values for a number of properties of the target chart.
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns
- ObjectRequired
A properties tree
Exports properties for a chart with a hypercube.
Parameters
- args objectRequired
args properties
- propertyTree ObjectRequired
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns
- Required
properties
- data Array< ExportDataDef >
- properties object
-
Properties
- properties qix.GenericObjectProperties
- data object
data properties
- targets Array< DataTarget >Required
-
- importProperties importProperties
importProperties properties
- importProperties() functionRequiredAvailable since: 1.1.0
Imports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- exportFormat ExportFormatRequired
The export object which is the output of exportProperties.
- initialProperties Object
Initial properties of the target chart.
- dataDefinition Object
Data definition of the target chart.
- defaultPropertyValues Object
Default values for a number of properties of the target chart.
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- ObjectRequired
A properties tree
-
-
- exportProperties exportProperties
exportProperties properties
- exportProperties() functionRequiredAvailable since: 1.1.0
Exports properties for a chart with a hypercube.
Parameters- args objectRequired
args properties
- propertyTree ObjectRequired
- hypercubePath stringRequired
Reference to the qHyperCubeDef.
-
Returns- Required
properties
- data Array< ExportDataDef
-
-
-