ChemPare Documentation - v0.0.0
    Preparing search index...

    Interface FacetsContainer

    Container for managing faceted navigation and filtering. Includes facet collections, sorting information, and selected filter crumbs.

    interface FacetsContainer {
        templateType: string;
        metadata?: Record<string, unknown>;
        contentId: string;
        containerContentId?: string;
        attributes: Record<string, unknown>;
        executionStartTime: number;
        previewMode: boolean;
        facets: Record<string, FacetItem[]>[];
        facetSortMap: Record<string, string>;
        facetSortOrderMap: Record<string, string[]>;
        selectedCrumb: {
            fieldName: string;
            label: string;
            navigationState: string;
            fieldValue: string;
            displayName: string;
        }[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    templateType metadata? contentId containerContentId? attributes executionStartTime previewMode facets facetSortMap facetSortOrderMap selectedCrumb

    Properties

    templateType: string

    The type of template being used

    metadata?: Record<string, unknown>

    Optional metadata key-value pairs associated with the object

    contentId: string

    Unique identifier for the content

    containerContentId?: string

    Optional identifier for the parent container

    attributes: Record<string, unknown>

    Additional attributes stored as key-value pairs

    executionStartTime: number

    Timestamp when execution started

    previewMode: boolean

    Flag indicating if the content is in preview mode

    facets: Record<string, FacetItem[]>[]

    Collection of facets grouped by field name

    facetSortMap: Record<string, string>

    Mapping of facet names to their sort types

    facetSortOrderMap: Record<string, string[]>

    Mapping of facet names to their sort order arrays

    selectedCrumb: {
        fieldName: string;
        label: string;
        navigationState: string;
        fieldValue: string;
        displayName: string;
    }[]

    Array of currently selected facet filters

    Type declaration

    • fieldName: string

      Name of the faceted field

    • label: string

      Display label for the filter

    • navigationState: string

      Navigation state for the filter

    • fieldValue: string

      Value of the faceted field

    • displayName: string

      Name shown in the UI

    Settings

    Member Visibility

    On This Page

    Properties