docs: mark as experimental

qlik-oss · Apr 12, 2021 · 22994c0 · 22994c0
1 parent cbd1d5c
commit 22994c0
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/docs/scriptappy.json b/docs/scriptappy.json
@@ -904,7 +904,8 @@
           "kind": "array",
           "items": {
             "type": "#/definitions/ComponentSettings"
-          }
+          },
+          "stability": "experimental"
         },
         "strategy": {
           "description": "Layout strategy used for child components.",
@@ -918,7 +919,8 @@
               "type": "#/definitions/CustomLayoutFunction"
             }
           ],
-          "type": "any"
+          "type": "any",
+          "stability": "experimental"
         }
       }
     },

diff --git a/packages/picasso.js/src/core/chart/index.js b/packages/picasso.js/src/core/chart/index.js
@@ -49,6 +49,22 @@ import componentCollectionFn from './component-collection';
  * @property {DockLayoutSettings|CustomLayoutFunction} [strategy] Layout strategy used for child components.
  */
 
+// mark strategy as experimental
+/**
+ * @type {DockLayoutSettings|CustomLayoutFunction}
+ * @name strategy
+ * @memberof ComponentSettings
+ * @experimental
+ */
+
+// mark components as experimental
+/**
+ * @type {ComponentSettings[]}
+ * @name components
+ * @memberof ComponentSettings
+ * @experimental
+ */
+
 function addComponentDelta(shape, containerBounds, componentBounds) {
   const dx = containerBounds.left - componentBounds.left;
   const dy = containerBounds.top - componentBounds.top;

diff --git a/packages/picasso.js/src/core/layout/dock/docker.js b/packages/picasso.js/src/core/layout/dock/docker.js
@@ -406,7 +406,7 @@ function dockLayout(initialSettings) {
       throw new Error('Invalid rect');
     }
     if (!components.length) {
-      return { visible: [], hidden: [], order: [] };
+      return { visible: [], hidden: [], ordered: [] };
     }
 
     const { logicalContainerRect, containerRect } = resolveContainerRects(rect, settings);