@qlik/api 1.12.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.js +2 -2
- package/apps.js +2 -2
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automations.js +2 -2
- package/brands.js +2 -2
- package/chunks/{5V4BMSM2.js → 4VOVGPYE.js} +2 -2
- package/chunks/{NWOESCMR.js → 64ZZ22PG.js} +1 -1
- package/chunks/{5T2SBCJG.js → 7TFYIWPM.js} +3 -3
- package/chunks/{RN5AUIPP.js → D7TSCA65.js} +41 -23
- package/chunks/{LIPAU4N5.js → FFOAWSDK.js} +1 -3
- package/chunks/{ADP23C4M.js → O25AVKJT.js} +1 -1
- package/chunks/{JIAZ5W7Y.js → OJ64BEOX.js} +1 -1
- package/chunks/{IOUD76RB.js → RJSXIVZK.js} +1 -1
- package/chunks/{HACHQCYI.js → VCS5M2TX.js} +2 -2
- package/chunks/{CNQQPV5L.js → ZJKE2OY5.js} +1 -1
- package/collections.js +2 -2
- package/csp-origins.js +2 -2
- package/data-assets.js +2 -2
- package/data-connections.js +2 -2
- package/data-credentials.js +2 -2
- package/data-files.js +2 -2
- package/extensions.js +2 -2
- package/glossaries.d.ts +2 -0
- package/glossaries.js +2 -2
- package/groups.d.ts +4 -8
- package/groups.js +2 -2
- package/identity-providers.js +2 -2
- package/index.js +4 -4
- package/items.js +2 -2
- package/licenses.d.ts +8 -4
- package/licenses.js +2 -2
- package/package.json +1 -1
- package/qix.d.ts +19 -60
- package/qix.js +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.js +2 -2
- package/reloads.js +2 -2
- package/reports.d.ts +32 -10
- package/reports.js +2 -2
- package/roles.js +2 -2
- package/spaces.js +2 -2
- package/temp-contents.js +2 -2
- package/tenants.d.ts +2 -0
- package/tenants.js +2 -2
- package/themes.js +2 -2
- package/transports.js +2 -2
- package/users.d.ts +3 -3
- package/users.js +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.js +2 -2
package/api-keys.js
CHANGED
package/apps.js
CHANGED
package/audits.js
CHANGED
package/auth.js
CHANGED
package/automations.js
CHANGED
package/brands.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import {
|
|
2
2
|
getInvokeFetchRuntimeModule
|
|
3
|
-
} from "./
|
|
3
|
+
} from "./7TFYIWPM.js";
|
|
4
4
|
import {
|
|
5
5
|
isBrowser
|
|
6
6
|
} from "./2ZQ3ZX7F.js";
|
|
7
7
|
|
|
8
8
|
// src/public/invoke-fetch.ts
|
|
9
|
-
var defaultUserAgent = "qlik-api/1.
|
|
9
|
+
var defaultUserAgent = "qlik-api/1.14.0";
|
|
10
10
|
async function invokeFetch(api, props) {
|
|
11
11
|
const hostConfig = props.options?.hostConfig;
|
|
12
12
|
let userAgent;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
// src/public/public-runtime-modules.ts
|
|
2
2
|
function getAuthRuntimeModule(hostConfig) {
|
|
3
3
|
const isNode = !!globalThis.process?.argv;
|
|
4
|
-
return isNode ? import("./
|
|
4
|
+
return isNode ? import("./OJ64BEOX.js") : import("./O25AVKJT.js").then((mod) => mod.importRuntimeModule("auth@v1", hostConfig));
|
|
5
5
|
}
|
|
6
6
|
async function getQixRuntimeModule(hostConfig) {
|
|
7
7
|
await getAuthRuntimeModule(hostConfig);
|
|
8
8
|
const isNode = !!globalThis.process?.argv;
|
|
9
|
-
return isNode ? import("./
|
|
9
|
+
return isNode ? import("./VCS5M2TX.js") : import("./O25AVKJT.js").then((mod) => mod.importRuntimeModule("qix@v1", hostConfig));
|
|
10
10
|
}
|
|
11
11
|
async function getInvokeFetchRuntimeModule(hostConfig) {
|
|
12
12
|
await getAuthRuntimeModule(hostConfig);
|
|
13
13
|
const isNode = !!globalThis.process?.argv;
|
|
14
|
-
return isNode ? import("./
|
|
14
|
+
return isNode ? import("./ZJKE2OY5.js") : import("./O25AVKJT.js").then((mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig));
|
|
15
15
|
}
|
|
16
16
|
|
|
17
17
|
export {
|
|
@@ -974,7 +974,7 @@ async function handlePotentialAuthenticationErrorAndRetry(hostConfig, fn) {
|
|
|
974
974
|
canRetry: true
|
|
975
975
|
});
|
|
976
976
|
if (retry) {
|
|
977
|
-
return
|
|
977
|
+
return fn();
|
|
978
978
|
}
|
|
979
979
|
throw err;
|
|
980
980
|
}
|
|
@@ -1605,7 +1605,7 @@ async function interceptAuthenticationErrors(hostConfig, resultPromise, performR
|
|
|
1605
1605
|
const err = error;
|
|
1606
1606
|
if (err.status === 401 || err.status === 403 || (err.status === 301 || err.status === 302) && await isWindows(hostConfig)) {
|
|
1607
1607
|
if (globalThis.loggingOut) {
|
|
1608
|
-
return
|
|
1608
|
+
return neverResolvingPromise();
|
|
1609
1609
|
}
|
|
1610
1610
|
const { retry, preventDefault } = await handleAuthenticationError({
|
|
1611
1611
|
hostConfig,
|
|
@@ -1615,7 +1615,7 @@ async function interceptAuthenticationErrors(hostConfig, resultPromise, performR
|
|
|
1615
1615
|
canRetry: !!performRetry
|
|
1616
1616
|
});
|
|
1617
1617
|
if (retry && performRetry) {
|
|
1618
|
-
return
|
|
1618
|
+
return performRetry();
|
|
1619
1619
|
}
|
|
1620
1620
|
if (preventDefault) {
|
|
1621
1621
|
return neverResolvingPromise();
|
|
@@ -1634,9 +1634,13 @@ function getServiceOverrideHeaderFromLocalStorage() {
|
|
|
1634
1634
|
}
|
|
1635
1635
|
return { "X-Qlik-Overrides": header };
|
|
1636
1636
|
}
|
|
1637
|
-
function toDownloadableBlob(blob) {
|
|
1637
|
+
function toDownloadableBlob(blob, name) {
|
|
1638
1638
|
const result2 = blob;
|
|
1639
|
-
|
|
1639
|
+
if (name) {
|
|
1640
|
+
result2.download = (filename = name) => download(blob, filename);
|
|
1641
|
+
} else {
|
|
1642
|
+
result2.download = (filename) => download(blob, filename);
|
|
1643
|
+
}
|
|
1640
1644
|
return result2;
|
|
1641
1645
|
}
|
|
1642
1646
|
async function download(blob, filename) {
|
|
@@ -1722,25 +1726,39 @@ function clearApiCache(api) {
|
|
|
1722
1726
|
async function parseFetchResponse(fetchResponse, url) {
|
|
1723
1727
|
let resultData;
|
|
1724
1728
|
const contentType = fetchResponse.headers.get("content-type")?.split(";")[0];
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
case "text/event-stream":
|
|
1735
|
-
resultData = fetchResponse.body;
|
|
1736
|
-
break;
|
|
1737
|
-
default:
|
|
1738
|
-
try {
|
|
1739
|
-
resultData = await fetchResponse.text();
|
|
1740
|
-
resultData = JSON.parse(resultData);
|
|
1741
|
-
} catch {
|
|
1729
|
+
const contentDisposition = fetchResponse.headers.get("content-disposition")?.split(";");
|
|
1730
|
+
if (contentDisposition && contentDisposition[0] === "attachment") {
|
|
1731
|
+
let filename = "";
|
|
1732
|
+
for (let i = 1; i < contentDisposition.length; i++) {
|
|
1733
|
+
const attr = contentDisposition[i].trim();
|
|
1734
|
+
if (attr.indexOf("filename") === 0) {
|
|
1735
|
+
const start = attr.indexOf('"');
|
|
1736
|
+
const end = attr.lastIndexOf('"');
|
|
1737
|
+
filename = attr.slice(start + 1, end);
|
|
1742
1738
|
}
|
|
1743
|
-
|
|
1739
|
+
}
|
|
1740
|
+
resultData = toDownloadableBlob(await fetchResponse.blob(), filename);
|
|
1741
|
+
} else {
|
|
1742
|
+
switch (contentType) {
|
|
1743
|
+
case "image/png":
|
|
1744
|
+
case "image/jpeg":
|
|
1745
|
+
case "image/x-icon":
|
|
1746
|
+
case "application/offset+octet-stream":
|
|
1747
|
+
case "application/octet-stream":
|
|
1748
|
+
case "application/zip":
|
|
1749
|
+
resultData = toDownloadableBlob(await fetchResponse.blob());
|
|
1750
|
+
break;
|
|
1751
|
+
case "text/event-stream":
|
|
1752
|
+
resultData = fetchResponse.body;
|
|
1753
|
+
break;
|
|
1754
|
+
default:
|
|
1755
|
+
try {
|
|
1756
|
+
resultData = await fetchResponse.text();
|
|
1757
|
+
resultData = JSON.parse(resultData);
|
|
1758
|
+
} catch {
|
|
1759
|
+
}
|
|
1760
|
+
break;
|
|
1761
|
+
}
|
|
1744
1762
|
}
|
|
1745
1763
|
const { status, statusText, headers } = fetchResponse;
|
|
1746
1764
|
const errorMsg = `request to '${url}' failed with status ${status} ${statusText}.`;
|
|
@@ -4,7 +4,7 @@ import {
|
|
|
4
4
|
getRestCallAuthParams,
|
|
5
5
|
getWebSocketAuthParams,
|
|
6
6
|
toValidWebsocketLocationUrl
|
|
7
|
-
} from "./
|
|
7
|
+
} from "./D7TSCA65.js";
|
|
8
8
|
import {
|
|
9
9
|
isBrowser,
|
|
10
10
|
isNode
|
|
@@ -9748,7 +9748,6 @@ var mixin6 = {
|
|
|
9748
9748
|
createBookmark(_createBookmark, props) {
|
|
9749
9749
|
return _createBookmark(
|
|
9750
9750
|
merge2(
|
|
9751
|
-
{},
|
|
9752
9751
|
{
|
|
9753
9752
|
qInfo: {
|
|
9754
9753
|
qType: "bookmark"
|
|
@@ -9766,7 +9765,6 @@ var mixin6 = {
|
|
|
9766
9765
|
createBookmarkEx(_createBookmarkEx, props, patchObjs) {
|
|
9767
9766
|
return _createBookmarkEx(
|
|
9768
9767
|
merge2(
|
|
9769
|
-
true,
|
|
9770
9768
|
{
|
|
9771
9769
|
qInfo: {
|
|
9772
9770
|
qType: "bookmark"
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.
|
|
1
|
+
// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.7/node_modules/@qlik/runtime-module-loader/dist/index.js
|
|
2
2
|
window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
|
|
3
3
|
window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
|
|
4
4
|
window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);
|
|
@@ -4,7 +4,7 @@ import {
|
|
|
4
4
|
invokeFetch,
|
|
5
5
|
isWindows,
|
|
6
6
|
toValidWebsocketLocationUrl
|
|
7
|
-
} from "./
|
|
7
|
+
} from "./D7TSCA65.js";
|
|
8
8
|
import {
|
|
9
9
|
isBrowser
|
|
10
10
|
} from "./2ZQ3ZX7F.js";
|
|
@@ -101,7 +101,7 @@ function listenForWindowsAuthenticationInformation(session) {
|
|
|
101
101
|
return authSuggestedInWebsocket;
|
|
102
102
|
}
|
|
103
103
|
async function createAndSetupEnigmaSession(props, canRetry) {
|
|
104
|
-
const { createEnigmaSession } = await import("./
|
|
104
|
+
const { createEnigmaSession } = await import("./FFOAWSDK.js");
|
|
105
105
|
const session = await createEnigmaSession(props);
|
|
106
106
|
setupSessionListeners(session, props);
|
|
107
107
|
let global;
|
package/collections.js
CHANGED
package/csp-origins.js
CHANGED
package/data-assets.js
CHANGED
package/data-connections.js
CHANGED
package/data-credentials.js
CHANGED
package/data-files.js
CHANGED
package/extensions.js
CHANGED
package/glossaries.d.ts
CHANGED
|
@@ -393,6 +393,8 @@ type TermLinksTo = {
|
|
|
393
393
|
status?: number;
|
|
394
394
|
/** Different formats based on subresource type. Could be e.g. OID or UUID. */
|
|
395
395
|
subResourceId?: string;
|
|
396
|
+
/** Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists. */
|
|
397
|
+
subResourceInvalid?: boolean;
|
|
396
398
|
subResourceName?: string;
|
|
397
399
|
subResourceType?: "master_dimension" | "master_measure" | "field";
|
|
398
400
|
/** Describes reason for item status during batch operation. E.g. why an error occurs during creation. */
|
package/glossaries.js
CHANGED
package/groups.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
|
|
|
2
2
|
import './auth-types-Bqw3vbLs.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* An array of role references.
|
|
5
|
+
* An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
|
|
6
6
|
*/
|
|
7
7
|
type AssignedRoles = {
|
|
8
8
|
/** The unique role identitier */
|
|
@@ -70,12 +70,8 @@ type Filter = {
|
|
|
70
70
|
* represents a Group document
|
|
71
71
|
*/
|
|
72
72
|
type Group = {
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
readonly level: "admin" | "user";
|
|
76
|
-
readonly name: string;
|
|
77
|
-
readonly type: "default";
|
|
78
|
-
}[];
|
|
73
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
74
|
+
assignedRoles?: AssignedRoles;
|
|
79
75
|
/** The timestamp for when the group record was created. */
|
|
80
76
|
createdAt: string;
|
|
81
77
|
/** The unique identifier for the group */
|
|
@@ -136,7 +132,7 @@ type GroupSettings = {
|
|
|
136
132
|
syncIdpGroups: boolean;
|
|
137
133
|
systemGroups?: {
|
|
138
134
|
"000000000000000000000001"?: {
|
|
139
|
-
/** An array of role references. */
|
|
135
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
140
136
|
assignedRoles?: AssignedRoles;
|
|
141
137
|
/** The timestamp for when the Everyone group was created. */
|
|
142
138
|
createdAt?: string;
|
package/groups.js
CHANGED
package/identity-providers.js
CHANGED
package/index.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import {
|
|
2
2
|
qix_default
|
|
3
|
-
} from "./chunks/
|
|
3
|
+
} from "./chunks/64ZZ22PG.js";
|
|
4
4
|
import {
|
|
5
5
|
auth_default
|
|
6
|
-
} from "./chunks/
|
|
6
|
+
} from "./chunks/RJSXIVZK.js";
|
|
7
7
|
import {
|
|
8
8
|
clearApiCache,
|
|
9
9
|
invokeFetch
|
|
10
|
-
} from "./chunks/
|
|
11
|
-
import "./chunks/
|
|
10
|
+
} from "./chunks/4VOVGPYE.js";
|
|
11
|
+
import "./chunks/7TFYIWPM.js";
|
|
12
12
|
import "./chunks/2ZQ3ZX7F.js";
|
|
13
13
|
|
|
14
14
|
// src/public/public-runtime-api-generator/public-runtime-api-generator.ts
|
package/items.js
CHANGED
package/licenses.d.ts
CHANGED
|
@@ -52,23 +52,27 @@ type AssignmentsActionsDeleteResponse = {
|
|
|
52
52
|
};
|
|
53
53
|
type AssignmentsActionsUpdateRequest = {
|
|
54
54
|
update: {
|
|
55
|
+
/** The current user subject, in case that should be patched. */
|
|
56
|
+
sourceSubject?: string;
|
|
55
57
|
/** Current assignment type. */
|
|
56
|
-
sourceType
|
|
57
|
-
/** User subject */
|
|
58
|
+
sourceType?: string;
|
|
59
|
+
/** User subject, the current or the desired after the patch. */
|
|
58
60
|
subject: string;
|
|
59
61
|
/** Target assignment type. */
|
|
60
|
-
type
|
|
62
|
+
type?: string;
|
|
61
63
|
}[];
|
|
62
64
|
};
|
|
63
65
|
type AssignmentsActionsUpdateResponse = {
|
|
64
66
|
data: {
|
|
65
67
|
/** Error code */
|
|
66
68
|
code?: string;
|
|
69
|
+
/** Current subject. */
|
|
70
|
+
sourceSubject?: string;
|
|
67
71
|
/** Current allotment type. */
|
|
68
72
|
sourceType?: string;
|
|
69
73
|
/** Response status */
|
|
70
74
|
status: number;
|
|
71
|
-
/**
|
|
75
|
+
/** Target subject. */
|
|
72
76
|
subject?: string;
|
|
73
77
|
/** Error title */
|
|
74
78
|
title?: string;
|
package/licenses.js
CHANGED
package/package.json
CHANGED
package/qix.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import './global.types-Xt6XzwlN.js';
|
|
2
2
|
import { H as HostConfig } from './auth-types-Bqw3vbLs.js';
|
|
3
3
|
|
|
4
|
-
declare const QIX_SCHEMA_VERSION = "12.
|
|
4
|
+
declare const QIX_SCHEMA_VERSION = "12.2123.0";
|
|
5
5
|
type AlfaNumString = {
|
|
6
6
|
/**
|
|
7
7
|
* Calculated value.
|
|
@@ -827,6 +827,21 @@ type DimensionListDef = {
|
|
|
827
827
|
*/
|
|
828
828
|
qData?: Record<string, string>;
|
|
829
829
|
};
|
|
830
|
+
/**
|
|
831
|
+
* The DimensionReference structure points to a GenericDimension.
|
|
832
|
+
*
|
|
833
|
+
* Stability: *experimental*
|
|
834
|
+
*/
|
|
835
|
+
type DimensionReference = {
|
|
836
|
+
/**
|
|
837
|
+
* Identifier of the associated dimension.
|
|
838
|
+
*/
|
|
839
|
+
qId?: string;
|
|
840
|
+
/**
|
|
841
|
+
* Text label.
|
|
842
|
+
*/
|
|
843
|
+
qLabel?: string;
|
|
844
|
+
};
|
|
830
845
|
/**
|
|
831
846
|
* Parameters for a reload.
|
|
832
847
|
*/
|
|
@@ -3363,11 +3378,11 @@ type NxCurrentSelectionItem = {
|
|
|
3363
3378
|
*/
|
|
3364
3379
|
qIsHidden?: boolean;
|
|
3365
3380
|
/**
|
|
3366
|
-
*
|
|
3381
|
+
* List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.
|
|
3367
3382
|
*
|
|
3368
3383
|
* Stability: *experimental*
|
|
3369
3384
|
*/
|
|
3370
|
-
|
|
3385
|
+
qDimensionReferences?: DimensionReference[];
|
|
3371
3386
|
};
|
|
3372
3387
|
type NxDataAreaPage = {
|
|
3373
3388
|
/**
|
|
@@ -6277,26 +6292,6 @@ type SelectInfo = {
|
|
|
6277
6292
|
*/
|
|
6278
6293
|
qSelectFieldSearch?: boolean;
|
|
6279
6294
|
};
|
|
6280
|
-
/**
|
|
6281
|
-
* Structure that holds information connecting an app object to a data model field represented by an NxCurrentSelectionItem in the SelectionObject.
|
|
6282
|
-
* The SelectionItemFieldReferenceInfo structure points to an app object, such as a GenericDimension, and also holds a label.
|
|
6283
|
-
*
|
|
6284
|
-
* Stability: *experimental*
|
|
6285
|
-
*/
|
|
6286
|
-
type SelectionItemFieldReferenceInfo = {
|
|
6287
|
-
/**
|
|
6288
|
-
* Identifier of the associated object.
|
|
6289
|
-
*/
|
|
6290
|
-
qId?: string;
|
|
6291
|
-
/**
|
|
6292
|
-
* Type of object.
|
|
6293
|
-
*/
|
|
6294
|
-
qType?: string;
|
|
6295
|
-
/**
|
|
6296
|
-
* Text label.
|
|
6297
|
-
*/
|
|
6298
|
-
qLabel?: string;
|
|
6299
|
-
};
|
|
6300
6295
|
/**
|
|
6301
6296
|
* Indicates which selections are currently applied. It gives the current selections. Is the layout for _SelectionObjectDef_.
|
|
6302
6297
|
*/
|
|
@@ -8384,11 +8379,6 @@ type NativeDocFunctions<FieldRpcObject, GenericBookmarkRpcObject, GenericDimensi
|
|
|
8384
8379
|
* Returns information about the position of the tables in the data model viewer.
|
|
8385
8380
|
* <div class=note>The position of the broom points and the position of the connection points cannot be retrieved in Qlik Sense.</div>
|
|
8386
8381
|
*
|
|
8387
|
-
* ### Representation of tables, broom points and connection points
|
|
8388
|
-
* <br>
|
|
8389
|
-
* The green circles represent the broom points.
|
|
8390
|
-
* The red circle represents a connection point.
|
|
8391
|
-
*
|
|
8392
8382
|
* Stability: *locked*
|
|
8393
8383
|
*/
|
|
8394
8384
|
getViewDlgSaveInfo: () => Promise<TableViewDlgSaveInfo>;
|
|
@@ -8770,11 +8760,6 @@ type NativeDocFunctions<FieldRpcObject, GenericBookmarkRpcObject, GenericDimensi
|
|
|
8770
8760
|
* Sets the positions of the tables in the data model viewer.
|
|
8771
8761
|
* <div class=note>The position of the broom points and the position of the connection points cannot be set in Qlik Sense.</div>
|
|
8772
8762
|
*
|
|
8773
|
-
* ### Representation of tables, broom points and connection points
|
|
8774
|
-
* <br>
|
|
8775
|
-
* The green circles represent the broom points.
|
|
8776
|
-
* The red circle represents a connection point.
|
|
8777
|
-
*
|
|
8778
8763
|
* Parameters:
|
|
8779
8764
|
*
|
|
8780
8765
|
* - `info` - Information about the table.
|
|
@@ -9962,11 +9947,9 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
|
|
|
9962
9947
|
*
|
|
9963
9948
|
* ### Example:
|
|
9964
9949
|
* _A_ is a generic object and is the parent of the objects B and C. _B_ is the parent of the objects D and E.
|
|
9965
|
-
* <br><br>
|
|
9966
9950
|
* A _GetLayout_ call on A returns information on the objects A, B and C.
|
|
9967
9951
|
* A _GetLayout_ call on B returns information on the objects B, D and E.
|
|
9968
9952
|
* A _GetLayout_ call on C returns information on the object C.
|
|
9969
|
-
*
|
|
9970
9953
|
* <div class=note>
|
|
9971
9954
|
* In addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object.
|
|
9972
9955
|
* For example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.
|
|
@@ -10309,30 +10292,6 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
|
|
|
10309
10292
|
* Makes selections in the left dimension cells of a stacked table or in the data matrix.
|
|
10310
10293
|
* <div class=note>There is no top dimensions in a stacked table. A stacked table can only contain one measure.</div>
|
|
10311
10294
|
*
|
|
10312
|
-
* ### Example of a pivot table
|
|
10313
|
-
* <br>
|
|
10314
|
-
* In the representation above:
|
|
10315
|
-
* <table>
|
|
10316
|
-
* <tbody>
|
|
10317
|
-
* <tr>
|
|
10318
|
-
* <td>Sum(OrderTotal)<br>Count(OrderTotal)</td>
|
|
10319
|
-
* <td>Are pseudo dimensions.</td>
|
|
10320
|
-
* </tr>
|
|
10321
|
-
* <tr>
|
|
10322
|
-
* <td>CategoryName</td>
|
|
10323
|
-
* <td>Is a left dimension.<br> Beverages , Condiments ... are left dimension values.</td>
|
|
10324
|
-
* </tr>
|
|
10325
|
-
* <tr>
|
|
10326
|
-
* <td>ProductName</td>
|
|
10327
|
-
* <td>Is a top dimension.<br> Chef Anton's Cajun Seasoning is a top dimension value. </td>
|
|
10328
|
-
* </tr>
|
|
10329
|
-
* <tr>
|
|
10330
|
-
* <td>Numeric values</td>
|
|
10331
|
-
* <td>Are calculated values in the data matrix.<br> 626291,832 is a calculated value.</td>
|
|
10332
|
-
* </tr>
|
|
10333
|
-
* </tbody>
|
|
10334
|
-
* </table>
|
|
10335
|
-
*
|
|
10336
10295
|
* The member **Change** returns the handles of the objects that are updated following the selections.
|
|
10337
10296
|
* _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
|
|
10338
10297
|
* * The object contains some invalid fields (fields that are not in the data model).
|
|
@@ -11734,4 +11693,4 @@ declare const qix: {
|
|
|
11734
11693
|
openAppSession: typeof openAppSession;
|
|
11735
11694
|
};
|
|
11736
11695
|
|
|
11737
|
-
export { type AlfaNumString, type AlternateStateData, type AnyGenericObjectLayout, type AnyGenericObjectProperties, type AppEntry, type AppObjectList, type AppObjectListDef, type AppScript, type AppScriptMeta, type AppSession, type ApplyGroupStateWarning, type ApplyGroupStateWarningType, type ApplyGroupStatesResult, type ArrayOfNxValuePoint, type AssociationScore, type BNFDef, type BNFDefMetaType, type BNFType, type Blob, type Bookmark, type BookmarkApplyAndVerifyResult, type BookmarkFieldItem, type BookmarkFieldPage, type BookmarkFieldVerifyResultState, type BookmarkFieldVerifyWarning, type BookmarkList, type BookmarkListData, type BookmarkListDef, type BookmarkListItem, type BookmarkVariableItem, type CalendarStrings, type CharEncodingType, type CharRange, type ChildList, type ChildListDef, type CloseProps, type CodePage, type CombinedWebSocketStateEvent, type CondDef, type Connection, type ContentLibraryList, type ContentLibraryListItem, type CurrentSelections, type CustomConnector, type CyclicGroupPosition, type DataField, type DataRecord, type DataTable, type DataTableEx, type Database, type DatabaseInfo, type DatabaseOwner, type DelimiterInfo, type DerivedFieldsInTableData, type DimensionList, type DimensionListData, type DimensionListDef, type DimensionListItem, type DoReloadExParams, type DoReloadExResult, type Doc, type DocAction, type DocListEntry, type DriveInfo, type DriveType, type DynamicAppViewListData, type DynamicAppViewListItem, type EditorBreakpoint, type EmbeddedSnapshot, type EmbeddedSnapshotDef, type ErrorData, type ErrorDataCode, type ExpandedFieldListItem, type ExpansionData, type ExtendedLayoutBookmarkData, type ExtendedPivotStateData, type ExtensionList, type ExtensionListDef, type Field, type FieldAttrType, type FieldAttributes, type FieldDefEx, type FieldDescription, type FieldInTableData, type FieldInTableProfilingData, type FieldList, type FieldListDef, type FieldListObject, type FieldOrColumn, type FieldScores, type FieldType, type FieldValue, type FileDataFormat, type FileType, type FilterInfo, type FilterType, type FolderItem, type FolderItemType, type FrequencyDistributionData, type FunctionGroup, type GenericBookmark, type GenericBookmarkEntry, type GenericBookmarkLayout, type GenericBookmarkProperties, type GenericConnectMachine, type GenericDimension, type GenericDimensionInfo, type GenericDimensionLayout, type GenericDimensionProperties, type GenericListObject, type GenericMeasure, type GenericMeasureLayout, type GenericMeasureProperties, type GenericObject, type GenericObjectEntry, type GenericObjectLayout, type GenericObjectLayoutAdditionalProperties, type GenericObjectLayoutNode, type GenericObjectLayoutNodeLevel2, type GenericObjectLayoutNodeLevel3, type GenericObjectLayoutNodeLevel4, type GenericObjectLayoutNodeLevel5, type GenericObjectLayoutNodeRec, type GenericObjectProperties, type GenericObjectPropertiesAdditionalProperties, type GenericObjectPropertiesNode, type GenericObjectPropertiesNodeLevel2, type GenericObjectPropertiesNodeLevel3, type GenericObjectPropertiesNodeLevel4, type GenericObjectPropertiesNodeLevel5, type GenericObjectPropertiesNodeRec, type GenericVariable, type GenericVariableLayout, type GenericVariableProperties, type Global, type GraphMode, type GroupBookmarkData, type GroupState, type GroupStateInfo, type HyperCube, type HyperCubeDef, type InputFieldItem, type InterFieldSortData, type InteractDef, type InteractType, type KeyType, type LayoutBookmarkData, type LayoutExclude, type LayoutFieldInfo, type LineageInfo, type ListBoxProperties, type ListFunctions, type ListItem, type ListObject, type ListObjectDef, type LocaleInfo, type LogOnType, type MasterObjectListData, type MasterObjectListItem, type MeasureList, type MeasureListData, type MeasureListDef, type MeasureListItem, type MediaListDef, type MediaListItem, type MetaData, type ModalFunctions, type NativeDocFunctions, type NativeFieldFunctions, type NativeGenericBookmarkFunctions, type NativeGenericDimensionFunctions, type NativeGenericMeasureFunctions, type NativeGenericObjectFunctions, type NativeGenericVariableFunctions, type NativeGlobalFunctions, type NativeReactHooks, type NativeVariableFunctions, type NxAppLayout, type NxAppProperties, type NxAttrDimDef, type NxAttrDimInfo, type NxAttrExprDef, type NxAttrExprInfo, type NxAttributeDimValues, type NxAttributeExpressionValues, type NxAutoSortByStateDef, type NxAxisData, type NxAxisTicks, type NxBookmark, type NxCalcCond, type NxCardinalities, type NxCell, type NxCellPosition, type NxCellRows, type NxContainerEntry, type NxContinuousDataOptions, type NxContinuousMode, type NxContinuousRangeSelectInfo, type NxCurrentSelectionItem, type NxDataAreaPage, type NxDataPage, type NxDataReductionMode, type NxDerivedField, type NxDerivedFieldDescriptionList, type NxDerivedFieldsData, type NxDerivedGroup, type NxDimCellType, type NxDimension, type NxDimensionInfo, type NxDimensionType, type NxDownloadInfo, type NxDownloadOptions, type NxEngineVersion, type NxExportFileType, type NxExportState, type NxFeature, type NxFieldDescription, type NxFieldProperties, type NxFieldResourceId, type NxFieldSelectionInfo, type NxFieldSelectionMode, type NxFieldTableResourceId, type NxFrequencyMode, type NxGetBookmarkOptions, type NxGetObjectOptions, type NxGroupTail, type NxGrpType, type NxHighlightRanges, type NxHypercubeMode, type NxInfo, type NxInlineDimensionDef, type NxInlineMeasureDef, type NxLTrendlineType, type NxLayoutErrors, type NxLibraryDimension, type NxLibraryDimensionDef, type NxLibraryMeasure, type NxLibraryMeasureDef, type NxLinkedObjectInfo, type NxListObjectExpression, type NxListObjectExpressionDef, type NxLocalizedErrorCode, type NxLocalizedWarningCode, type NxMatchingFieldInfo, type NxMatchingFieldMode, type NxMeasure, type NxMeasureInfo, type NxMeta, type NxMetaDef, type NxMiniChart, type NxMiniChartCell, type NxMiniChartData, type NxMiniChartDef, type NxMiniChartRows, type NxMultiRangeSelectInfo, type NxPage, type NxPageTreeLevel, type NxPageTreeNode, type NxPatch, type NxPatchOperationType, type NxPatches, type NxPivotDimensionCell, type NxPivotPage, type NxPivotValuePoint, type NxRange, type NxRangeSelectInfo, type NxSelectionCell, type NxSelectionCellType, type NxSelectionInfo, type NxSimpleDimValue, type NxSimpleValue, type NxSortIndicatorType, type NxStackPage, type NxStackedPivotCell, type NxStateCounts, type NxStreamListEntry, type NxTempBookmarkOptions, type NxTickCell, type NxTreeDataOption, type NxTreeDimensionDef, type NxTreeDimensionInfo, type NxTreeMultiRangeSelectInfo, type NxTreeNode, type NxTreeRangeSelectInfo, type NxTreeValue, type NxTrendline, type NxTrendlineDef, type NxTrendlineMode, type NxValidationError, type NxVariableListItem, type NxVariableProperties, type NxViewPort, type ODAGAppLinkListData, type ODAGAppLinkListItem, type ObjectHelperFunctions, type ObjectInterface, type OdbcDsn, type OleDbProvider, type OpenAppSessionProps, type OtherLimitMode, type OtherMode, type OtherSortMode, type OtherTotalSpecProp, type Point, type PositionMark, type ProgressData, type ProgressMessage, type QFunction, QIX_SCHEMA_VERSION, type QMediaList, type QRange, type RangeSelectInfo, type Rect, type RpcObject, type SampleResult, type ScriptSyntaxError, type ScrollPosition, type SearchAssociationResult, type SearchAttribute, type SearchCharRange, type SearchCombinationOptions, type SearchContextType, type SearchFieldDictionary, type SearchFieldMatch, type SearchFieldMatchType, type SearchFieldMatchesItem, type SearchFieldSelectionMode, type SearchFieldValueItem, type SearchGroup, type SearchGroupItem, type SearchGroupItemMatch, type SearchGroupItemOptions, type SearchGroupItemType, type SearchGroupOptions, type SearchGroupType, type SearchMatchCombination, type SearchMatchCombinations, type SearchObjectOptions, type SearchPage, type SearchResult, type SearchSuggestItem, type SearchSuggestionResult, type SearchTermResult, type SearchValueOptions, type SearchValuePage, type SearchValueResult, type SelectInfo, type
|
|
11696
|
+
export { type AlfaNumString, type AlternateStateData, type AnyGenericObjectLayout, type AnyGenericObjectProperties, type AppEntry, type AppObjectList, type AppObjectListDef, type AppScript, type AppScriptMeta, type AppSession, type ApplyGroupStateWarning, type ApplyGroupStateWarningType, type ApplyGroupStatesResult, type ArrayOfNxValuePoint, type AssociationScore, type BNFDef, type BNFDefMetaType, type BNFType, type Blob, type Bookmark, type BookmarkApplyAndVerifyResult, type BookmarkFieldItem, type BookmarkFieldPage, type BookmarkFieldVerifyResultState, type BookmarkFieldVerifyWarning, type BookmarkList, type BookmarkListData, type BookmarkListDef, type BookmarkListItem, type BookmarkVariableItem, type CalendarStrings, type CharEncodingType, type CharRange, type ChildList, type ChildListDef, type CloseProps, type CodePage, type CombinedWebSocketStateEvent, type CondDef, type Connection, type ContentLibraryList, type ContentLibraryListItem, type CurrentSelections, type CustomConnector, type CyclicGroupPosition, type DataField, type DataRecord, type DataTable, type DataTableEx, type Database, type DatabaseInfo, type DatabaseOwner, type DelimiterInfo, type DerivedFieldsInTableData, type DimensionList, type DimensionListData, type DimensionListDef, type DimensionListItem, type DimensionReference, type DoReloadExParams, type DoReloadExResult, type Doc, type DocAction, type DocListEntry, type DriveInfo, type DriveType, type DynamicAppViewListData, type DynamicAppViewListItem, type EditorBreakpoint, type EmbeddedSnapshot, type EmbeddedSnapshotDef, type ErrorData, type ErrorDataCode, type ExpandedFieldListItem, type ExpansionData, type ExtendedLayoutBookmarkData, type ExtendedPivotStateData, type ExtensionList, type ExtensionListDef, type Field, type FieldAttrType, type FieldAttributes, type FieldDefEx, type FieldDescription, type FieldInTableData, type FieldInTableProfilingData, type FieldList, type FieldListDef, type FieldListObject, type FieldOrColumn, type FieldScores, type FieldType, type FieldValue, type FileDataFormat, type FileType, type FilterInfo, type FilterType, type FolderItem, type FolderItemType, type FrequencyDistributionData, type FunctionGroup, type GenericBookmark, type GenericBookmarkEntry, type GenericBookmarkLayout, type GenericBookmarkProperties, type GenericConnectMachine, type GenericDimension, type GenericDimensionInfo, type GenericDimensionLayout, type GenericDimensionProperties, type GenericListObject, type GenericMeasure, type GenericMeasureLayout, type GenericMeasureProperties, type GenericObject, type GenericObjectEntry, type GenericObjectLayout, type GenericObjectLayoutAdditionalProperties, type GenericObjectLayoutNode, type GenericObjectLayoutNodeLevel2, type GenericObjectLayoutNodeLevel3, type GenericObjectLayoutNodeLevel4, type GenericObjectLayoutNodeLevel5, type GenericObjectLayoutNodeRec, type GenericObjectProperties, type GenericObjectPropertiesAdditionalProperties, type GenericObjectPropertiesNode, type GenericObjectPropertiesNodeLevel2, type GenericObjectPropertiesNodeLevel3, type GenericObjectPropertiesNodeLevel4, type GenericObjectPropertiesNodeLevel5, type GenericObjectPropertiesNodeRec, type GenericVariable, type GenericVariableLayout, type GenericVariableProperties, type Global, type GraphMode, type GroupBookmarkData, type GroupState, type GroupStateInfo, type HyperCube, type HyperCubeDef, type InputFieldItem, type InterFieldSortData, type InteractDef, type InteractType, type KeyType, type LayoutBookmarkData, type LayoutExclude, type LayoutFieldInfo, type LineageInfo, type ListBoxProperties, type ListFunctions, type ListItem, type ListObject, type ListObjectDef, type LocaleInfo, type LogOnType, type MasterObjectListData, type MasterObjectListItem, type MeasureList, type MeasureListData, type MeasureListDef, type MeasureListItem, type MediaListDef, type MediaListItem, type MetaData, type ModalFunctions, type NativeDocFunctions, type NativeFieldFunctions, type NativeGenericBookmarkFunctions, type NativeGenericDimensionFunctions, type NativeGenericMeasureFunctions, type NativeGenericObjectFunctions, type NativeGenericVariableFunctions, type NativeGlobalFunctions, type NativeReactHooks, type NativeVariableFunctions, type NxAppLayout, type NxAppProperties, type NxAttrDimDef, type NxAttrDimInfo, type NxAttrExprDef, type NxAttrExprInfo, type NxAttributeDimValues, type NxAttributeExpressionValues, type NxAutoSortByStateDef, type NxAxisData, type NxAxisTicks, type NxBookmark, type NxCalcCond, type NxCardinalities, type NxCell, type NxCellPosition, type NxCellRows, type NxContainerEntry, type NxContinuousDataOptions, type NxContinuousMode, type NxContinuousRangeSelectInfo, type NxCurrentSelectionItem, type NxDataAreaPage, type NxDataPage, type NxDataReductionMode, type NxDerivedField, type NxDerivedFieldDescriptionList, type NxDerivedFieldsData, type NxDerivedGroup, type NxDimCellType, type NxDimension, type NxDimensionInfo, type NxDimensionType, type NxDownloadInfo, type NxDownloadOptions, type NxEngineVersion, type NxExportFileType, type NxExportState, type NxFeature, type NxFieldDescription, type NxFieldProperties, type NxFieldResourceId, type NxFieldSelectionInfo, type NxFieldSelectionMode, type NxFieldTableResourceId, type NxFrequencyMode, type NxGetBookmarkOptions, type NxGetObjectOptions, type NxGroupTail, type NxGrpType, type NxHighlightRanges, type NxHypercubeMode, type NxInfo, type NxInlineDimensionDef, type NxInlineMeasureDef, type NxLTrendlineType, type NxLayoutErrors, type NxLibraryDimension, type NxLibraryDimensionDef, type NxLibraryMeasure, type NxLibraryMeasureDef, type NxLinkedObjectInfo, type NxListObjectExpression, type NxListObjectExpressionDef, type NxLocalizedErrorCode, type NxLocalizedWarningCode, type NxMatchingFieldInfo, type NxMatchingFieldMode, type NxMeasure, type NxMeasureInfo, type NxMeta, type NxMetaDef, type NxMiniChart, type NxMiniChartCell, type NxMiniChartData, type NxMiniChartDef, type NxMiniChartRows, type NxMultiRangeSelectInfo, type NxPage, type NxPageTreeLevel, type NxPageTreeNode, type NxPatch, type NxPatchOperationType, type NxPatches, type NxPivotDimensionCell, type NxPivotPage, type NxPivotValuePoint, type NxRange, type NxRangeSelectInfo, type NxSelectionCell, type NxSelectionCellType, type NxSelectionInfo, type NxSimpleDimValue, type NxSimpleValue, type NxSortIndicatorType, type NxStackPage, type NxStackedPivotCell, type NxStateCounts, type NxStreamListEntry, type NxTempBookmarkOptions, type NxTickCell, type NxTreeDataOption, type NxTreeDimensionDef, type NxTreeDimensionInfo, type NxTreeMultiRangeSelectInfo, type NxTreeNode, type NxTreeRangeSelectInfo, type NxTreeValue, type NxTrendline, type NxTrendlineDef, type NxTrendlineMode, type NxValidationError, type NxVariableListItem, type NxVariableProperties, type NxViewPort, type ODAGAppLinkListData, type ODAGAppLinkListItem, type ObjectHelperFunctions, type ObjectInterface, type OdbcDsn, type OleDbProvider, type OpenAppSessionProps, type OtherLimitMode, type OtherMode, type OtherSortMode, type OtherTotalSpecProp, type Point, type PositionMark, type ProgressData, type ProgressMessage, type QFunction, QIX_SCHEMA_VERSION, type QMediaList, type QRange, type RangeSelectInfo, type Rect, type RpcObject, type SampleResult, type ScriptSyntaxError, type ScrollPosition, type SearchAssociationResult, type SearchAttribute, type SearchCharRange, type SearchCombinationOptions, type SearchContextType, type SearchFieldDictionary, type SearchFieldMatch, type SearchFieldMatchType, type SearchFieldMatchesItem, type SearchFieldSelectionMode, type SearchFieldValueItem, type SearchGroup, type SearchGroupItem, type SearchGroupItemMatch, type SearchGroupItemOptions, type SearchGroupItemType, type SearchGroupOptions, type SearchGroupType, type SearchMatchCombination, type SearchMatchCombinations, type SearchObjectOptions, type SearchPage, type SearchResult, type SearchSuggestItem, type SearchSuggestionResult, type SearchTermResult, type SearchValueOptions, type SearchValuePage, type SearchValueResult, type SelectInfo, type SelectionObject, type SelectionObjectDef, type SheetListData, type SheetListDataCell, type SheetListDataCellBounds, type SheetListItem, type Size, type SortCriteria, type SourceKeyRecord, type SpecialObjectFunctions, type StandardFunctions, type StateEnumType, type StaticContentList, type StaticContentListItem, type StaticContentUrl, type StaticContentUrlDef, type StoryListData, type StoryListItem, type StringExpr, type StringExpression, type SymbolFrequency, type SymbolValue, type TableProfilingData, type TableRecord, type TableRow, type TableViewBroomPointSaveInfo, type TableViewConnectionPointSaveInfo, type TableViewCtlSaveInfo, type TableViewDlgSaveInfo, type TableViewSaveInfo, type TableViewTableWinSaveInfo, type TextMacro, type TotalMode, type TransformAppParameters, type TransformAppResult, type TreeData, type TreeDataDef, type UndoInfo, type UndoInfoDef, type UndoInfoObject, type UsageEnum, type UseAppHook, type ValueExpr, type ValueExpression, type VariableList, type VariableListData, type VariableListDef, type VariableListItem, type WebSocketEvent, qix as default, openAppSession };
|
package/qix.js
CHANGED
package/quotas.js
CHANGED
package/reload-tasks.js
CHANGED
package/reloads.js
CHANGED
package/reports.d.ts
CHANGED
|
@@ -189,9 +189,10 @@ type OutputItem = {
|
|
|
189
189
|
*
|
|
190
190
|
* Each template type supports specific output types:
|
|
191
191
|
* - composition-1.0 supports only pdfcomposition and pptxcomposition output types
|
|
192
|
-
* - excel-1.0 supports only excel and pdf output type
|
|
192
|
+
* - sense-excel-template-1.0 supports only excel and pdf output type
|
|
193
193
|
* - sense-image-1.0 supports pdf, pptx and image output types
|
|
194
194
|
* - sense-sheet-1.0 supports pdf and pptx output type
|
|
195
|
+
* - sense-data-1.0 supports xlsx output type
|
|
195
196
|
*
|
|
196
197
|
* Each output type requires a specific output to be provided:
|
|
197
198
|
* - excel requires excelOutput to be set
|
|
@@ -200,7 +201,8 @@ type OutputItem = {
|
|
|
200
201
|
* - pdf requires pdfOuput to be set
|
|
201
202
|
* - pptx requires pptxOuput to be set
|
|
202
203
|
* - image requires imageOutput to be set
|
|
203
|
-
* - csv doesn't have csv output
|
|
204
|
+
* - csv doesn't have csv output
|
|
205
|
+
* - xlsx requires xlsxOutput to be set */
|
|
204
206
|
type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle";
|
|
205
207
|
};
|
|
206
208
|
/**
|
|
@@ -299,27 +301,32 @@ type ReportRequest = {
|
|
|
299
301
|
/** Define the request metadata. It includes priority, deadline and future settings on execution policy of the request. */
|
|
300
302
|
meta?: Meta;
|
|
301
303
|
output: OutputItem;
|
|
302
|
-
|
|
303
|
-
|
|
304
|
+
senseDataTemplate?: SenseDataTemplate;
|
|
305
|
+
/** Used to produce reports from a template file. */
|
|
306
|
+
senseExcelTemplate?: SenseFileTemplate;
|
|
304
307
|
/** Used to export a single visualization as pdf, pptx or png. */
|
|
305
308
|
senseImageTemplate?: SenseImageTemplate;
|
|
309
|
+
/** Used to produce reports from a template file. */
|
|
310
|
+
sensePixelPerfectTemplate?: SenseFileTemplate;
|
|
306
311
|
/** Used to export a sheet as pdf or pptx. */
|
|
307
312
|
senseSheetTemplate?: SenseSheetTemplate;
|
|
308
313
|
/** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
|
|
309
|
-
* Please note that sense-
|
|
314
|
+
* Please note that sense-pixel-perfect-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
|
|
310
315
|
*
|
|
311
316
|
* Each type requires a specific template to be provided:
|
|
312
317
|
* - composition-1.0 requires compositionTemplates to be set
|
|
313
318
|
* - sense-excel-template-1.0 requires senseExcelTemplate to be set
|
|
314
319
|
* - sense-image-1.0 requires senseImageTemplate to be set
|
|
315
320
|
* - sense-sheet-1.0 requires senseSheetTemplate to be set
|
|
321
|
+
* - sense-data-1.0 requires senseDataTemplate to be set
|
|
316
322
|
*
|
|
317
323
|
* Each template type supports specific output types:
|
|
318
324
|
* - composition-1.0 supports pdfcomposition and pptxComposition output type
|
|
319
325
|
* - sense-excel-template-1.0 supports excel and pdf output type
|
|
320
326
|
* - sense-image-1.0 supports pdf, pptx and png output types
|
|
321
|
-
* - sense-sheet-1.0 supports pdf, pptx output type
|
|
322
|
-
|
|
327
|
+
* - sense-sheet-1.0 supports pdf, pptx output type
|
|
328
|
+
* - sense-data-1.0 supports xlsx output type */
|
|
329
|
+
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0";
|
|
323
330
|
};
|
|
324
331
|
type ReportStatus = {
|
|
325
332
|
/** Present when status is failed. */
|
|
@@ -376,10 +383,25 @@ type SelectionFilter = {
|
|
|
376
383
|
variables?: unknown[];
|
|
377
384
|
};
|
|
378
385
|
type SelectionStrategy = "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
|
|
386
|
+
type SenseDataTemplate = {
|
|
387
|
+
appId: string;
|
|
388
|
+
/** Sense visualization id. Visualizations created "on the fly" are not supported. */
|
|
389
|
+
id: string;
|
|
390
|
+
patches?: NxPatch[];
|
|
391
|
+
persistentBookmark?: SensePersistentBookmark;
|
|
392
|
+
/** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
|
|
393
|
+
reloadTimestampMatchType?: ReloadTimestampMatchType;
|
|
394
|
+
selectionStrategy?: SelectionStrategy;
|
|
395
|
+
/** Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
|
|
396
|
+
selectionsByState?: unknown;
|
|
397
|
+
/** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
|
|
398
|
+
temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
|
|
399
|
+
variables?: unknown[];
|
|
400
|
+
};
|
|
379
401
|
/**
|
|
380
|
-
* Used to
|
|
402
|
+
* Used to produce reports from a template file.
|
|
381
403
|
*/
|
|
382
|
-
type
|
|
404
|
+
type SenseFileTemplate = {
|
|
383
405
|
/** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" property is supported. */
|
|
384
406
|
jsOpts?: unknown;
|
|
385
407
|
/** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
|
|
@@ -541,4 +563,4 @@ interface ReportsAPI {
|
|
|
541
563
|
*/
|
|
542
564
|
declare const reportsExport: ReportsAPI;
|
|
543
565
|
|
|
544
|
-
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type
|
|
566
|
+
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type SenseDataTemplate, type SenseFileTemplate, type SenseImageTemplate, type SensePersistentBookmark, type SenseSheetTemplate, type SenseTemporaryBookmarkV2, type Sheet, type TemplateLocation, type Visualization, clearCache, createReport, reportsExport as default, getReportStatus };
|
package/reports.js
CHANGED
package/roles.js
CHANGED
package/spaces.js
CHANGED
package/temp-contents.js
CHANGED
package/tenants.d.ts
CHANGED
|
@@ -45,6 +45,8 @@ type Tenant = {
|
|
|
45
45
|
enableAnalyticCreation?: boolean;
|
|
46
46
|
/** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
|
|
47
47
|
hostnames?: string[];
|
|
48
|
+
/** The unique tenant identifier. */
|
|
49
|
+
readonly id: string;
|
|
48
50
|
/** The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). */
|
|
49
51
|
readonly lastUpdated?: string;
|
|
50
52
|
readonly links?: {
|
package/tenants.js
CHANGED
package/themes.js
CHANGED
package/transports.js
CHANGED
package/users.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import './auth-types-Bqw3vbLs.js';
|
|
|
5
5
|
* An array of group references.
|
|
6
6
|
*/
|
|
7
7
|
type AssignedGroups = {
|
|
8
|
-
/** An array of role references. */
|
|
8
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
9
9
|
assignedRoles?: AssignedRoles;
|
|
10
10
|
/** The unique group identitier */
|
|
11
11
|
id: string;
|
|
@@ -13,7 +13,7 @@ type AssignedGroups = {
|
|
|
13
13
|
readonly name: string;
|
|
14
14
|
}[];
|
|
15
15
|
/**
|
|
16
|
-
* An array of role references.
|
|
16
|
+
* An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
|
|
17
17
|
*/
|
|
18
18
|
type AssignedRoles = {
|
|
19
19
|
/** The unique role identitier */
|
|
@@ -169,7 +169,7 @@ type ResultItem = {
|
|
|
169
169
|
type User = {
|
|
170
170
|
/** An array of group references. */
|
|
171
171
|
assignedGroups?: AssignedGroups;
|
|
172
|
-
/** An array of role references. */
|
|
172
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
173
173
|
assignedRoles?: AssignedRoles;
|
|
174
174
|
/** An array of scopes assigned to user */
|
|
175
175
|
readonly assignedScopes?: AssignedScopes;
|
package/users.js
CHANGED
package/web-integrations.js
CHANGED
package/web-notifications.js
CHANGED
package/webhooks.js
CHANGED