jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 17:58:43 -05:00
Code Issues Projects Releases Wiki Activity

docs: update jsdocs enabling possibility to generate typescript defs (#750)

Browse Source
This commit is contained in:
Thomas Bengtsson
2022-02-04 08:36:24 +01:00
committed by GitHub
parent 09f4627bd1
commit ea50d8cf56
11 changed files with 231 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apis/conversion/src/export-format.js
View File

@@ -13,10 +13,10 @@
/** /**
* @since 1.1.0 * @since 1.1.0
* @interface ExportDataDef * @interface ExportDataDef
* @property {qae.NxDimension[]} dimensions * @property {EngineAPI.INxDimension[]} dimensions
* @property {qae.NxMeasure[]} measures * @property {EngineAPI.INxMeasure[]} measures
* @property {qae.NxDimension[]} excludedDimensions * @property {EngineAPI.INxDimension[]} excludedDimensions
* @property {qae.NxMeasure[]} excludedMeasures * @property {EngineAPI.INxMeasure[]} excludedMeasures
* @property {number[]} interColumnSortOrder * @property {number[]} interColumnSortOrder
*/ */

20
apis/nucleus/spec/spec.conf.js
View File

@@ -12,20 +12,20 @@ module.exports = {
}, },
parse: { parse: {
types: { types: {
'enigma.Doc': { 'EngineAPI.IApp': {
url: 'https://github.com/qlik-oss/enigma.js/blob/master/docs/api.md#generated-api', url: 'https://qlik.dev/apis/json-rpc/qix/doc#%23%2Fentries%2FDoc',
}, },
'qae.GenericObjectLayout': { 'EngineAPI.IGenericObjectLayout': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#genericobjectlayout', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectLayout',
}, },
'qae.GenericObjectProperties': { 'EngineAPI.IGenericObjectProperties': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#genericobjectproperties', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties',
}, },
'qae.NxDimension': { 'EngineAPI.INxDimension': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#nxdimension', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxDimension',
}, },
'qae.NxMeasure': { 'EngineAPI.INxMeasure': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#nxmeasure', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxMeasure',
}, },
}, },
}, },

8
apis/nucleus/src/components/Supernova.jsx
View File

@@ -3,10 +3,16 @@ import InstanceContext from '../contexts/InstanceContext';
import useRect from '../hooks/useRect'; import useRect from '../hooks/useRect';
import RenderDebouncer from '../utils/render-debouncer'; import RenderDebouncer from '../utils/render-debouncer';
/**
* @interface VizElementAttributes
* @extends NamedNodeMap
* @property {string} data-render-count
*/
/** /**
* @interface * @interface
* @extends HTMLElement * @extends HTMLElement
* @property {string} attributes.data-render-count * @property {VizElementAttributes} attributes
*/ */
const VizElement = { const VizElement = {
/** @type {'njs-viz'} */ /** @type {'njs-viz'} */

6
apis/nucleus/src/index.js
View File

@@ -117,7 +117,7 @@ function nuked(configuration = {}) {
* Initiates a new `Embed` instance using the specified enigma `app`. * Initiates a new `Embed` instance using the specified enigma `app`.
* @entry * @entry
* @function embed * @function embed
* @param {enigma.Doc} app * @param {EngineAPI.IApp} app
* @param {Configuration=} instanceConfig * @param {Configuration=} instanceConfig
* @returns {Embed} * @returns {Embed}
* @example * @example
@@ -446,6 +446,10 @@ function nuked(configuration = {}) {
return embed; return embed;
} }
/**
* @typedef {any} ThemeJSON
*/
/** /**
* @interface ThemeInfo * @interface ThemeInfo
* @property {string} id Theme identifier * @property {string} id Theme identifier

4
apis/nucleus/src/object/create-session-object.js
View File

@@ -3,7 +3,7 @@ import init from './initiate';
import { subscribe, modelStore } from '../stores/model-store'; import { subscribe, modelStore } from '../stores/model-store';
/** /**
* @typedef {string | qae.NxDimension | qae.NxMeasure | LibraryField} Field * @typedef {string | EngineAPI.INxDimension | EngineAPI.INxMeasure | LibraryField} Field
*/ */
/** /**
@@ -13,7 +13,7 @@ import { subscribe, modelStore } from '../stores/model-store';
* @property {string} type * @property {string} type
* @property {string} version * @property {string} version
* @property {(Field[])=} fields * @property {(Field[])=} fields
* @property {qae.GenericObjectProperties=} properties * @property {EngineAPI.IGenericObjectProperties=} properties
*/ */
export default async function createSessionObject( export default async function createSessionObject(
{ type, version, fields, properties, options, plugins, element }, { type, version, fields, properties, options, plugins, element },

26
apis/stardust/api-spec/spec.conf.js
View File

@@ -21,23 +21,23 @@ module.exports = {
parse: { parse: {
types: { types: {
undefined: {}, undefined: {},
'qae.NxAppLayout': {}, 'EngineAPI.INxAppLayout': {},
'enigma.GenericObject': {}, 'EngineAPI.IGenericObject': {},
'enigma.Global': {}, 'EngineAPI.IGlobal': {},
'enigma.Doc': { 'EngineAPI.IApp': {
url: 'https://github.com/qlik-oss/enigma.js/blob/master/docs/api.md#generated-api', url: 'https://qlik.dev/apis/json-rpc/qix/doc#%23%2Fentries%2FDoc',
}, },
'qae.GenericObjectLayout': { 'EngineAPI.IGenericObjectLayout': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#genericobjectlayout', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectLayout',
}, },
'qae.GenericObjectProperties': { 'EngineAPI.IGenericObjectProperties': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#genericobjectproperties', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties',
}, },
'qae.NxDimension': { 'EngineAPI.INxDimension': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#nxdimension', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxDimension',
}, },
'qae.NxMeasure': { 'EngineAPI.INxMeasure': {
url: 'https://core.qlik.com/services/qix-engine/apis/qix/definitions/#nxmeasure', url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxMeasure',
}, },
}, },
}, },

175
apis/stardust/api-spec/spec.json
View File

@@ -14,7 +14,7 @@
"params": [ "params": [
{ {
"name": "app", "name": "app",
"type": "enigma.Doc" "type": "EngineAPI.IApp"
}, },
{ {
"name": "instanceConfig", "name": "instanceConfig",
@@ -229,7 +229,7 @@
"kind": "function", "kind": "function",
"params": [], "params": [],
"returns": { "returns": {
"type": "qae.GenericObjectLayout" "type": "EngineAPI.IGenericObjectLayout"
}, },
"examples": [ "examples": [
"import { useLayout } from '@nebula.js/stardust';\n// ...\nconst layout = useLayout();\nconsole.log(layout);" "import { useLayout } from '@nebula.js/stardust';\n// ...\nconst layout = useLayout();\nconsole.log(layout);"
@@ -240,7 +240,7 @@
"kind": "function", "kind": "function",
"params": [], "params": [],
"returns": { "returns": {
"type": "qae.GenericObjectLayout" "type": "EngineAPI.IGenericObjectLayout"
}, },
"examples": [ "examples": [
"import { useStaleLayout } from '@nebula.js/stardust';\n// ...\nconst staleLayout = useStaleLayout();\nconsole.log(staleLayout);" "import { useStaleLayout } from '@nebula.js/stardust';\n// ...\nconst staleLayout = useStaleLayout();\nconsole.log(staleLayout);"
@@ -252,7 +252,7 @@
"params": [], "params": [],
"returns": { "returns": {
"description": "The app layout", "description": "The app layout",
"type": "qae.NxAppLayout" "type": "EngineAPI.INxAppLayout"
}, },
"examples": [ "examples": [
"import { useAppLayout } from '@nebula.js/stardust';\n// ...\nconst appLayout = useAppLayout();\nconsole.log(appLayout.qLocaleInfo);" "import { useAppLayout } from '@nebula.js/stardust';\n// ...\nconst appLayout = useAppLayout();\nconsole.log(appLayout.qLocaleInfo);"
@@ -266,7 +266,7 @@
"kind": "union", "kind": "union",
"items": [ "items": [
{ {
"type": "enigma.GenericObject" "type": "EngineAPI.IGenericObject"
}, },
{ {
"type": "undefined" "type": "undefined"
@@ -286,7 +286,7 @@
"kind": "union", "kind": "union",
"items": [ "items": [
{ {
"type": "enigma.Doc" "type": "EngineAPI.IApp"
}, },
{ {
"type": "undefined" "type": "undefined"
@@ -306,7 +306,7 @@
"kind": "union", "kind": "union",
"items": [ "items": [
{ {
"type": "enigma.Global" "type": "EngineAPI.IGlobal"
}, },
{ {
"type": "undefined" "type": "undefined"
@@ -466,14 +466,14 @@
"kind": "function", "kind": "function",
"params": [ "params": [
{ {
"type": "qae.GenericObjectLayout" "type": "EngineAPI.IGenericObjectLayout"
} }
], ],
"returns": { "returns": {
"type": "Promise", "type": "Promise",
"generics": [ "generics": [
{ {
"type": "qae.GenericObjectLayout" "type": "EngineAPI.IGenericObjectLayout"
} }
] ]
} }
@@ -490,15 +490,7 @@
"params": [], "params": [],
"returns": { "returns": {
"description": "The render state.", "description": "The render state.",
"kind": "object", "type": "#/definitions/RenderState"
"entries": {
"pending": {
"type": "any"
},
"restore": {
"type": "any"
}
}
}, },
"examples": [ "examples": [
"import { useRenderState } from '@nebula.js/stardust';\n\nconst renderState = useRenderState();\nuseState(() => {\n if(needProperteisUpdate(...)) {\n useRenderState.pending();\n updateProperties(...);\n } else {\n useRenderState.restore();\n ...\n }\n}, [...]);" "import { useRenderState } from '@nebula.js/stardust';\n\nconst renderState = useRenderState();\nuseState(() => {\n if(needProperteisUpdate(...)) {\n useRenderState.pending();\n updateProperties(...);\n } else {\n useRenderState.restore();\n ...\n }\n}, [...]);"
@@ -730,6 +722,19 @@
} }
} }
}, },
"ReceiverFunction": {
"description": "A callback function which receives another function as input.",
"kind": "alias",
"items": {
"kind": "function",
"params": [
{
"kind": "function",
"params": []
}
]
}
},
"FieldInstance": { "FieldInstance": {
"availability": { "availability": {
"since": "1.1.0" "since": "1.1.0"
@@ -798,6 +803,21 @@
"optional": true, "optional": true,
"defaultValue": "{}", "defaultValue": "{}",
"type": "object" "type": "object"
},
"sessionModel": {
"description": "Use a custom sessionModel.",
"optional": true,
"type": "object"
},
"selectionsApi": {
"description": "Use a custom selectionsApi to customize how values are selected.",
"optional": true,
"type": "object"
},
"update": {
"description": "A function which receives an update function which upon call will trigger a data fetch.",
"optional": true,
"type": "#/definitions/ReceiverFunction"
} }
} }
} }
@@ -815,6 +835,12 @@
} }
} }
}, },
"ThemeJSON": {
"kind": "alias",
"items": {
"type": "any"
}
},
"ThemeInfo": { "ThemeInfo": {
"kind": "interface", "kind": "interface",
"entries": { "entries": {
@@ -830,7 +856,7 @@
"type": "Promise", "type": "Promise",
"generics": [ "generics": [
{ {
"type": "ThemeJSON" "type": "#/definitions/ThemeJSON"
} }
] ]
} }
@@ -1112,10 +1138,10 @@
"type": "string" "type": "string"
}, },
{ {
"type": "qae.NxDimension" "type": "EngineAPI.INxDimension"
}, },
{ {
"type": "qae.NxMeasure" "type": "EngineAPI.INxMeasure"
}, },
{ {
"type": "#/definitions/LibraryField" "type": "#/definitions/LibraryField"
@@ -1152,7 +1178,7 @@
}, },
"properties": { "properties": {
"optional": true, "optional": true,
"type": "qae.GenericObjectProperties" "type": "EngineAPI.IGenericObjectProperties"
} }
} }
}, },
@@ -1381,6 +1407,19 @@
} }
} }
}, },
"VizElementAttributes": {
"extends": [
{
"type": "NamedNodeMap"
}
],
"kind": "interface",
"entries": {
"data-render-count": {
"type": "string"
}
}
},
"VizElement": { "VizElement": {
"extends": [ "extends": [
{ {
@@ -1390,12 +1429,7 @@
"kind": "interface", "kind": "interface",
"entries": { "entries": {
"attributes": { "attributes": {
"kind": "object", "type": "#/definitions/VizElementAttributes"
"entries": {
"data-render-count": {
"type": "string"
}
}
}, },
"className": { "className": {
"value": "'njs-viz'", "value": "'njs-viz'",
@@ -1573,6 +1607,17 @@
} }
} }
}, },
"RenderState": {
"kind": "interface",
"entries": {
"pending": {
"type": "any"
},
"restore": {
"type": "any"
}
}
},
"Keyboard": { "Keyboard": {
"stability": "experimental", "stability": "experimental",
"kind": "interface", "kind": "interface",
@@ -1677,7 +1722,7 @@
"entries": { "entries": {
"properties": { "properties": {
"optional": true, "optional": true,
"type": "qae.GenericObjectProperties" "type": "EngineAPI.IGenericObjectProperties"
}, },
"data": { "data": {
"optional": true, "optional": true,
@@ -1712,7 +1757,7 @@
"type": "#/definitions/FieldTarget", "type": "#/definitions/FieldTarget",
"generics": [ "generics": [
{ {
"type": "qae.NxDimension" "type": "EngineAPI.INxDimension"
} }
] ]
}, },
@@ -1721,12 +1766,55 @@
"type": "#/definitions/FieldTarget", "type": "#/definitions/FieldTarget",
"generics": [ "generics": [
{ {
"type": "qae.NxMeasure" "type": "EngineAPI.INxMeasure"
} }
] ]
} }
} }
}, },
"fieldTargetAddedCallback": {
"templates": [
{
"name": "T"
}
],
"kind": "function",
"params": [
{
"name": "field",
"description": "TODO validate param name",
"type": "T"
},
{
"name": "properties",
"type": "EngineAPI.IGenericObjectProperties"
}
]
},
"fieldTargetRemovedCallback": {
"templates": [
{
"name": "T"
}
],
"kind": "function",
"params": [
{
"name": "field",
"description": "TODO validate param name",
"type": "T"
},
{
"name": "properties",
"type": "EngineAPI.IGenericObjectProperties"
},
{
"name": "index",
"description": "TODO validate param name",
"type": "number"
}
]
},
"FieldTarget": { "FieldTarget": {
"templates": [ "templates": [
{ {
@@ -1753,28 +1841,19 @@
}, },
"added": { "added": {
"optional": true, "optional": true,
"kind": "function", "type": "#/definitions/fieldTargetAddedCallback",
"params": [ "generics": [
{ {
"type": "T" "type": "T"
},
{
"type": "qae.GenericObjectProperties"
} }
] ]
}, },
"removed": { "removed": {
"optional": true, "optional": true,
"kind": "function", "type": "#/definitions/fieldTargetRemovedCallback",
"params": [ "generics": [
{ {
"type": "T" "type": "T"
},
{
"type": "qae.GenericObjectProperties"
},
{
"type": "number"
} }
] ]
} }
@@ -2101,25 +2180,25 @@
"dimensions": { "dimensions": {
"kind": "array", "kind": "array",
"items": { "items": {
"type": "qae.NxDimension" "type": "EngineAPI.INxDimension"
} }
}, },
"measures": { "measures": {
"kind": "array", "kind": "array",
"items": { "items": {
"type": "qae.NxMeasure" "type": "EngineAPI.INxMeasure"
} }
}, },
"excludedDimensions": { "excludedDimensions": {
"kind": "array", "kind": "array",
"items": { "items": {
"type": "qae.NxDimension" "type": "EngineAPI.INxDimension"
} }
}, },
"excludedMeasures": { "excludedMeasures": {
"kind": "array", "kind": "array",
"items": { "items": {
"type": "qae.NxMeasure" "type": "EngineAPI.INxMeasure"
} }
}, },
"interColumnSortOrder": { "interColumnSortOrder": {

16
apis/supernova/spec/spec.conf.js
View File

@@ -18,14 +18,14 @@ module.exports = {
}, },
parse: { parse: {
types: { types: {
'qae.GenericObjectProperties': {}, 'EngineAPI.IGenericObjectProperties': {},
'qae.GenericObjectLayout': {}, 'EngineAPI.IGenericObjectLayout': {},
'qae.NxAppLayout': {}, 'EngineAPI.INxAppLayout': {},
'qae.NxDimension': {}, 'EngineAPI.INxDimension': {},
'qae.NxMeasure': {}, 'EngineAPI.INxMeasure': {},
'enigma.GenericObject': {}, 'EngineAPI.IGenericObject': {},
'enigma.Doc': {}, 'EngineAPI.IDoc': {},
'enigma.Global': {}, 'EngineAPI.IGlobal': {},
}, },
}, },
}, },

22
apis/supernova/src/hooks.js
View File

@@ -550,7 +550,7 @@ export function useRect() {
/** /**
* Gets the layout of the generic object associated with this visualization. * Gets the layout of the generic object associated with this visualization.
* @entry * @entry
* @returns {qae.GenericObjectLayout} * @returns {EngineAPI.IGenericObjectLayout}
* @example * @example
* import { useLayout } from '@nebula.js/stardust'; * import { useLayout } from '@nebula.js/stardust';
* // ... * // ...
@@ -570,7 +570,7 @@ export function useLayout() {
* The returned value from `useStaleLayout()` and `useLayout()` are identical when the object * The returned value from `useStaleLayout()` and `useLayout()` are identical when the object
* is not in a modal state. * is not in a modal state.
* @entry * @entry
* @returns {qae.GenericObjectLayout} * @returns {EngineAPI.IGenericObjectLayout}
* @example * @example
* import { useStaleLayout } from '@nebula.js/stardust'; * import { useStaleLayout } from '@nebula.js/stardust';
* // ... * // ...
@@ -589,7 +589,7 @@ export function useStaleLayout() {
/** /**
* Gets the layout of the app associated with this visualization. * Gets the layout of the app associated with this visualization.
* @entry * @entry
* @returns {qae.NxAppLayout} The app layout * @returns {EngineAPI.INxAppLayout} The app layout
* @example * @example
* import { useAppLayout } from '@nebula.js/stardust'; * import { useAppLayout } from '@nebula.js/stardust';
* // ... * // ...
@@ -603,7 +603,7 @@ export function useAppLayout() {
/** /**
* Gets the generic object API of the generic object connected to this visualization. * Gets the generic object API of the generic object connected to this visualization.
* @entry * @entry
* @returns {enigma.GenericObject|undefined} * @returns {EngineAPI.IGenericObject|undefined}
* @example * @example
* import { useModel } from '@nebula.js/stardust'; * import { useModel } from '@nebula.js/stardust';
* // ... * // ...
@@ -622,7 +622,7 @@ export function useModel() {
/** /**
* Gets the doc API. * Gets the doc API.
* @entry * @entry
* @returns {enigma.Doc|undefined} The doc API. * @returns {EngineAPI.IApp|undefined} The doc API.
* @example * @example
* import { useApp } from '@nebula.js/stardust'; * import { useApp } from '@nebula.js/stardust';
* // ... * // ...
@@ -641,7 +641,7 @@ export function useApp() {
/** /**
* Gets the global API. * Gets the global API.
* @entry * @entry
* @returns {enigma.Global|undefined} The global API. * @returns {EngineAPI.IGlobal|undefined} The global API.
* @example * @example
* import { useGlobal } from '@nebula.js/stardust'; * import { useGlobal } from '@nebula.js/stardust';
* *
@@ -965,7 +965,7 @@ export function useImperativeHandle(fn, deps) {
/** /**
* Registers a callback that is called when a snapshot is taken. * Registers a callback that is called when a snapshot is taken.
* @entry * @entry
* @param {function(qae.GenericObjectLayout): Promise<qae.GenericObjectLayout>} snapshotCallback * @param {function(EngineAPI.IGenericObjectLayout): Promise<EngineAPI.IGenericObjectLayout>} snapshotCallback
* @example * @example
* import { onTakeSnapshot } from '@nebula.js/stardust'; * import { onTakeSnapshot } from '@nebula.js/stardust';
* import { useState } from '@nebula.js/stardust'; * import { useState } from '@nebula.js/stardust';
@@ -988,13 +988,19 @@ export function onTakeSnapshot(cb) {
h.fn = cb; h.fn = cb;
} }
/**
* @interface RenderState
* @property {any} pending
* @property {any} restore
*/
/** /**
* Gets render state instance. * Gets render state instance.
* *
* Used to update properties and get a new layout without triggering onInitialRender. * Used to update properties and get a new layout without triggering onInitialRender.
* @entry * @entry
* @experimental * @experimental
* @returns {{ pending, restore }} The render state. * @returns {RenderState} The render state.
* @example * @example
* import { useRenderState } from '@nebula.js/stardust'; * import { useRenderState } from '@nebula.js/stardust';
* *

25
apis/supernova/src/qae.js
View File

@@ -25,7 +25,7 @@ const noop = () => {};
/** /**
* @interface QAEDefinition * @interface QAEDefinition
* @property {qae.GenericObjectProperties=} properties * @property {EngineAPI.IGenericObjectProperties=} properties
* @property {object=} data * @property {object=} data
* @property {DataTarget[]} data.targets * @property {DataTarget[]} data.targets
* @property {importProperties=} importProperties * @property {importProperties=} importProperties
@@ -35,8 +35,23 @@ const noop = () => {};
/** /**
* @interface DataTarget * @interface DataTarget
* @property {string} path * @property {string} path
* @property {FieldTarget<qae.NxDimension>=} dimensions * @property {FieldTarget<EngineAPI.INxDimension>=} dimensions
* @property {FieldTarget<qae.NxMeasure>=} measures * @property {FieldTarget<EngineAPI.INxMeasure>=} measures
*/
/**
* @callback fieldTargetAddedCallback
* @template T
* @param {T} field TODO validate param name
* @param {EngineAPI.IGenericObjectProperties} properties
*/
/**
* @callback fieldTargetRemovedCallback
* @template T
* @param {T} field TODO validate param name
* @param {EngineAPI.IGenericObjectProperties} properties
* @param {number} index TODO validate param name
*/ */
/** /**
@@ -44,8 +59,8 @@ const noop = () => {};
* @template T * @template T
* @property {function():number} [min] * @property {function():number} [min]
* @property {function():number} [max] * @property {function():number} [max]
* @property {function(T, qae.GenericObjectProperties)} [added] * @property {fieldTargetAddedCallback<T>} [added]
* @property {function(T, qae.GenericObjectProperties, number)} [removed] * @property {fieldTargetRemovedCallback<T>} [removed]
*/ */
function fallback(x, value) { function fallback(x, value) {

42
docs/api-reference.md
View File

@@ -46,7 +46,7 @@ title: API Reference
- [interface: CreateConfig](#interface-createconfig) - [interface: CreateConfig](#interface-createconfig)
- [interface: BaseConfig](#interface-baseconfig) - [interface: BaseConfig](#interface-baseconfig)
- [interface: GetConfig](#interface-getconfig) - [interface: GetConfig](#interface-getconfig)
- [type Field = <[string]|`qae.NxDimension`|`qae.NxMeasure`|[LibraryField]>](#type-field-stringqaenxdimensionqaenxmeasurelibraryfield) - [type Field = <[string]|`EngineAPI.INxDimension`|`EngineAPI.INxMeasure`|[LibraryField]>](#type-field-stringqaenxdimensionqaenxmeasurelibraryfield)
- [interface: LibraryField](#interface-libraryfield) - [interface: LibraryField](#interface-libraryfield)
- [class: AppSelections](#class-appselections) - [class: AppSelections](#class-appselections)
- [appSelections.mount(element)](#appselectionsmountelement) - [appSelections.mount(element)](#appselectionsmountelement)
@@ -97,7 +97,7 @@ title: API Reference
### function: embed(app[, instanceConfig]) ### function: embed(app[, instanceConfig])
- `app` <`enigma.Doc`> - `app` <`EngineAPI.IApp`>
- `instanceConfig` <[Configuration]> - `instanceConfig` <[Configuration]>
- `returns:` <[Embed]> - `returns:` <[Embed]>
@@ -242,7 +242,7 @@ useEffect(() => {
### function: useLayout() ### function: useLayout()
- `returns:` <`qae.GenericObjectLayout`> - `returns:` <`EngineAPI.IGenericObjectLayout`>
Gets the layout of the generic object associated with this supernova. Gets the layout of the generic object associated with this supernova.
@@ -255,7 +255,7 @@ console.log(layout);
### function: useStaleLayout() ### function: useStaleLayout()
- `returns:` <`qae.GenericObjectLayout`> - `returns:` <`EngineAPI.IGenericObjectLayout`>
Gets the layout of the generic object associated with this supernova. Gets the layout of the generic object associated with this supernova.
@@ -274,7 +274,7 @@ console.log(staleLayout);
### function: useAppLayout() ### function: useAppLayout()
- `returns:` <`qae.NxAppLayout`> The app layout - `returns:` <`EngineAPI.INxAppLayout`> The app layout
Gets the layout of the app associated with this supernova. Gets the layout of the app associated with this supernova.
@@ -287,7 +287,7 @@ console.log(appLayout.qLocaleInfo);
### function: useModel() ### function: useModel()
- `returns:` <`enigma.GenericObject`|`undefined`> - `returns:` <`EngineAPI.IGenericObject`|`undefined`>
Gets the generic object API of the generic object connected to this supernova. Gets the generic object API of the generic object connected to this supernova.
@@ -304,7 +304,7 @@ useEffect(() => {
### function: useApp() ### function: useApp()
- `returns:` <`enigma.Doc`|`undefined`> The doc API. - `returns:` <`EngineAPI.IApp`|`undefined`> The doc API.
Gets the doc API. Gets the doc API.
@@ -321,7 +321,7 @@ useEffect(() => {
### function: useGlobal() ### function: useGlobal()
- `returns:` <`enigma.Global`|`undefined`> The global API. - `returns:` <`EngineAPI.IGlobal`|`undefined`> The global API.
Gets the global API. Gets the global API.
@@ -617,7 +617,7 @@ const ctl = ctl.destroy();
* `type` <[string]> * `type` <[string]>
* `version` <[string]> * `version` <[string]>
* `fields` <[Array]> * `fields` <[Array]>
* `properties` <`qae.GenericObjectProperties`> * `properties` <`EngineAPI.IGenericObjectProperties`>
### interface: BaseConfig ### interface: BaseConfig
@@ -630,7 +630,7 @@ const ctl = ctl.destroy();
* `id` <[string]> * `id` <[string]>
### type Field = <[string]|`qae.NxDimension`|`qae.NxMeasure`|[LibraryField]> ### type Field = <[string]|`EngineAPI.INxDimension`|`EngineAPI.INxMeasure`|[LibraryField]>
### interface: LibraryField ### interface: LibraryField
@@ -792,15 +792,15 @@ export default function () {
### interface: QAEDefinition ### interface: QAEDefinition
- `properties` <`qae.GenericObjectProperties`> - `properties` <`EngineAPI.IGenericObjectProperties`>
- `data` <[Object]> - `data` <[Object]>
- `targets` <[Array]<[DataTarget]>> - `targets` <[Array]<[DataTarget]>>
### interface: DataTarget ### interface: DataTarget
- `path` <[string]> - `path` <[string]>
- `dimensions` <[FieldTarget]<`qae.NxDimension`>> - `dimensions` <[FieldTarget]<`EngineAPI.INxDimension`>>
- `measures` <[FieldTarget]<`qae.NxMeasure`>> - `measures` <[FieldTarget]<`EngineAPI.INxMeasure`>>
### interface: FieldTarget ### interface: FieldTarget
@@ -923,26 +923,26 @@ theme.getStyle('', '', 'fontSize');
- `nil` <[string]> - `nil` <[string]>
- `others` <[string]> - `others` <[string]>
[enigma.doc]: undefined [engineapi.iapp]: undefined
[s]: undefined [s]: undefined
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function [function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
[array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array [array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[any]: undefined [any]: undefined
[t]: undefined [t]: undefined
[htmlelement]: undefined [htmlelement]: undefined
[qae.genericobjectlayout]: undefined [engineapi.igenericobjectlayout]: undefined
[qae.nxapplayout]: undefined [engineapi.inxapplayout]: undefined
[enigma.genericobject]: undefined [engineapi.igenericobject]: undefined
[undefined]: undefined [undefined]: undefined
[enigma.global]: undefined [engineapi.iglobal]: undefined
[a]: undefined [a]: undefined
[object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object [object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type [string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type
[promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise [promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
[qae.genericobjectproperties]: undefined [engineapi.igenericobjectproperties]: undefined
[qae.nxdimension]: undefined [engineapi.inxdimension]: undefined
[qae.nxmeasure]: undefined [engineapi.inxmeasure]: undefined
[galaxy]: undefined [galaxy]: undefined
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type
[context]: #interface-context [context]: #interface-context