/** * Get the dataset description string. * @param {object} loaders The object mapping * datasets and data types to loader instances. * @param {string} dataset The key for a dataset, * used to identify which loader to use. * @returns {array} [description] where * description is a string. */ export function useDescription(loaders: object, dataset: string): array; /** * Get data from a cells data type loader, * updating "ready" and URL state appropriately. * Throw warnings if the data is marked as required. * Subscribe to loader updates. * @param {object} loaders The object mapping * datasets and data types to loader instances. * @param {string} dataset The key for a dataset, * used to identify which loader to use. * @param {boolean} isRequired Should a warning be thrown if * loading is unsuccessful? * @param {object} coordinationSetters Object where * keys are coordination type names with the prefix 'set', * values are coordination setter functions. * @param {object} initialCoordinationValues Object where * keys are coordination type names with the prefix 'initialize', * values are initialization preferences as boolean values. * @returns {array} [data, status, urls, error] */ export function useObsEmbeddingData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: any): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsSpotsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsPointsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsLocationsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsLabelsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsSegmentationsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsSetsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useSampleSetsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useSampleEdgesData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useObsFeatureMatrixData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useFeatureLabelsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useImageData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useGenomicProfilesData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useNeighborhoodsData(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Wrapper around useDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} coordinationSetters * @param {object} initialCoordinationValues * @param {object} matchOn * @returns {array} [data, status, urls, error] */ export function useComparisonMetadata(loaders: object, dataset: string, isRequired: boolean, coordinationSetters: object, initialCoordinationValues: object, matchOn: object): array; /** * Get data from the expression matrix data type loader for a given gene selection. * Throw warnings if the data is marked as required. * Subscribe to loader updates. * @param {object} loaders The object mapping * datasets and data types to loader instances. * @param {string} dataset The key for a dataset, * used to identify which loader to use. * @param {boolean} isRequired Should a warning be thrown if * loading is unsuccessful? * @param {boolean} selection A list of gene names to get expression data for. * @param {object} matchOn Coordination values used to obtain a matching loader. * @returns {array} [geneData, geneName, status, errors] * where geneData is an array [Uint8Array, ..., Uint8Array] * for however many genes are in the selection. */ export function useFeatureSelection(loaders: object, dataset: string, isRequired: boolean, selection: boolean, matchOn: object): array; /** * Utility hook function which can be used to define * dataType-specific data hooks which call a loader.loadMulti * method to obtain multiple data frames resulting from * multiple comparative analyses. * @param {object} loaders The object mapping * datasets and data types to loader instances. * @param {string} dataset The key for a dataset, * used to identify which loader to use. * @param {boolean} isRequired Should a warning be thrown if * loading is unsuccessful? * @param {object} matchOn Coordination values used to obtain a matching loader. * @param {object} volcanoOptions Options to pass to the loadMulti function of the loader. * @param {string} dataType A data type. * @returns {array} [{ df, metadata }, status, urls, error] * Array of dataframes and their metadata, where * df is an object in which each column is stored * as an array like { col1: arr1, col2: arr2 }. */ export function useComparativeDataType(loaders: object, dataset: string, isRequired: boolean, matchOn: object, volcanoOptions: object, dataType: string): array; /** * Wrapper around useComparativeDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} matchOn * @param {object} volcanoOptions * @returns {array} [data, status, urls, error]. */ export function useFeatureStatsData(loaders: object, dataset: string, isRequired: boolean, matchOn: object, volcanoOptions: object): array; /** * Wrapper around useComparativeDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} matchOn * @param {object} volcanoOptions * @returns {array} [data, status, urls, error]. */ export function useFeatureSetStatsData(loaders: object, dataset: string, isRequired: boolean, matchOn: object, volcanoOptions: object): array; /** * Wrapper around useComparativeDataType. * @param {object} loaders * @param {string} dataset * @param {boolean} isRequired * @param {object} matchOn * @param {object} volcanoOptions * @returns {array} [data, status, urls, error]. */ export function useObsSetStatsData(loaders: object, dataset: string, isRequired: boolean, matchOn: object, volcanoOptions: object): array; /** * Get the attributes for the expression matrix data type loader, * i.e names of cells and genes. * Throw warnings if the data is marked as required. * Subscribe to loader updates. Should not be used in conjunction (called in the same component) * with useExpressionMatrixData. * @param {object} loaders The object mapping * datasets and data types to loader instances. * @param {string} dataset The key for a dataset, * used to identify which loader to use. * @param {boolean} isRequired Should a warning be thrown if * loading is unsuccessful? * @param {object} matchOn Coordination values used to obtain a matching loader. * @returns {object} [attrs, status, urls, error] * where attrs is { rows, cols } object containing cell and gene names. */ export function useObsFeatureMatrixIndices(loaders: object, dataset: string, isRequired: boolean, matchOn: object): object; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useMultiObsPoints(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string, mergeCoordination: Function, viewUid: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useMultiObsSpots(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string, mergeCoordination: Function, viewUid: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useSpotMultiObsSets(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useSpotMultiFeatureLabels(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [labelsTypes, data, status, urls, errors] */ export function useMultiObsLabels(coordinationScopes: object, obsType: any, loaders: object, dataset: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useMultiObsSegmentations(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string, mergeCoordination: Function, viewUid: string): array; /** * Wrapper around useDataTypeMulti. * @param {object} coordinationScopes * @param {object} coordinationScopesBy * @param {object} loaders * @param {string} dataset * @param {function} mergeCoordination * @param {string} viewUid * @returns {array} [data, status, urls, errors] */ export function useMultiImages(coordinationScopes: object, coordinationScopesBy: object, loaders: object, dataset: string, mergeCoordination: Function, viewUid: string): array; //# sourceMappingURL=data-hooks.d.ts.map