synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
45 lines • 3.63 kB
TypeScript
import { QueryOrDeprecatedSearchParams } from '@/components/CardContainerLogic/CardContainerLogic';
import { CardConfiguration } from '../CardContainer/CardConfiguration';
import { QueryWrapperPlotNavCustomPlotParams } from '../Plot/SynapsePlot';
import { QueryContextType } from '../QueryContext';
import { QueryVisualizationWrapperProps } from '../QueryVisualizationWrapper';
import { QueryWrapperProps } from '../QueryWrapper';
import { SynapseTableConfiguration } from '../SynapseTable';
import { SearchV2Props } from '../SynapseTable/SearchV2';
import { TopLevelControlsProps, CustomControl } from '../SynapseTable/TopLevelControls/TopLevelControls';
import { PlotsContainerProps } from '../widgets/facet-nav/PlotsContainer';
import { FacetFilterControlsProps } from '../widgets/query-filter/FacetFilterControls';
import { QueryWrapperSynapsePlotProps } from './QueryWrapperSynapsePlot';
export declare const QUERY_FILTERS_EXPANDED_CSS: string;
export declare const QUERY_FILTERS_COLLAPSED_CSS: string;
export declare const HAS_SELECTED_ROWS_CSS: string;
type QueryWrapperPlotNavOwnProps = {
/** Whether the displayed results should be paginated or infinite. Default for cards is true, default for table is false */
isInfinite?: boolean;
/** Set to true when you want the query to be saved in the URL search parameters. If you are controlling the view (such as in PortalSearch), you'll want to set this to false */
shouldDeepLink?: boolean;
/** If onQueryChange is set, the callback will be invoked when the Query changes */
onQueryChange?: (newQueryJson: string) => void;
/** If onQueryResultBundleChange is set, the callback will be invoked when the QueryResultBundle changes */
onQueryResultBundleChange?: (newQueryResultBundleJson: string) => void;
/** If initQueryJson is set, it will be the Query used in the initial QueryBundleRequest */
initQueryJson?: string;
tableConfiguration?: SynapseTableConfiguration;
cardConfiguration?: CardConfiguration;
searchConfiguration?: Omit<SearchV2Props, 'queryContext' | 'queryVisualizationContext'>;
facetsToPlot?: string[];
availableFacets?: FacetFilterControlsProps['availableFacets'];
initialExpandedFacetControls?: FacetFilterControlsProps['initialExpandedFacetControls'];
customPlots?: QueryWrapperSynapsePlotProps[];
customControls?: CustomControl[];
defaultColumn?: string;
defaultShowSearchBox?: boolean;
lockedColumn?: QueryWrapperProps['lockedColumn'];
onViewSharingSettingsClicked?: (benefactorId: string) => void;
initialLimit?: number;
hideTopLevelControls?: boolean;
} & Omit<TopLevelControlsProps, 'entityId'> & Pick<QueryWrapperPlotNavCustomPlotParams, 'onCustomPlotClick'> & Pick<QueryWrapperProps, 'isRowSelectionVisible' | 'rowSelectionPrimaryKey' | 'isRowSelectionUIFloating' | 'fileIdColumnName' | 'fileNameColumnName' | 'fileVersionColumnName'> & Pick<QueryVisualizationWrapperProps, 'defaultShowPlots' | 'visibleColumnCount' | 'columnAliases' | 'rgbIndex' | 'showLastUpdatedOn' | 'noContentPlaceholderType' | 'unitDescription' | 'additionalFiltersSessionStorageKey' | 'helpConfiguration' | 'hideCopyToClipboard' | 'hideSearchBarControl' | 'hideVisualizationsControl' | 'enabledExternalAnalysisPlatforms'> & Pick<QueryContextType, 'combineRangeFacetConfig'>;
export type QueryWrapperPlotNavProps = QueryOrDeprecatedSearchParams & PlotsContainerProps & QueryWrapperPlotNavOwnProps;
export default function QueryWrapperPlotNav(props: QueryWrapperPlotNavProps): import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=QueryWrapperPlotNav.d.ts.map