@turquoisehealth/pit-viper 2.70.0 → 2.71.1-dev.0

package/pv-components/dist/vue/charts/pv-components-charts.d.ts

@@ -1,3 +1,4 @@
+import { AdvancedFilterModel } from 'ag-grid-community/dist/types/src/interfaces/advancedFilterModel';
 import { AgChartInstance } from 'ag-charts-enterprise';
 import { AgChartOptions } from 'ag-charts-types';
 import { AgChartOptions as AgChartOptions_2 } from 'ag-charts-enterprise';
@@ -8,6 +9,8 @@ import { Column } from 'ag-grid-enterprise';
 import { ColumnMovedEvent } from 'ag-grid-enterprise';
 import { ColumnResizedEvent } from 'ag-grid-enterprise';
 import { ColumnRowGroupChangedEvent } from 'ag-grid-enterprise';
+import { ColumnVO } from 'ag-grid-community/dist/types/src/interfaces/iColumnVO';
+import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { CreateComponentPublicInstanceWithMixins } from 'vue';
@@ -15,6 +18,7 @@ import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FilterChangedEvent } from 'ag-grid-enterprise';
 import { FilterModel } from 'ag-grid-enterprise';
+import { FilterModel as FilterModel_2 } from 'ag-grid-community/dist/types/src/interfaces/iFilter';
 import { FirstDataRenderedEvent } from 'ag-grid-community';
 import { GlobalComponents } from 'vue';
 import { GlobalDirectives } from 'vue';
@@ -49,6 +53,14 @@ declare type ChartFilterOption = {
     filterValues: string[];
 };
 
+declare interface ChartStateChangedEvent {
+    api: GridApi | null;
+    seriesField?: string | null;
+    chartType?: string | null;
+    chartSort?: string | null;
+    chartCategoryFields?: string[] | null;
+}
+
 declare interface FilterValueResponseOption {
     value: string;
     label?: string;
@@ -72,6 +84,26 @@ declare interface FocusUpdateEvent {
 
 declare type MapTopologyType = "state" | "city" | "county" | "cbsa" | "zip_code";
 
+declare interface MenuOption {
+    id: string;
+    text: string;
+    subText?: string;
+    secondaryText?: string | number;
+    icon?: string;
+    companyName?: string;
+    avatar?: {
+        initials?: string;
+        image?: string;
+        icon?: boolean;
+    };
+    groupingLabel?: string;
+    disabled?: boolean;
+    renderer?: Component;
+    rendererProps?: any;
+    classList?: string[];
+    searchText?: string;
+}
+
 export declare const PvChart: DefineComponent<PvChartProps, {
 getChartImageDataURL: (dimensions?: {
 width?: number;
@@ -82,10 +114,10 @@ height?: number;
 }, string, PublicProps, Readonly<PvChartProps> & Readonly<{
 "onSeries-visibility-change"?: ((event: AgSeriesVisibilityChange<unknown>) => any) | undefined;
 }>, {
+seriesFormatType: "none" | "currency" | "percent";
 isLoading: boolean;
-minHeight: number;
 enableFocusView: boolean;
-seriesFormatType: "none" | "currency" | "percent";
+minHeight: number;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {
 chartRef: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<    {
 options: {
@@ -140,6 +172,10 @@ declare interface PvDataTableProps<T> {
      * Handler to fetch filter values for server-side filtering. Only used for server-side row model.
      */
     filterValuesSetHandler?: (params: FilterValuesSetHandlerParams<T>) => Promise<(FilterValueResponseOption | null)[]>;
+    /**
+     * Handler to return suggestions for applying search terms to the table.
+     */
+    tableSearchHandler?: (params: TableSearchHandlerParams<T>) => Promise<(QueryBuilderSuggestionMenuOption | null)[]>;
     /**
      * Specifies an initial set of filters/groups/sort/etc. to be applied to the table.
      */
@@ -180,6 +216,14 @@ declare interface PvDataTableProps<T> {
      * Display button to group by columns
      */
     enableGroupBySelector?: boolean;
+    /**
+     * Display input to search within the table
+     */
+    enableTableSearch?: boolean;
+    /**
+     * Allows for slot content to be placed above the chart
+     */
+    enableTopSlot?: boolean;
     /**
      * Display button to open the vertical filter drawer
      */
@@ -276,12 +320,13 @@ declare interface PvDataTableProps<T> {
      * List of column fields that can be focused
      */
     focusableColumns?: string[];
+    tableSearchPlaceholder?: string;
+    tableSearchStyle?: TableSearchStyle;
 }
 
 export declare const PvDataTableWithChart: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<any & PvDataTableWithChartProps<T> & Partial<{}>> & PublicProps;
     expose(exposed: ShallowUnwrapRef<    {
-    provideChartData: (data: AgChartOptions["data"], stackField: string) => void;
     getChartImageDataURL: (dimensions?: {
     width?: number;
     height?: number;
@@ -297,10 +342,7 @@ export declare const PvDataTableWithChart: <T>(__VLS_props: NonNullable<Awaited<
     attrs: any;
     slots: {};
     emit: {
-        (e: "chart-series-changed", event: {
-            api: GridApi | null;
-            seriesField: string | null;
-        }): void;
+        (e: "chart-state-changed", event: ChartStateChangedEvent): void;
         (e: "column-moved", event: ColumnMovedEvent<T>): void;
         (e: "column-resized", event: ColumnResizedEvent<T>): void;
         (e: "column-row-group-changed", event: ColumnRowGroupChangedEvent<T>): void;
@@ -319,16 +361,16 @@ export declare const PvDataTableWithChart: <T>(__VLS_props: NonNullable<Awaited<
 
 declare interface PvDataTableWithChartProps<T> extends PvDataTableProps<T> {
     enabledChartTypes?: supportedChartType[];
-    overrideChartData?: boolean;
+    serverSideChartHandler?: (params: ServerSideChartDataHandlerParams) => Promise<ServerSideChartDataHandlerResponse>;
     showSeriesLabels?: boolean;
     truncateLabelValues?: boolean;
     initialChartData?: AgChartOptions_2["data"];
-    displayChartLoading?: boolean;
     enableCombinedChartConfigPanel?: boolean;
     chartConfigPanelOptions?: ChartConfigPanelType[];
     chartFilter?: ChartFilter;
     chartType?: supportedChartType;
     yKey?: string;
+    initialSort?: string;
     hideChart?: boolean;
     hideTable?: boolean;
     filterPanelAboveChart?: boolean;
@@ -339,6 +381,10 @@ declare interface PvDataTableWithChartProps<T> extends PvDataTableProps<T> {
     };
     percentOfFocusViewYKey?: string;
     focusableColumns?: string[];
+    /**
+     * Enable toggle to group or ungroup
+     */
+    enableGroupingToggle?: boolean;
 }
 
 export declare const PvMapChart: DefineComponent<    {
@@ -382,10 +428,46 @@ declare interface PvMapChartProps {
     tooltipRenderer?: (params: AgMapLineSeriesTooltipRendererParams<PvMapChartData>) => string | HTMLElement;
 }
 
+declare interface QueryBuilderSuggestionMenuOption extends MenuOption {
+    queryTerm?: QueryTerm;
+}
+
+declare interface QueryTerm {
+    queryField?: string;
+    queryDisplayField?: string;
+    exactMatch?: boolean;
+    queryText?: string;
+}
+
 declare interface RegionSelectionChangedEvent {
     region: string | null | undefined;
 }
 
+declare interface ServerSideChartDataHandlerParams {
+    rowGroupCols: ColumnVO[];
+    /** Columns that have aggregations on them.  */
+    valueCols: ColumnVO[];
+    /**
+     * If filtering, what the filter model is.
+     * If Advanced Filter is enabled, will be of type `AdvancedFilterModel | null`.
+     * If Advanced Filter is disabled, will be of type `FilterModel`.
+     */
+    filterModel: FilterModel_2 | AdvancedFilterModel | null;
+}
+
+declare interface ServerSideChartDataHandlerResponse {
+    data: AgChartOptions_2["data"];
+    stackField: string;
+}
+
 declare type supportedChartType = "column" | "bar" | "column_stacked" | "bar_stacked" | "line" | "area" | "pie";
 
+declare interface TableSearchHandlerParams<T> {
+    api: GridApi<T>;
+    filterModel?: FilterModel | null;
+    query?: string;
+}
+
+declare type TableSearchStyle = "query-builder" | "text";
+
 export { }