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

    Interface ResultsContainer

    Container for search results in the Carolina system. Extends the content rule zone item to hold an array of search result items.

    interface ResultsContainer {
        templateType: string;
        metadata?: Record<string, unknown>;
        contentId: string;
        containerContentId?: string;
        attributes: Record<string, unknown>;
        executionStartTime: number;
        previewMode: boolean;
        "@type": "ResultsContainer";
        results: unknown[];
        contents?: {
            ContentFolderZone?: ContentFolder[];
            MainContent?: MainContentItem[];
        };
        subMenus?: MenuItem[];
        topCategories?: MenuItem[];
        mostPopular?: MenuItem[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    templateType metadata? contentId containerContentId? attributes executionStartTime previewMode @type results contents? subMenus? topCategories? mostPopular?

    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

    "@type": "ResultsContainer"

    Type identifier for results containers

    results: unknown[]

    Array of search result items

    contents?: {
        ContentFolderZone?: ContentFolder[];
        MainContent?: MainContentItem[];
    }

    Optional content sections including folders and main content

    Type declaration

    • OptionalContentFolderZone?: ContentFolder[]

      Array of content folders within this zone

    • OptionalMainContent?: MainContentItem[]

      Array of main content items

    subMenus?: MenuItem[]

    Optional submenu items for navigation

    topCategories?: MenuItem[]

    Optional top-level category menu items

    mostPopular?: MenuItem[]

    Optional most popular menu items

    Settings

    Member Visibility

    On This Page

    Properties