The configuration parameters describe the behavior and display options of the DocSpace elements.
| Name | Description | Type | Example |
| buttonColor | The selector button color. | string | "#5299E0" |
| checkCSP | Specifies whether to check for the presence of CSP headers before initialization. | boolean | true |
| destroyText | The text that will be inserted into the div tag when the destroyFrame method is called. | string | "" |
| disableActionButton | Specifies whether to disable the Actions button in the manager interface. | boolean | false |
| downloadToEvent | Specifies whether to switch the SDK to the mode of working with download links through the onDownload event. | boolean | false |
| editorCustomization | The parameters to customize editors. The parameters from this section are used. | object | {} |
| editorGoBack | Specifies whether the File Location button is displayed in the editor. | boolean | true |
| editorType | The editor mode display type ("embedded", "desktop"). | string | "desktop" |
| events | A list of DocSpace events that will be returned on certain actions within the SDK. | object | { "onSelectCallback": null, "onCloseCallback": null, "onAppReady": null, "onAppError": null, "onEditorCloseCallback": null, "onAuthSuccess": null, "onSignOut": null, "onDownload": null } |
| filter |
The filter parameters that facilitate searching files in the DocSpace manager:
|
object | { "count": 100, "page": 1, "search": "", "sortorder": "descending", "sortby": "DateAndTime", "withSubfolders": false } |
| filterParam | The filter parameters that facilitate searching files in the selector mode. The possible values: "ALL", "DOCX", "IMG", "GZ", "DOCXF", "XLSX", "BackupOnly". | string | "ALL" |
| frameId | The frame SDK ID which is used to refer to the SDK instance. | string | "ds-frame" |
| height | The frame SDK height measured in percent. | string | "100%" |
| id | The element ID which will be used in the SDK initialization modes. | string | null |
| infoPanelVisible | Specifies whether to display a button to show the info panel in the manager. | boolean | true |
| locale | The language of the DocSpace user interface which is specified with the four letter language code. | string | null |
| mode | The SDK initialization mode ("manager", "file-selector", 'room-selector", "editor", "viewer", "system") | string | "manager" |
| name | The name of the object inserted into the page. It is used for messaging at the SDK level. | string | "frameDocSpace" |
| requestToken | The request token that is used to open public rooms and files in public rooms. | string | null |
| rootPath | The path to the frame SDK. Opens a list of rooms by default. | string | "/rooms/shared/" |
| selectorType | The selector type that defines filters for elements in the selector mode. The possible values: "roomsOnly", "userFolderOnly", "exceptPrivacyTrashArchiveFolders", "exceptSortedByTagsFolders". | string | "roomsOnly" |
| showFilter | Specifies whether the interface filter is displayed in the DocSpace manager. | boolean | false |
| showHeader | Specifies whether the interface header is displayed in the mobile view manager. | boolean | false |
| showMenu | Specifies whether the interface menu is displayed in the DocSpace manager. | boolean | false |
| showSelectorCancel | Specifies whether the Cancel button is displayed in the selector mode. | boolean | false |
| showSelectorHeader | Specifies whether the interface header is displayed in the selector mode. | boolean | false |
| showSettings | Specifies whether to display the Manage displayed columns button for configuring the table columns in the manager. | boolean | false |
| showSignOut | Specifies whether the Sign out button is displayed. | boolean | true |
| showTitle | Specifies whether the interface title is displayed in the DocSpace manager. | boolean | true |
| src | The base URL to the DocSpace portal. It is used to generate links. | string | {PORTAL_SRC} |
| theme | The DocSpace user interface theme ("Base", "Dark", "System"). | string | "Base" |
| type | The platform type which is used by the browser and affects the parameters of the inserted object ("desktop", "mobile"). | string | "desktop" |
| viewAs | The way elements are arranged in the DocSpace manager ("row", "table", "tile"). | string | "row" |
| viewTableColumns | The column names that are displayed for the table in the manager. | string | "Name,Type,Tags" |
| width | The frame SDK width measured in percent. | string | "100%" |
| withBreadCrumbs | Specifies whether to display the breadcrumbs in the selector mode. | boolean | true |
| withSearch | Specifies whether to display Search in the selector mode. | boolean | true |
| withSubtitle | Specifies whether to display the filter parameters in the selector mode. | boolean | true |
{
"buttonColor": "#5299E0",
"destroyText": "",
"checkCSP" true,
"disableActionButton": false,
"downloadToEvent": false,
"editorCustomization": {},
"editorGoBack": true,
"editorType": "desktop",
"events": {
"onSelectCallback": null,
"onCloseCallback": null,
"onAppReady": null,
"onAppError": null,
"onEditorCloseCallback": null,
"onAuthSuccess": null,
"onSignOut": null,
"onDownload": null
},
"filter": {
"count": 100,
"page": 1,
"search": "",
"sortorder": "descending",
"sortby": "DateAndTime",
"withSubfolders": false
},
"filterParam": "ALL",
"frameId": "ds-frame",
"height": "100%",
"id": null,
"infoPanelVisible": true,
"locale": null,
"mode": "manager",
"name": "frameDocSpace",
"requestToken": null,
"rootPath": "/rooms/shared/",
"selectorType": "exceptPrivacyTrashArchiveFolders",
"showFilter": false,
"showHeader": false,
"showMenu": false,
"showSelectorCancel": false,
"showSelectorHeader": false,
"showSettings": false,
"showSignOut": true,
"showTitle": true,
"src": {PORTAL_SRC},
"theme": "Base",
"type": "desktop",
"viewAs": "row",
"viewTableColumns": "Name,Type,Tags",
"width": "100%",
"withBreadCrumbs": true,
"withSearch": true,
"withSubtitle": true
};