Options
All
  • Public
  • Public/Protected
  • All
Menu

The data structure representing the Trimble Connect embeddable explorer config.

Hierarchy

  • ExplorerEmbedProperties

Index

Properties

enableAdd?: boolean

Enable the add dropdown button in Explorer. It will be enabled only when at least one of the properties (enableUploadFiles, enableCreateFolder) is true. The default value is true.

enableCreateFolder?: boolean

Enable the Create Folder option in the Add dropdown button

enableExplorerAllProjects?: boolean

Enable the All projects button in the folder tree left navbar. Clicking on the All projects botton will send an event to host. Host can call EmbedAPI.initProjectList to load the embeddable projects list. On Project selection event, host can call EmbedAPI.initFileExplorer to load the embeddable explorer again for the selected project.

enableExplorerKebabMenu?: boolean

Enable the explorer kebab menu(Permissions, Export to Excel, Checkin file(s), Checkout file(s), Reset to default columns). Default value is true.

enableSelect?: boolean

Enable the file and folder selection which will be displayed in the rightpanel. Default value is true.

enableUploadFiles?: boolean

Enable the Upload files option in the Add dropdown button

fileTypeFilter?: string[]

File type filter for the Explorer component. Allows showing only specific file types in the file explorer. Provide an array of lowercase file extensions without dots. System validates extensions against known supported formats and shows only matching files while keeping all folders visible. If validation fails or invalid extensions are provided, all files will be shown as fallback.

Valid: ["pdf", "txt", "docx", "png", "dwg"] - shows only specified file types Invalid: ["aaaaa", ".txt", "@#$"] - rejects filter and shows all files

folderId?: string

The Trimble Connect File management component can be loaded in a different folder instead of the root folder if the proper folder ID is passed. By default it takes the root ID

projectId: string

Project ID - that has to be loaded is to be passed here