@sisense/sdk-ui 0.14.0 → 0.15.0

package/dist/models/dashboard/get-dashboard-models.d.ts

@@ -3,7 +3,7 @@ export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
      *
-     * The dashboard title is not unique, therefore, the result may return multiple dashboards.
+     * Dashboard titles are not necessarily unique, so the result may contain multiple dashboards.
      */
     searchByTitle?: string;
     /**

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -6,7 +6,7 @@ import { HookEnableParam } from '../../common/hooks/types';
  */
 export interface GetDashboardModelParams extends GetDashboardModelOptions, HookEnableParam {
     /**
-     * Identifier of the dashboard that contains the widget
+     * Dashboard identifier
      */
     dashboardOid: string;
 }

package/dist/props.d.ts

@@ -7,6 +7,7 @@ import { DataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHan
 import { AppConfig } from './app/client-application';
 import { ExecuteQueryParams } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
+import { HookEnableParam } from './common/hooks/types';
 export type { ScatterDataPointEventHandler, ScatterDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, MenuItemSection, HighchartsOptions, };
 /**
  * Configurations for Sisense Context
@@ -613,7 +614,6 @@ export interface ChartWidgetProps extends BaseChartEventProps {
     /**
      * List of categories to allow drilldowns on
      *
-     * @deprecated Use {@link DrilldownWidget} instead
      * @category Widget
      */
     drilldownOptions?: DrilldownOptions;
@@ -821,21 +821,21 @@ export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props for {@link ContextMenu} component.
  */
-export type ContextMenuProps = {
+export interface ContextMenuProps {
     /**
-     * Position of the context menu
+     * Context menu position
      *
      * @category Widget
      */
     position?: MenuPosition | null;
     /**
-     * Callback function that is evaluated when context menu is closed
+     * Callback function that is evaluated when the context menu is closed
      *
      * @category Widget
      */
     closeContextMenu: () => void;
     /**
-     * Sections of menu items
+     * Menu item sections
      *
      * @category Widget
      */
@@ -846,8 +846,8 @@ export type ContextMenuProps = {
      * @category Widget
      */
     children?: React.ReactNode;
-};
-export type DrilldownBreadcrumbsProps = {
+}
+export interface DrilldownBreadcrumbsProps {
     /**
      * List of drilldown filters formatted to be displayed as breadcrumbs
      *
@@ -861,7 +861,7 @@ export type DrilldownBreadcrumbsProps = {
      */
     currentDimension: Attribute;
     /**
-     * Callback function that is evaluated when X button is clicked
+     * Callback function that is evaluated when the close (X) button is clicked
      *
      * @category Widget
      */
@@ -872,7 +872,7 @@ export type DrilldownBreadcrumbsProps = {
      * @category Widget
      */
     sliceDrilldownSelections: (i: number) => void;
-};
+}
 /**
  * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
  */
@@ -901,7 +901,7 @@ export type DrilldownWidgetConfig = {
 /**
  * Props for the {@link DrilldownWidget} component
  */
-export type DrilldownWidgetProps = {
+export interface DrilldownWidgetProps {
     /**
      * List of dimensions to allow drilldowns on
      *
@@ -928,4 +928,23 @@ export type DrilldownWidgetProps = {
      * @category Widget
      */
     children: (customDrilldownResult: CustomDrilldownResult) => ReactNode;
-};
+}
+/**
+ * Params of the {@link useGetSharedFormula} hook
+ *
+ * Can consist either of an oid or a name/dataSource pair
+ */
+export interface UseGetSharedFormulaParams extends HookEnableParam {
+    /**
+     * Formula identifier
+     */
+    oid?: string;
+    /**
+     * Formula name
+     */
+    name?: string;
+    /**
+     * Data source - e.g. `Sample ECommerce`
+     */
+    dataSource?: DataSource;
+}