@samply/lens
    Preparing search index...

    Type Alias LensOptions

    type LensOptions = {
        autoUpdateQueryInUrl?: boolean;
        chartOptions?: ChartOptions;
        collectionBaseUrl?: string;
        facetCount?: FacetCountOptions;
        language?: string;
        negotiateOptions?: NegotiateOptions;
        resultSummaryOptions?: ResultSummaryOptions;
        siteMappings?: { [key: string]: string | SiteInfo };
        sitesToQuery?: string[];
        spotUrl?: string;
        tableOptions?: TableOptions;
        texts?: Texts;
    }
    Index

    Properties

    autoUpdateQueryInUrl? chartOptions? collectionBaseUrl? facetCount? language? negotiateOptions? resultSummaryOptions? siteMappings? sitesToQuery? spotUrl? tableOptions? texts?

    Properties

    autoUpdateQueryInUrl?: boolean

    Whether to automatically update the query in the URL when it changes (default: true)

    chartOptions?: ChartOptions
    collectionBaseUrl?: string

    Base URL of the collections in the BBMRI-ERIC Directory. If set, collection IDs in the "siteMappings" are appended to this base URL to create the full URL of the collection in the BBMRI-ERIC Directory.

    facetCount?: FacetCountOptions

    If set, fetch and display facet counts (number of results per discrete value) in the catalogue.

    language?: string

    Two letter language code of the application language

    negotiateOptions?: NegotiateOptions
    resultSummaryOptions?: ResultSummaryOptions
    siteMappings?: { [key: string]: string | SiteInfo }

    Maps site ID to site info or string (display name only) for backwards compatibility.

    sitesToQuery?: string[]

    List of sites to query used by querySpot function and facet counts. If not set no sites are sent to Spot and Spot determines the sites to query.

    spotUrl?: string

    URL of the Spot API endpoint used by querySpot function and facet counts.

    tableOptions?: TableOptions
    texts?: Texts

    Allows to customize texts and add new translations

    Settings

    Member Visibility

    On This Page

    Properties