Type Alias WorkspaceItemModelBeta

WorkspaceItemModel: {
    __uiState?: {
        autoOpen?: boolean;
        draft?: boolean;
        getEntities?: ((limit?: number) => Promise<Entity[]>);
        getEntitiesCount?: (() => Promise<number>);
        highlight?: boolean;
        initialState?: any;
        isClosable?: boolean;
        isHidden?: boolean;
        query?: ConceptFilter;
        rename?: boolean;
        showCountOnlyWhenClosed?: boolean;
    };
    os_item_name: string;
    os_item_type: string;
}

Represents the model for a workspace item.

Type declaration

  • Optional Beta__uiState?: {
        autoOpen?: boolean;
        draft?: boolean;
        getEntities?: ((limit?: number) => Promise<Entity[]>);
        getEntitiesCount?: (() => Promise<number>);
        highlight?: boolean;
        initialState?: any;
        isClosable?: boolean;
        isHidden?: boolean;
        query?: ConceptFilter;
        rename?: boolean;
        showCountOnlyWhenClosed?: boolean;
    }

    Ephemeral UI state in lieu of using complex redux logic. It is not saved in persistence and can be mutated by components.

    • OptionalautoOpen?: boolean

      Indicates if the item is auto open

    • Optionaldraft?: boolean

      Indicates if the item is in draft mode.

    • OptionalgetEntities?: ((limit?: number) => Promise<Entity[]>)

      Function to get the entities.

        • (limit?): Promise<Entity[]>
        • Parameters

          • Optionallimit: number

            The maximum number of entities to retrieve.

          Returns Promise<Entity[]>

          A promise that resolves to an array of entities.

    • OptionalgetEntitiesCount?: (() => Promise<number>)

      Function to get the count of entities.

        • (): Promise<number>
        • Returns Promise<number>

          A promise that resolves to the number of entities.

    • Optionalhighlight?: boolean

      Indicates if the item should be highlighted.

    • OptionalinitialState?: any

      The initial state of the item.

    • OptionalisClosable?: boolean

      Indicates if the item is closable

    • OptionalisHidden?: boolean

      Indicates if the item is hidden

    • Optionalquery?: ConceptFilter

      A filter applied to concepts.

    • Optionalrename?: boolean

      Indicates if the item is in rename mode.

    • OptionalshowCountOnlyWhenClosed?: boolean

      Determines if the count is shown only when the item is closed.

  • Betaos_item_name: string

    Name of the workspace item.

  • Betaos_item_type: string

    Type of the workspace item.