internal

Enumerations

AccessTypeEnum

• public - Public
• restricted - Restricted
• personal - Personal

Enumeration Members

Enumeration Member	Value
PERSONAL	"personal"
PUBLIC	"public"
RESTRICTED	"restricted"

---

CanvasExcludedComponentTypesEnum

Enumeration Members

Enumeration Member	Value
File	"File"
GridItem	"GridItem"
Root	"Root"
Slide	"Slide"

---

CanvasThemeStatus

Enumeration Members

Enumeration Member	Value
DRAFT	"draft"
READY	"ready"

---

CollaborationRoleEnum

Enumeration Members

Enumeration Member	Value
EDITOR	"editor"
VIEWER	"viewer"

---

ComponentTypes

Enumeration Members

Enumeration Member	Value
Block	"Block"
Carousel	"Carousel"
CollectionPlayer	"CollectionPlayer"
ContentGrid	"ContentGrid"
DataCharts	"DataCharts"
DynamicDataTable	"DynamicDataTable"
Embeddable	"Embeddable"
Grid	"Grid"
GridItem	"GridItem"
Html	"Html"
IFrame	"IFrame"
Link	"Link"
Multimedia	"Multimedia"
Page	"Page"
PageBreak	"PageBreak"
Root	"Root"
Scribble	"Scribble"
SectionList	"SectionList"
Text	"Text"
Timeline	"Timeline"

---

ContentGridLayoutTypes

Enumeration Members

Enumeration Member	Value
CAROUSEL	"carousel"
GRID	"grid"
LIST	"list"

---

ContentType

Enumeration Members

Enumeration Member	Value
Application	"application"
Block	"block"
Collection	"collection"

---

CoreFolderEntityType

Enumeration Members

Enumeration Member	Value
Block	"canvas_block"
Canvas	"canvas"
File	"file"
Section	"canvas_section"
Template	"canvas_template"

---

DownloadTypeEnum

• automatic - Automatic
• mandatory - Mandatory
• ondemand - On Demand

Enumeration Members

Enumeration Member	Value
AUTOMATIC	"automatic"
MANDATORY	"mandatory"
ONDEMAND	"ondemand"

---

EventExternalObjectContentTypeEnum

• event - Event
• opportunity - Opportunity
• account - Account
• other - Other

Enumeration Members

Enumeration Member	Value
ACCOUNT	"account"
EVENT	"event"
OPPORTUNITY	"opportunity"
OTHER	"other"

---

EventStatusEnum

• planned - Planned
• executed - Executed
• canceled - Canceled

Enumeration Members

Enumeration Member	Value
CANCELED	"canceled"
EXECUTED	"executed"
PLANNED	"planned"

---

FileContentTypeEnum

• ar - AR
• font - Font
• image - Image
• pdf - PDF
• video - Video
• web - Web

Enumeration Members

Enumeration Member	Value
AR	"ar"
FONT	"font"
IMAGE	"image"
PDF	"pdf"
VIDEO	"video"
WEB	"web"

---

FileStatusEnum

• pending - Pending
• viewable - Viewable
• failed - Failed

Enumeration Members

Enumeration Member	Value
FAILED	"failed"
PENDING	"pending"
VIEWABLE	"viewable"

---

FileTypeEnum

• app - App
• asset - Asset
• content - Content

Enumeration Members

Enumeration Member	Value
APP	"app"
ASSET	"asset"
CONTENT	"content"

---

GridLayoutTypes

Enumeration Members

Enumeration Member	Value
FOUR_EQUAL	"four-equal"
ONE	"one"
THREE_EQUAL	"three-equal"
TWO_EQUAL	"two-equal"
TWO_LEFT	"two-left"
TWO_RIGHT	"two-right"

---

InstanceMembershipRoleEnum

• admin - Admin
• editor - Editor
• member - Member

Enumeration Members

Enumeration Member	Value
ADMIN	"admin"
EDITOR	"editor"
MEMBER	"member"

---

LanguageEnum

• en - English
• de - Deutsch
• pl - Polski
• tr - Türkçe

Enumeration Members

Enumeration Member	Value
DE	"de"
EN	"en"
PL	"pl"
TR	"tr"

---

LinkAlignmentTypes

Enumeration Members

Enumeration Member	Value
CENTER	"center"
LEFT	"left"
RIGHT	"right"

---

LinkAnchorTypes

Enumeration Members

Enumeration Member	Value
CANVAS_ANCHOR	"canvas-anchor"
FILE	"file"
WEB	"web"

---

LinkPreviewTypes

Enumeration Members

Enumeration Member	Value
OUTLINE_BUTTON	"outline-button"
SOLID_BUTTON	"solid-button"
TEXT_LINK	"text-link"

---

MetadataTemplateFieldTypeEnum

• text - Text
• number - Number
• date - Date
• select - Dropdown - Single Select
• multi-select - Dropdown - Multiple Select
• checkbox - Checkbox

Enumeration Members

Enumeration Member	Value
CHECKBOX	"checkbox"
DATE	"date"
MULTI_SELECT	"multi-select"
NUMBER	"number"
SELECT	"select"
TEXT	"text"

---

MultimediaHorizontalAlignmentOptions

Enumeration Members

Enumeration Member	Value
CENTER	"center"
LEFT	"left"
RIGHT	"right"

---

OperatorEnum

• exact - exact
• iexact - iexact
• contains - contains
• icontains - icontains
• in - in
• gt - gt
• gte - gte
• lt - lt
• lte - lte
• startswith - startswith
• istartswith - istartswith
• endswith - endswith
• iendswith - iendswith
• range - range
• date - date
• year - year
• iso_year - iso_year
• month - month
• day - day
• week - week
• week_day - week_day
• iso_week_day - iso_week_day
• quarter - quarter
• time - time
• hour - hour
• minute - minute
• second - second
• isnull - isnull
• regex - regex
• iregex - iregex

Enumeration Members

Enumeration Member	Value
CONTAINS	"contains"
DATE	"date"
DAY	"day"
ENDSWITH	"endswith"
EXACT	"exact"
GT	"gt"
GTE	"gte"
HOUR	"hour"
ICONTAINS	"icontains"
IENDSWITH	"iendswith"
IEXACT	"iexact"
IN	"in"
IREGEX	"iregex"
ISNULL	"isnull"
ISO_WEEK_DAY	"iso_week_day"
ISO_YEAR	"iso_year"
ISTARTSWITH	"istartswith"
LT	"lt"
LTE	"lte"
MINUTE	"minute"
MONTH	"month"
QUARTER	"quarter"
RANGE	"range"
REGEX	"regex"
SECOND	"second"
STARTSWITH	"startswith"
TIME	"time"
WEEK	"week"
WEEK_DAY	"week_day"
YEAR	"year"

---

StorageRegionEnum

• au - Australia
• eu - EU
• us - US

Enumeration Members

Enumeration Member	Value
AU	"au"
EU	"eu"
US	"us"

---

UserRoleEnum

• admin - Admin
• member - Member
• developer - Developer

Enumeration Members

Enumeration Member	Value
ADMIN	"admin"
DEVELOPER	"developer"
MEMBER	"member"

Classes

EventEmitter<KeyMap>

Extended by

• LowLevelApi

Type Parameters

Type Parameter
KeyMap extends EventMap

Implements

• Emitter<KeyMap>

Constructors

new EventEmitter()

new EventEmitter<KeyMap>(): EventEmitter<KeyMap>

Returns

EventEmitter<KeyMap>

Properties

Property	Type	Default value
listeners	object	{}

Methods

emit()

emit<Key>(eventName, data?): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
data?	KeyMap[Key]

Returns

void

Implementation of

Emitter.emit

---

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

Implementation of

Emitter.off

---

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

Implementation of

Emitter.on

---

LowLevelApi

Extends

• EventEmitter<ApiEventMap>

Implements

• PitcherAPI

Constructors

new LowLevelApi()

new LowLevelApi(options?): LowLevelApi

Parameters

Parameter	Type
options?	ApiOptions

Returns

LowLevelApi

Overrides

EventEmitter.constructor

Properties

Property	Type	Default value	Inherited from
callbacks	object	undefined	-
listeners	object	{}	EventEmitter.listeners

Methods

emit()

emit<Key>(eventName, data?): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
data?	ApiEventMap[Key]

Returns

void

Implementation of

PitcherAPI.emit

Inherited from

EventEmitter.emit

---

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<ApiEventMap[Key]>

Returns

void

Implementation of

PitcherAPI.off

Inherited from

EventEmitter.off

---

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<ApiEventMap[Key]>

Returns

void

Implementation of

PitcherAPI.on

Inherited from

EventEmitter.on

---

request()

request(type, body): Promise<any>

Parameters

Parameter	Type	Default value
type	string	undefined
body	null | object	null

Returns

Promise<any>

Implementation of

PitcherAPI.request

Interfaces

CanvasIndicator

Properties

Property	Type
background_color?	string
color?	string
icon	string
key	string
text	string
tooltip_text?	string
type?	"default" | "error" | "info" | "warning" | "success" | "primary"

---

CanvasThemeAsset

Properties

Property	Type
id	string
name	string
url	string

---

CanvasThemeRetrieve

Properties

Property	Type
assets?	CanvasThemeAsset[]
created_at	string
created_by	User
id	string
instance_id	string
is_default	boolean
logo?	CanvasThemeAsset
modified_at	string
modified_by?	User
name	string
owned_by	User
settings	CanvasThemeSettings
status	CanvasThemeStatus
typography	Record<string, CanvasTypographyPreset>
used_in_canvases_count?	number

---

CanvasThemeSettings

Properties

Property	Type
assets?	CanvasThemeAsset[]
background_color	string
component_spacing	number
palette	string[]

---

CarouselProps

Properties

Property	Type
images?	object[]
include_all_images_in_pdf?	boolean
placeholder_height?	string

---

ComponentNode<T>

Type Parameters

Type Parameter	Default type
T	AvailableComponentProps

Properties

Property	Type
allow_admins_to_overwrite?	boolean
autofill?	"off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags"
autofill_content_types?	null | FileContentTypeEnum[]
children?	ComponentNode<AvailableComponentProps>[]
data?	T
height?	string
id	string
linkable?	ComponentNodeLinkable
print?	ComponentNodePrint
style?	Record<string, any>
tags?	string[]
theme_meta?	ComponentNodeThemeMeta
tracking_id	string
type	ComponentTypes
visible?	ComponentNodeVisible
when_used_in_section?	object
when_used_in_section.is_editable	boolean
when_used_in_section.is_removable	boolean

---

ComponentNodeDynamicDataTableThemeMeta

Extends

• ComponentNodeGenericThemeMeta

Properties

Property	Type	Inherited from
bg_color_palette_index?	number	ComponentNodeGenericThemeMeta.bg_color_palette_index
dt_group_header_bg_palette_index?	number	-
dt_header_bg_palette_index?	number	-

---

ComponentNodeGenericThemeMeta

Extended by

• ComponentNodeDynamicDataTableThemeMeta
• ComponentNodeMultimediaThemeMeta

Properties

Property	Type
bg_color_palette_index?	number

---

ComponentNodeLinkable

Properties

Property	Type
linkable_in_templates	boolean

---

ComponentNodeMultimediaThemeMeta

Extends

• ComponentNodeGenericThemeMeta

Properties

Property	Type	Inherited from
bg_color_palette_index?	number	ComponentNodeGenericThemeMeta.bg_color_palette_index
is_theme_logo?	boolean	-
theme_asset_index?	number	-

---

ComponentNodePrint

Properties

Property	Type
scale_to_fit_page?	boolean

---

ComponentNodeVisible

Properties

Property	Type
edit_mode	boolean
pdf	boolean
presentation_mode	boolean
web	boolean

---

ContentGridProps

Properties

Property	Type
data_accessor?	string
items	(ContentGridItemSlideProps | ContentGridItemFileProps)[]
layout_type?	ContentGridLayoutTypes
size?	"medium"

---

CoreFolderRetrieve

Properties

Property	Type
access_type	"private" | "public"
breadcrumbs	object[]
created_at	string
created_by	MiniUser
files_count	number
folders_count	number
id	string
instance_id	string
metadata	Record<string, any>
modified_at	string
modified_by	null | MiniUser
name	string
owned_by	MiniUser
parent_id	null | string
path	string

---

DeviceFile

Properties

Property	Type
name	string
path	string
size	number
type	string

---

DeviceFileCreateRequest

Extends

• Omit<FileCreateRequest, "content">

Properties

Property	Type	Description	Inherited from
access_type?	AccessTypeEnum	-	Omit.access_type
app_metadata?	Record<string, any>	-	Omit.app_metadata
content_upload_id?	string	-	Omit.content_upload_id
download_type?	DownloadTypeEnum	-	Omit.download_type
expires_at?	null | string	-	Omit.expires_at
folder_id?	string	-	Omit.folder_id
instance_id	string	-	Omit.instance_id
is_asset?	boolean	Deprecated: Please use the 'type' field instead. This field is maintained for backward compatibility and may be removed in future releases.	Omit.is_asset
metadata?	Record<string, any>	-	Omit.metadata
name?	string	-	Omit.name
owned_by_id?	null | number	-	Omit.owned_by_id
path	string	-	-
permissions?	FilePermissionRequest	-	Omit.permissions
tags?	string[]	-	Omit.tags
thumbnail?	Blob	-	Omit.thumbnail
thumbnail_upload_id?	string	-	Omit.thumbnail_upload_id
type?	FileTypeEnum	-	Omit.type
url?	string	-	Omit.url

---

EmbeddableProps

Properties

Property	Type
app_name	string
embed_locations?	EmbedLocation[]
file	null | ContentGridFileProps
full_screen_mode?	boolean
headless_locations?	EmbedLocation[]
height?	string
properties_by_embed_location?	Partial<Record<EmbedLocation, EmbeddedLocationProperties>>
settings?	Record<string, unknown>
src	null | string
type	"app"
width?	string

---

Emitter<KeyMap>

Extended by

• PitcherAPI
• PitcherInterface

Type Parameters

Type Parameter
KeyMap extends EventMap

Methods

emit()

emit<Key>(eventName, params): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
params	KeyMap[Key]

Returns

void

---

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

---

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

---

FileModel

Extends

• FileRetrieve

Properties

Property	Modifier	Type	Description	Inherited from
access_type?	public	AccessTypeEnum	-	FileRetrieve.access_type
app_metadata?	public	Record<string, any>	-	FileRetrieve.app_metadata
content_extension	readonly	null | string	-	FileRetrieve.content_extension
content_length	readonly	null | number	-	FileRetrieve.content_length
content_thumbnails	readonly	string[]	-	FileRetrieve.content_thumbnails
content_type	readonly	FileContentTypeEnum	-	FileRetrieve.content_type
content_url	readonly	null | string	-	FileRetrieve.content_url
created_at	readonly	string	-	FileRetrieve.created_at
created_by	readonly	MiniUser	-	FileRetrieve.created_by
download_type?	public	DownloadTypeEnum	-	FileRetrieve.download_type
expires_at?	public	null | string	-	FileRetrieve.expires_at
folder	readonly	MiniFolder	-	FileRetrieve.folder
folder_id?	public	string	-	FileRetrieve.folder_id
global_id	readonly	string	-	FileRetrieve.global_id
id	readonly	string	-	FileRetrieve.id
instance_id	readonly	string	-	FileRetrieve.instance_id
isDeleted	public	boolean	-	-
metadata?	public	Record<string, any>	-	FileRetrieve.metadata
modified_at	readonly	string	-	FileRetrieve.modified_at
modified_by	readonly	MiniUser	-	FileRetrieve.modified_by
name?	public	string	-	FileRetrieve.name
original_extension	readonly	null | string	-	FileRetrieve.original_extension
original_url	readonly	null | string	-	FileRetrieve.original_url
owned_by	readonly	MiniUser	-	FileRetrieve.owned_by
permissions?	public	FilePermission	-	FileRetrieve.permissions
pspdfkit_auth_payload	readonly	null | Record<string, any>	-	FileRetrieve.pspdfkit_auth_payload
pspdfkit_document_id	readonly	null | string	-	FileRetrieve.pspdfkit_document_id
pspdfkit_server_url	readonly	null | string	-	FileRetrieve.pspdfkit_server_url
published_at	readonly	null | string	-	FileRetrieve.published_at
role	readonly	CollaborationRoleEnum	Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.	FileRetrieve.role
shared_link	readonly	MiniSharedLink	-	FileRetrieve.shared_link
size	readonly	null | number	-	FileRetrieve.size
status	readonly	FileStatusEnum	-	FileRetrieve.status
tags?	public	string[]	-	FileRetrieve.tags
thumbnail_url	readonly	null | string	-	FileRetrieve.thumbnail_url
type	readonly	FileTypeEnum	-	FileRetrieve.type
version	readonly	FileVersion	-	FileRetrieve.version
zip_size	readonly	null | number	-	FileRetrieve.zip_size
zip_url	readonly	null | string	-	FileRetrieve.zip_url

---

GetCanvasesParams

Properties

Property	Type
account__id?	string
id__in?	string
instance_id?	string
is_default?	boolean
is_draft?	boolean
is_editable?	boolean
is_section?	boolean
is_template?	boolean
ordering?	string
page?	number
page_size?	number
search?	string
section_ids?	string[]
tags__in?	string[]

---

GetFavoritesParams

Properties

Property	Type
ordering?	string
page_size?	number
search?	string

---

GetUsersParams

Parameters for getting users

Properties

Property	Type	Description
filters?	Ref<any, any>	Filters for the user query, can be any type of Vue ref
search?	string | Ref<string, string>	Search term, can be a string or a Vue ref to a string

---

GridItemProps

Properties

Property	Type
span	number
tooltips?	GridItemTooltipProps[]

---

GridItemTooltipProps

Properties

Property	Type
content?	string
content_style?	Record<string, any>
trigger?	string
trigger_style?	Record<string, any>

---

GridProps

Properties

Property	Type
columns	number
layout_type	GridLayoutTypes

---

HtmlProps

Properties

Property	Type
html	string

---

IFrameProps

Properties

Property	Type
add_session_context?	boolean
full_screen_mode?	boolean
height?	string
src	null | string
width?	string

---

LinkProps

Properties

Property	Type
alignment?	LinkAlignmentTypes
background_color?	string
canvas_anchor?	string
color?	string
display_text?	string
file?	null | Partial<File> & object
font_family?	string
font_size?	number
link_type?	LinkAnchorTypes
page_index?	number
preview_type?	LinkPreviewTypes
target?	"_self" | "_blank"
url?	string

---

OrganizationMetadata

Properties

Property	Type
custom_domain	string
owner	string

---

PageBreakProps

---

PageProps

Properties

Property	Type
aspect_ratio?	"unlocked" | "contain" | "16:9" | "16:10" | "4:3" | "1:1"
background_video_url?	string

---

PitcherInstance

Extends

• Omit<Instance, "settings">

Properties

Property	Modifier	Type	Inherited from
color?	public	null | string	Omit.color
created_at	readonly	string	Omit.created_at
created_by	readonly	MiniUser	Omit.created_by
environment	readonly	MiniEnvironment	Omit.environment
id	readonly	string	Omit.id
last_login	readonly	string	Omit.last_login
logo?	public	null | string	Omit.logo
modified_at	readonly	string	Omit.modified_at
modified_by	readonly	MiniUser	Omit.modified_by
name	public	string	Omit.name
owned_by	readonly	MiniUser	Omit.owned_by
region	readonly	MiniRegion	Omit.region
role	readonly	InstanceMembershipRoleEnum	Omit.role
settings?	readonly	InstanceSettings	-
storage_region	readonly	StorageRegionEnum	Omit.storage_region

---

PitcherOrg

Extends

• Omit<Organization, "metadata" | "settings">

Properties

Property	Modifier	Type	Inherited from
branding	readonly	OrganizationBranding	Omit.branding
display_name	readonly	string	Omit.display_name
id	readonly	string	Omit.id
metadata	readonly	OrganizationMetadata	-
name	readonly	string	Omit.name
settings	readonly	OrganizationSettings	-

---

RefreshServiceTokenRequest

Request parameters for refreshing a service token

Properties

Property	Type	Description
provider?	string	Optional provider for the service token

---

RefreshServiceTokenResponse

Response from refreshing a service token

Properties

Property	Type	Description
access_token	string	The new access token

---

SectionListProps

Properties

Property	Type
animation_in?	string
is_restricted_to_preselections?	boolean
sections	SectionListSection[]
selection_app_name?	string
selection_strategy?	"app" | "free" | "single" | "at-least-one"

---

SectionListSection

Properties

Property	Type
aspect_ratio?	"unlocked" | "contain" | "16:9" | "16:10" | "4:3" | "1:1"
background_video_url?	string
id	string
style?	Record<string, any>

---

TextProps

Properties

Property	Type
content?	string

---

TimelineEvent

Properties

Property	Type
card_style?	Record<string, any>
description?	string
description_style?	Record<string, any>
icon?	string
icon_style?	Record<string, any>
image_style?	Record<string, any>
image_url?	string
title?	string
title_style?	Record<string, any>
top_hint?	string
top_hint_style?	Record<string, any>

---

TimelineProps

Properties

Property	Type
events	TimelineEvent[]
layout	"vertical" | "horizontal"

---

UpdateLocation

Base interface for update location actions.

Extended by

• UpdateLocationOnRegister
• UpdateLocationOnUnregister
• UpdateLocationOnUpdate
• UpdateLocationOnMounted
• UpdateLocationOnRestore
• UpdateLocationOnRestoreCompleted
• UpdateLocationOnGetRoutesRequest
• UpdateLocationOnGetRoutesResponse

Properties

Property	Type	Description
action	string	The action to be performed.

Type Aliases

Account

Account: object

Type declaration

id

id: string

name?

optional name: string

---

AccountRequest

AccountRequest: object

Type declaration

id

id: string

name?

optional name: string

---

Agenda

Agenda: object

Type declaration

filters?

optional filters: Record<string, any>

groups

groups: AgendaGroup[]

name

name: string

---

AgendaGroup

AgendaGroup: object

Type declaration

id

id: string

items

items: AgendaItem[]

name

name: string

---

AgendaItem

AgendaItem: object

Type declaration

content

content: CollectionPlayer

id

id: string

type

type: ValuesOf<ContentType>

---

AgendaSelectorProps

AgendaSelectorProps: object

Type declaration

attachTo?

optional attachTo: string | HTMLElement

initialAgenda?

optional initialAgenda: Agenda

openSettings?

optional openSettings: CollectionSelectorProps["openSettings"]

selectCollectionContent

selectCollectionContent: SelectCollectionContent

zIndex?

optional zIndex: number

---

AllFileCreateRequest

AllFileCreateRequest: FileCreateRequest | DeviceFileCreateRequest

---

AssetSelection

AssetSelection: object

Type declaration

fileId

fileId: FileRetrieve["id"]

type

type: "asset"

---

AutohideSectionOnCreated

AutohideSectionOnCreated: object

Type declaration

autohide_in_shared_link?

optional autohide_in_shared_link: string

start_date?

optional start_date: Date

---

AvailableComponentProps

AvailableComponentProps: GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | IFrameProps | LinkProps | PageBreakProps | PageProps | TimelineProps | CollectionPlayer

---

BackgroundSize

BackgroundSize: "auto" | "contain" | "cover" | "100% 100%"

---

Canvas

Canvas: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

account?

optional account: Account | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string | null

id

readonly id: string

indicators?

optional indicators: Record<string, any> | null

is_block?

optional is_block: boolean

is_default?

optional is_default: boolean

is_draft?

optional is_draft: boolean

is_editable?

optional is_editable: boolean

is_section?

optional is_section: boolean

is_template?

optional is_template: boolean

metadata?

optional metadata: any

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

shared_link

readonly shared_link: MiniSharedLink

start_at?

optional start_at: string | null

tags?

optional tags: string[]

template

readonly template: MiniCanvas

thumbnail_url?

optional thumbnail_url: string | null

---

CanvasComponentAvailability

CanvasComponentAvailability: object

Type declaration

Block

Block: boolean

Carousel

Carousel: boolean

CollectionPlayer

CollectionPlayer: boolean

ContentGrid

ContentGrid: boolean

DataCharts

DataCharts: boolean

DynamicDataTable

DynamicDataTable: boolean

Embeddable

Embeddable: boolean

Grid

Grid: boolean

Html

Html: boolean

IFrame

IFrame: boolean

Link

Link: boolean

Multimedia

Multimedia: boolean

Page

Page: boolean

PageBreak

PageBreak: boolean

Scribble

Scribble: boolean

SectionList

SectionList: boolean

Text

Text: boolean

Timeline

Timeline: boolean

---

CanvasComponentAvailabilityRoles

CanvasComponentAvailabilityRoles: object

Type declaration

Block

Block: object

Block.admin?

optional admin: boolean

Block.rep?

optional rep: boolean

Carousel

Carousel: object

Carousel.admin?

optional admin: boolean

Carousel.rep?

optional rep: boolean

CollectionPlayer

CollectionPlayer: object

CollectionPlayer.admin?

optional admin: boolean

CollectionPlayer.rep?

optional rep: boolean

ContentGrid

ContentGrid: object

ContentGrid.admin?

optional admin: boolean

ContentGrid.rep?

optional rep: boolean

DataCharts

DataCharts: object

DataCharts.admin?

optional admin: boolean

DataCharts.rep?

optional rep: boolean

DynamicDataTable

DynamicDataTable: object

DynamicDataTable.admin?

optional admin: boolean

DynamicDataTable.rep?

optional rep: boolean

Embeddable

Embeddable: object

Embeddable.admin?

optional admin: boolean

Embeddable.rep?

optional rep: boolean

Grid

Grid: object

Grid.admin?

optional admin: boolean

Grid.rep?

optional rep: boolean

Html

Html: object

Html.admin?

optional admin: boolean

Html.rep?

optional rep: boolean

IFrame

IFrame: object

IFrame.admin?

optional admin: boolean

IFrame.rep?

optional rep: boolean

Link

Link: object

Link.admin?

optional admin: boolean

Link.rep?

optional rep: boolean

Multimedia

Multimedia: object

Multimedia.admin?

optional admin: boolean

Multimedia.rep?

optional rep: boolean

Page

Page: object

Page.admin?

optional admin: boolean

Page.rep?

optional rep: boolean

PageBreak

PageBreak: object

PageBreak.admin?

optional admin: boolean

PageBreak.rep?

optional rep: boolean

Scribble

Scribble: object

Scribble.admin?

optional admin: boolean

Scribble.rep?

optional rep: boolean

SectionList

SectionList: object

SectionList.admin?

optional admin: boolean

SectionList.rep?

optional rep: boolean

Text

Text: object

Text.admin?

optional admin: boolean

Text.rep?

optional rep: boolean

Timeline

Timeline: object

Timeline.admin?

optional admin: boolean

Timeline.rep?

optional rep: boolean

---

CanvasComponentTypes

CanvasComponentTypes: object

Type declaration

[iterator]()

[iterator]: () => StringIterator<string>

Iterator

Returns

StringIterator<string>

anchor()

anchor: (name) => string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Parameter	Type	Description
name	string

Returns

string

Deprecated

A legacy feature for browser compatibility

at()

at: (index) => undefined | string

Returns a new String consisting of the single UTF-16 code unit located at the specified index.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | string

big()

big: () => string

Returns a <big> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

blink()

blink: () => string

Returns a <blink> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

bold()

bold: () => string

Returns a <b> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

charAt()

charAt: (pos) => string

Returns the character at the specified index.

Parameters

Parameter	Type	Description
pos	number	The zero-based index of the desired character.

Returns

string

charCodeAt()

charCodeAt: (index) => number

Returns the Unicode value of the character at the specified location.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

codePointAt()

codePointAt: (pos) => undefined | number

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Parameters

Parameter	Type
pos	number

Returns

undefined | number

concat()

concat: (...strings) => string

Returns a string that contains the concatenation of two or more strings.

Parameters

Parameter	Type	Description
...strings	string[]	The strings to append to the end of the string.

Returns

string

endsWith()

endsWith: (searchString, endPosition?) => boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

Parameters

Parameter	Type
searchString	string
endPosition?	number

Returns

boolean

fixed()

fixed: () => string

Returns a <tt> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

fontcolor()

fontcolor: (color) => string

Returns a <font> HTML element and sets the color attribute value

Parameters

Parameter	Type
color	string

Returns

string

Deprecated

A legacy feature for browser compatibility

fontsize()

fontsize: (size) => string(size) => string

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	number

Returns

string

Deprecated

A legacy feature for browser compatibility

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	string

Returns

string

Deprecated

A legacy feature for browser compatibility

includes()

includes: (searchString, position?) => boolean

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Parameters

Parameter	Type	Description
searchString	string	search string
position?	number	If position is undefined, 0 is assumed, so as to search all of the String.

Returns

boolean

indexOf()

indexOf: (searchString, position?) => number

Returns the position of the first occurrence of a substring.

Parameters

Parameter	Type	Description
searchString	string	The substring to search for in the string
position?	number	The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns

number

isWellFormed()

isWellFormed: () => boolean

Returns true if all leading surrogates and trailing surrogates appear paired and in order.

Returns

boolean

italics()

italics: () => string

Returns an <i> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

lastIndexOf()

lastIndexOf: (searchString, position?) => number

Returns the last occurrence of a substring in the string.

Parameters

Parameter	Type	Description
searchString	string	The substring to search for.
position?	number	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

length

length: number

link()

link: (url) => string

Returns an <a> HTML element and sets the href attribute value

Parameters

Parameter	Type
url	string

Returns

string

Deprecated

A legacy feature for browser compatibility

localeCompare()

localeCompare: (that) => number(that, locales?, options?) => number(that, locales?, options?) => number

Determines whether two strings are equivalent in the current locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	string | string[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	LocalesArgument	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

match()

match: (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	A variable name or string literal containing the regular expression pattern and flags.

Returns

null | RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

Parameters

Parameter	Type	Description
matcher	{}	An object that supports being matched against.

Returns

null | RegExpMatchArray

matchAll()

matchAll: (regexp) => RegExpStringIterator<RegExpExecArray>

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

Parameters

Parameter	Type	Description
regexp	RegExp	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpStringIterator<RegExpExecArray>

normalize()

normalize: (form) => string(form?) => string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form	"NFC" | "NFD" | "NFKC" | "NFKD"	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form?	string	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

padEnd()

padEnd: (maxLength, fillString?) => string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Parameters

Parameter	Type	Description
maxLength	number	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
fillString?	string	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

padStart()

padStart: (maxLength, fillString?) => string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Parameters

Parameter	Type	Description
maxLength	number	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
fillString?	string	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

repeat()

repeat: (count) => string

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Parameters

Parameter	Type	Description
count	number	number of copies to append

Returns

string

replace()

replace: (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string or regular expression to search for.
replaceValue	string	A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.

Returns

string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

Parameters

Parameter	Type	Description
searchValue	{}	An object that supports searching for and replacing matches within a string.
replaceValue	string	The replacement text.

Returns

string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Parameter	Type	Description
searchValue	{}	A object can search for and replace matches within a string.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

replaceAll()

replaceAll: (searchValue, replaceValue) => string(searchValue, replacer) => string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replaceValue	string	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

search()

search: (regexp) => number(searcher) => number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	The regular expression pattern and applicable flags.

Returns

number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
searcher	{}	An object which supports searching within a string.

Returns

number

slice()

slice: (start?, end?) => string

Returns a section of a string.

Parameters

Parameter	Type	Description
start?	number	The index to the beginning of the specified portion of stringObj.
end?	number	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Returns

string

small()

small: () => string

Returns a <small> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

split()

split: (separator, limit?) => string[](splitter, limit?) => string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
separator	string | RegExp	A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
splitter	{}	An object that can split a string.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

startsWith()

startsWith: (searchString, position?) => boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

Parameters

Parameter	Type
searchString	string
position?	number

Returns

boolean

strike()

strike: () => string

Returns a <strike> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

sub()

sub: () => string

Returns a <sub> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

substr()

substr: (from, length?) => string

Gets a substring beginning at the specified location and having the specified length.

Parameters

Parameter	Type	Description
from	number	The starting position of the desired substring. The index of the first character in the string is zero.
length?	number	The number of characters to include in the returned substring.

Returns

string

Deprecated

A legacy feature for browser compatibility

substring()

substring: (start, end?) => string

Returns the substring at the specified location within a String object.

Parameters

Parameter	Type	Description
start	number	The zero-based index number indicating the beginning of the substring.
end?	number	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

sup()

sup: () => string

Returns a <sup> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

toLocaleLowerCase()

toLocaleLowerCase: (locales?) => string(locales?) => string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

toLocaleUpperCase()

toLocaleUpperCase: (locales?) => string(locales?) => string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

toLowerCase()

toLowerCase: () => string

Converts all the alphabetic characters in a string to lowercase.

Returns

string

toString()

toString: () => string

Returns a string representation of a string.

Returns

string

toUpperCase()

toUpperCase: () => string

Converts all the alphabetic characters in a string to uppercase.

Returns

string

toWellFormed()

toWellFormed: () => string

Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).

Returns

string

trim()

trim: () => string

Removes the leading and trailing white space and line terminator characters from a string.

Returns

string

trimEnd()

trimEnd: () => string

Removes the trailing white space and line terminator characters from a string.

Returns

string

trimLeft()

trimLeft: () => string

Removes the leading white space and line terminator characters from a string.

Returns

string

Deprecated

A legacy feature for browser compatibility. Use trimStart instead

trimRight()

trimRight: () => string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Deprecated

A legacy feature for browser compatibility. Use trimEnd instead

trimStart()

trimStart: () => string

Removes the leading white space and line terminator characters from a string.

Returns

string

valueOf()

valueOf: () => string

Returns the primitive value of the specified object.

Returns

string

---

CanvasCreateRequest

CanvasCreateRequest: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

account?

optional account: AccountRequest | null

content?

optional content: Record<string, any>

context?

optional context: any

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string | null

id?

optional id: string

indicators?

optional indicators: Record<string, any> | null

instance_id

instance_id: string

is_block?

optional is_block: boolean

is_default?

optional is_default: boolean

is_draft?

optional is_draft: boolean

is_editable?

optional is_editable: boolean

is_section?

optional is_section: boolean

is_template?

optional is_template: boolean

metadata?

optional metadata: any

name

name: string

owned_by_id?

optional owned_by_id: number | null

start_at?

optional start_at: string | null

tags?

optional tags: string[]

template_id?

optional template_id: string | null

theme?

optional theme: Record<string, any> | null

thumbnail_url?

optional thumbnail_url: string | null

---

CanvasExcludedComponentTypes

CanvasExcludedComponentTypes: keyof typeof CanvasExcludedComponentTypesEnum

---

CanvasManagerTableColumns

CanvasManagerTableColumns: object

Type declaration

canvas_templates

canvas_templates: CanvasManagerVisibility

canvases

canvases: CanvasManagerVisibility

section_templates

section_templates: CanvasManagerVisibility

sections

sections: CanvasManagerVisibility

---

CanvasManagerVisibility

CanvasManagerVisibility: object

Type declaration

hide

hide: string[]

order

order: string[]

---

CanvasRecommendedFile

CanvasRecommendedFile: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

app_metadata?

optional app_metadata: Record<string, any>

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type: DownloadTypeEnum

expires_at?

optional expires_at: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name?

optional name: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions: FilePermission

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

CanvasRecommendedFiles

CanvasRecommendedFiles: object

Type declaration

recommended_files

recommended_files: CanvasRecommendedFile[]

---

CanvasRetrieve

CanvasRetrieve: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

account?

optional account: Account | null

content?

optional content: Record<string, any>

context?

optional context: any

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

events

readonly events: MiniEvent[]

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string | null

id

readonly id: string

indicators?

optional indicators: Record<string, any> | null

instance_id

instance_id: string

is_block?

optional is_block: boolean

is_default?

optional is_default: boolean

is_draft?

optional is_draft: boolean

is_editable?

optional is_editable: boolean

is_section?

optional is_section: boolean

is_template?

optional is_template: boolean

metadata?

optional metadata: any

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

sections

readonly sections: CanvasSection[]

shared_link

readonly shared_link: MiniSharedLink

start_at?

optional start_at: string | null

tags?

optional tags: string[]

template

readonly template: MiniCanvas

theme?

optional theme: Record<string, any> | null

thumbnail_url?

optional thumbnail_url: string | null

---

CanvasSection

CanvasSection: object

Serializer used solely for defining the OpenAPI schema in extend_schema_field.

Type declaration

content

content: Record<string, any>

id

readonly id: string

is_draft

is_draft: boolean

metadata?

optional metadata: Record<string, any>

name

name: string

theme?

optional theme: Record<string, any> | null

---

CanvasSelection

CanvasSelection: object

Type declaration

id

id: Canvas["id"]

---

CanvasTypographyPreset

CanvasTypographyPreset: object

Type declaration

color

color: string

font_family

font_family: string

font_size

font_size: string

font_weight

font_weight: "400" | "700"

id

id: CanvasTypographyPresetId

letter_spacing

letter_spacing: string

line_height

line_height: string

text_transform

text_transform: "capitalize" | "lowercase" | "none" | "uppercase"

---

CanvasTypographyPresetId

CanvasTypographyPresetId: "h_1" | "h_2" | "h_3" | "big_text" | "normal_text" | "small_text"

---

CollectionFile

CollectionFile: object

Type declaration

file

file: CollectionFileEntity

id

id: string

type

type: "file"

---

CollectionFileEntity

CollectionFileEntity: object

Type declaration

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: null | string

id

readonly id: string

metadata?

optional metadata: undefined | Record<string, any>

name?

optional name: undefined | string

permissions?

optional permissions: undefined | FilePermission

pspdfkit_auth_payload

readonly pspdfkit_auth_payload: null | Record<string, any>

pspdfkit_document_id

readonly pspdfkit_document_id: null | string

pspdfkit_server_url

readonly pspdfkit_server_url: null | string

tags?

optional tags: undefined | string[]

thumbnail_url

readonly thumbnail_url: null | string

type

readonly type: FileTypeEnum

---

CollectionGroup

CollectionGroup: object

Type declaration

id

id: string

name

name: string

slides

slides: CollectionSlide[]

---

CollectionPage

CollectionPage: object

Type declaration

file

file: CollectionFileEntity

id

id: string

slide

slide: object

slide.index

index: number

slide.url

url: FileRetrieve["thumbnail_url"]

type

type: "slide"

---

CollectionPlayer

CollectionPlayer: object

Type declaration

data_accessor?

optional data_accessor: string

filters?

optional filters: Record<string, any>

groups

groups: CollectionGroup[]

hide_footer?

optional hide_footer: boolean

name

name: string

---

CollectionSelectorProps

CollectionSelectorProps: object

Type declaration

attachTo?

optional attachTo: string | HTMLElement

closeOnSettings?

optional closeOnSettings: boolean

fetchFile()

fetchFile: (id) => Promise<FileRetrieve>

Parameters

Parameter	Type
id	string

Returns

Promise<FileRetrieve>

fetchFileList

fetchFileList: FetchFileList

hideClose?

optional hideClose: boolean

initialData?

optional initialData: CollectionPlayer

initialMetadataFilters?

optional initialMetadataFilters: Record<string, any>

openSettings()?

optional openSettings: () => void

Returns

void

readonlyName?

optional readonlyName: boolean

selectFileContent

selectFileContent: SelectFileContent

translations?

optional translations: Translations

zIndex?

optional zIndex: number

---

CollectionSlide

CollectionSlide: CollectionPage | CollectionFile

---

ComponentNodeThemeMeta

ComponentNodeThemeMeta: ComponentNodeGenericThemeMeta | ComponentNodeDynamicDataTableThemeMeta | ComponentNodeMultimediaThemeMeta

---

ConnectedService

ConnectedService: object

Type declaration

access_token?

optional access_token: string

connection_id

connection_id: string

name

name: string

provider

provider: string

type

type: string

urls?

optional urls: Record<string, string>

user_id?

optional user_id: string

---

ContentGridCommonFileProps

ContentGridCommonFileProps: object

Type declaration

content_extension?

optional content_extension: FileRetrieve["content_extension"]

content_type?

optional content_type: FileContentTypeEnum | null

content_url?

optional content_url: FileRetrieve["content_url"]

expires_at?

optional expires_at: FileRetrieve["expires_at"]

id

id: FileRetrieve["id"]

is_deleted?

optional is_deleted: boolean

name

name: FileRetrieve["name"]

permissions?

optional permissions: FileRetrieve["permissions"]

snapshot_id?

optional snapshot_id: FileRetrieve["id"]

tags?

optional tags: FileRetrieve["tags"]

---

ContentGridFileProps

ContentGridFileProps: object

Type declaration

content_extension

content_extension: null | string

content_length?

readonly optional content_length: undefined | null | number

content_thumbnails?

optional content_thumbnails: undefined | null | string[]

content_type

content_type: null | AR | FONT | IMAGE | PDF | VIDEO | WEB

content_url

content_url: null | string

expires_at

expires_at: undefined | null | string

id

id: string

is_deleted

is_deleted: undefined | boolean

name

name: undefined | string

permissions

permissions: undefined | FilePermission

pspdfkit_auth_payload?

readonly optional pspdfkit_auth_payload: undefined | null | Record<string, any>

pspdfkit_server_url?

readonly optional pspdfkit_server_url: undefined | null | string

snapshot_id

snapshot_id: undefined | string

tags

tags: undefined | string[]

thumbnail_url?

optional thumbnail_url: undefined | null | string

---

ContentGridItemFileProps

ContentGridItemFileProps: object

Type declaration

file

file: ContentGridFileProps

type

type: "file"

---

ContentGridItemSlideProps

ContentGridItemSlideProps: object

Type declaration

file

file: ContentGridCommonFileProps

slide

slide: object

slide.index

index: number

slide.url?

optional url: FileRetrieve["content_thumbnails"][number]

type

type: "slide"

---

ContentSelection

ContentSelection: object

Type declaration

file?

optional file: Pick<FileRetrieve, "id" | "name">

fileId

fileId: FileRetrieve["id"]

name?

optional name: string

pageIndex?

optional pageIndex: number

type

type: "file" | "page"

---

CoreFolderContentsRetrieve

CoreFolderContentsRetrieve: object

Type declaration

contents

contents: CanvasRetrieve[]

folders

folders: CoreFolderRetrieve[]

id

id: string

name

name: string

path?

optional path: any[]

---

EmbeddedLocationProperties

EmbeddedLocationProperties: object

Type declaration

start_in_loading_mode?

optional start_in_loading_mode: boolean

---

EmbedLocation

EmbedLocation: "ui_app" | "canvas" | "dsr" | "admin_instance" | "overlay_app" | "canvas_section_execution" | "canvas_drawer"

---

Enumerate<N, Acc>

Enumerate<N, Acc>: Acc["length"] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc["length"]]>

Type Parameters

Type Parameter	Default type
N extends number	-
Acc extends number[]	[]

---

Event

Event: object

Type declaration

attendees?

optional attendees: EventAttendee[]

canvas

readonly canvas: MiniCanvas

description?

optional description: string

end_at

end_at: string

external_objects?

optional external_objects: EventExternalObject[]

id?

optional id: string

location?

optional location: string

metadata?

optional metadata: any

start_at

start_at: string

status?

optional status: EventStatusEnum

subject?

optional subject: string

---

EventAttendee

EventAttendee: object

Type declaration

email

email: string

full_name?

optional full_name: string

title?

optional title: string

---

EventAttendeeRequest

EventAttendeeRequest: object

Type declaration

email

email: string

full_name?

optional full_name: string

title?

optional title: string

---

EventExternalObject

EventExternalObject: object

Type declaration

connection_id

connection_id: string

content_type?

optional content_type: EventExternalObjectContentTypeEnum

description?

optional description: string

external_content_type?

optional external_content_type: string

external_object_id

external_object_id: string

name?

optional name: string

---

EventExternalObjectRequest

EventExternalObjectRequest: object

Type declaration

connection_id

connection_id: string

content_type?

optional content_type: EventExternalObjectContentTypeEnum

description?

optional description: string

external_content_type?

optional external_content_type: string

external_object_id

external_object_id: string

name?

optional name: string

---

EventKey<KeyMap>

EventKey<KeyMap>: object

Type Parameters

Type Parameter
KeyMap extends EventMap

Type declaration

[iterator]()

[iterator]: () => StringIterator<string>

Iterator

Returns

StringIterator<string>

anchor()

anchor: (name) => string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Parameter	Type	Description
name	string

Returns

string

Deprecated

A legacy feature for browser compatibility

at

at: (index) => undefined | string & (index) => undefined | string | (index) => undefined | string | (index) => undefined | string

Type declaration

(index) => undefined | string & (index) => undefined | string

(index) => undefined | string

Returns a new String consisting of the single UTF-16 code unit located at the specified index.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | string

(index) => undefined | string

Returns a new String consisting of the single UTF-16 code unit located at the specified index.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | string

big()

big: () => string

Returns a <big> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

blink()

blink: () => string

Returns a <blink> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

bold()

bold: () => string

Returns a <b> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

charAt()

charAt: (pos) => string

Returns the character at the specified index.

Parameters

Parameter	Type	Description
pos	number	The zero-based index of the desired character.

Returns

string

charCodeAt()

charCodeAt: (index) => number

Returns the Unicode value of the character at the specified location.

Parameters

Parameter	Type	Description
index	number	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

codePointAt

codePointAt: (pos) => undefined | number & (pos) => undefined | number | (pos) => undefined | number | (pos) => undefined | number

Type declaration

(pos) => undefined | number & (pos) => undefined | number

(pos) => undefined | number

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Parameters

Parameter	Type
pos	number

Returns

undefined | number

(pos) => undefined | number

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Parameters

Parameter	Type
pos	number

Returns

undefined | number

concat()

concat: (...strings) => string

Returns a string that contains the concatenation of two or more strings.

Parameters

Parameter	Type	Description
...strings	string[]	The strings to append to the end of the string.

Returns

string

endsWith()

endsWith: (searchString, endPosition?) => boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

Parameters

Parameter	Type
searchString	string
endPosition?	number

Returns

boolean

fixed()

fixed: () => string

Returns a <tt> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

fontcolor()

fontcolor: (color) => string

Returns a <font> HTML element and sets the color attribute value

Parameters

Parameter	Type
color	string

Returns

string

Deprecated

A legacy feature for browser compatibility

fontsize

fontsize: (size) => string(size) => string & (size) => string(size) => string | (size) => string(size) => string | (size) => string(size) => string

Type declaration

(size) => string(size) => string & (size) => string(size) => string

(size) => string(size) => string

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	number

Returns

string

Deprecated

A legacy feature for browser compatibility

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	string

Returns

string

Deprecated

A legacy feature for browser compatibility

(size) => string(size) => string

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	number

Returns

string

Deprecated

A legacy feature for browser compatibility

Returns a <font> HTML element and sets the size attribute value

Parameters

Parameter	Type
size	string

Returns

string

Deprecated

A legacy feature for browser compatibility

includes()

includes: (searchString, position?) => boolean

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Parameters

Parameter	Type	Description
searchString	string	search string
position?	number	If position is undefined, 0 is assumed, so as to search all of the String.

Returns

boolean

indexOf()

indexOf: (searchString, position?) => number

Returns the position of the first occurrence of a substring.

Parameters

Parameter	Type	Description
searchString	string	The substring to search for in the string
position?	number	The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns

number

isWellFormed()

isWellFormed: () => boolean

Returns true if all leading surrogates and trailing surrogates appear paired and in order.

Returns

boolean

italics()

italics: () => string

Returns an <i> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

lastIndexOf()

lastIndexOf: (searchString, position?) => number

Returns the last occurrence of a substring in the string.

Parameters

Parameter	Type	Description
searchString	string	The substring to search for.
position?	number	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

length

length: number

link()

link: (url) => string

Returns an <a> HTML element and sets the href attribute value

Parameters

Parameter	Type
url	string

Returns

string

Deprecated

A legacy feature for browser compatibility

localeCompare

localeCompare: (that) => number(that, locales?, options?) => number(that, locales?, options?) => number & (that) => number(that, locales?, options?) => number(that, locales?, options?) => number | (that) => number(that, locales?, options?) => number(that, locales?, options?) => number | (that) => number(that, locales?, options?) => number(that, locales?, options?) => number

Type declaration

(that) => number(that, locales?, options?) => number(that, locales?, options?) => number & (that) => number(that, locales?, options?) => number(that, locales?, options?) => number

(that) => number(that, locales?, options?) => number(that, locales?, options?) => number

Determines whether two strings are equivalent in the current locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	string | string[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	LocalesArgument	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

(that) => number(that, locales?, options?) => number(that, locales?, options?) => number

Determines whether two strings are equivalent in the current locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	string | string[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Parameter	Type	Description
that	string	String to compare to target string
locales?	LocalesArgument	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
options?	CollatorOptions	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

match

match: (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray & (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray | (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray | (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray

Type declaration

(regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray & (regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray

(regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	A variable name or string literal containing the regular expression pattern and flags.

Returns

null | RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

Parameters

Parameter	Type	Description
matcher	{}	An object that supports being matched against.

Returns

null | RegExpMatchArray

(regexp) => null | RegExpMatchArray(matcher) => null | RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	A variable name or string literal containing the regular expression pattern and flags.

Returns

null | RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

Parameters

Parameter	Type	Description
matcher	{}	An object that supports being matched against.

Returns

null | RegExpMatchArray

matchAll()

matchAll: (regexp) => RegExpStringIterator<RegExpExecArray>

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

Parameters

Parameter	Type	Description
regexp	RegExp	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpStringIterator<RegExpExecArray>

normalize

normalize: (form) => string(form?) => string & (form) => string(form?) => string | (form) => string(form?) => string | (form) => string(form?) => string

Type declaration

(form) => string(form?) => string & (form) => string(form?) => string

(form) => string(form?) => string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form	"NFC" | "NFD" | "NFKC" | "NFKD"	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form?	string	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

(form) => string(form?) => string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form	"NFC" | "NFD" | "NFKC" | "NFKD"	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Parameter	Type	Description
form?	string	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

padEnd()

padEnd: (maxLength, fillString?) => string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Parameters

Parameter	Type	Description
maxLength	number	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
fillString?	string	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

padStart()

padStart: (maxLength, fillString?) => string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Parameters

Parameter	Type	Description
maxLength	number	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
fillString?	string	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

repeat()

repeat: (count) => string

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Parameters

Parameter	Type	Description
count	number	number of copies to append

Returns

string

replace

replace: (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string & (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string | (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string | (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string

Type declaration

(searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string & (searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string

(searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string or regular expression to search for.
replaceValue	string	A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.

Returns

string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

Parameters

Parameter	Type	Description
searchValue	{}	An object that supports searching for and replacing matches within a string.
replaceValue	string	The replacement text.

Returns

string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Parameter	Type	Description
searchValue	{}	A object can search for and replace matches within a string.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

(searchValue, replaceValue) => string(searchValue, replacer) => string(searchValue, replaceValue) => string(searchValue, replacer) => string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string or regular expression to search for.
replaceValue	string	A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.

Returns

string

Replaces text in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

Parameters

Parameter	Type	Description
searchValue	{}	An object that supports searching for and replacing matches within a string.
replaceValue	string	The replacement text.

Returns

string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Parameter	Type	Description
searchValue	{}	A object can search for and replace matches within a string.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

replaceAll

replaceAll: (searchValue, replaceValue) => string(searchValue, replacer) => string & (searchValue, replaceValue) => string(searchValue, replacer) => string | (searchValue, replaceValue) => string(searchValue, replacer) => string | (searchValue, replaceValue) => string(searchValue, replacer) => string

Type declaration

(searchValue, replaceValue) => string(searchValue, replacer) => string & (searchValue, replaceValue) => string(searchValue, replacer) => string

(searchValue, replaceValue) => string(searchValue, replacer) => string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replaceValue	string	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

(searchValue, replaceValue) => string(searchValue, replacer) => string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replaceValue	string	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters

Parameter	Type	Description
searchValue	string | RegExp	A string to search for.
replacer	(substring, ...args) => string	A function that returns the replacement text.

Returns

string

search

search: (regexp) => number(searcher) => number & (regexp) => number(searcher) => number | (regexp) => number(searcher) => number | (regexp) => number(searcher) => number

Type declaration

(regexp) => number(searcher) => number & (regexp) => number(searcher) => number

(regexp) => number(searcher) => number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	The regular expression pattern and applicable flags.

Returns

number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
searcher	{}	An object which supports searching within a string.

Returns

number

(regexp) => number(searcher) => number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
regexp	string | RegExp	The regular expression pattern and applicable flags.

Returns

number

Finds the first substring match in a regular expression search.

Parameters

Parameter	Type	Description
searcher	{}	An object which supports searching within a string.

Returns

number

slice()

slice: (start?, end?) => string

Returns a section of a string.

Parameters

Parameter	Type	Description
start?	number	The index to the beginning of the specified portion of stringObj.
end?	number	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Returns

string

small()

small: () => string

Returns a <small> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

split

split: (separator, limit?) => string[](splitter, limit?) => string[] & (separator, limit?) => string[](splitter, limit?) => string[] | (separator, limit?) => string[](splitter, limit?) => string[] | (separator, limit?) => string[](splitter, limit?) => string[]

Type declaration

(separator, limit?) => string[](splitter, limit?) => string[] & (separator, limit?) => string[](splitter, limit?) => string[]

(separator, limit?) => string[](splitter, limit?) => string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
separator	string | RegExp	A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
splitter	{}	An object that can split a string.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

(separator, limit?) => string[](splitter, limit?) => string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
separator	string | RegExp	A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

Split a string into substrings using the specified separator and return them as an array.

Parameters

Parameter	Type	Description
splitter	{}	An object that can split a string.
limit?	number	A value used to limit the number of elements returned in the array.

Returns

string[]

startsWith()

startsWith: (searchString, position?) => boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

Parameters

Parameter	Type
searchString	string
position?	number

Returns

boolean

strike()

strike: () => string

Returns a <strike> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

sub()

sub: () => string

Returns a <sub> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

substr()

substr: (from, length?) => string

Gets a substring beginning at the specified location and having the specified length.

Parameters

Parameter	Type	Description
from	number	The starting position of the desired substring. The index of the first character in the string is zero.
length?	number	The number of characters to include in the returned substring.

Returns

string

Deprecated

A legacy feature for browser compatibility

substring()

substring: (start, end?) => string

Returns the substring at the specified location within a String object.

Parameters

Parameter	Type	Description
start	number	The zero-based index number indicating the beginning of the substring.
end?	number	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

sup()

sup: () => string

Returns a <sup> HTML element

Returns

string

Deprecated

A legacy feature for browser compatibility

toLocaleLowerCase

toLocaleLowerCase: (locales?) => string(locales?) => string & (locales?) => string(locales?) => string | (locales?) => string(locales?) => string | (locales?) => string(locales?) => string

Type declaration

(locales?) => string(locales?) => string & (locales?) => string(locales?) => string

(locales?) => string(locales?) => string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

(locales?) => string(locales?) => string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

toLocaleString

toLocaleString: () => string | (locales?, options?) => string(locales?, options?) => string

Type declaration

() => string

Returns a date converted to a string using the current locale.

Returns

string

(locales?, options?) => string(locales?, options?) => string

Converts a number to a string by using the current or specified locale.

Parameters

Parameter	Type	Description
locales?	string | string[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.
options?	NumberFormatOptions	An object that contains one or more properties that specify comparison options.

Returns

string

Converts a number to a string by using the current or specified locale.

Parameters

Parameter	Type	Description
locales?	LocalesArgument	A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.
options?	NumberFormatOptions	An object that contains one or more properties that specify comparison options.

Returns

string

toLocaleUpperCase

toLocaleUpperCase: (locales?) => string(locales?) => string & (locales?) => string(locales?) => string | (locales?) => string(locales?) => string | (locales?) => string(locales?) => string

Type declaration

(locales?) => string(locales?) => string & (locales?) => string(locales?) => string

(locales?) => string(locales?) => string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

(locales?) => string(locales?) => string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	string | string[]

Returns

string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Parameters

Parameter	Type
locales?	LocalesArgument

Returns

string

toLowerCase()

toLowerCase: () => string

Converts all the alphabetic characters in a string to lowercase.

Returns

string

toString

toString: () => string | () => string & (radix?) => string | () => string & () => string

Type declaration

() => string

Returns a string representation of a string.

Returns

string

() => string & (radix?) => string

() => string & () => string

toUpperCase()

toUpperCase: () => string

Converts all the alphabetic characters in a string to uppercase.

Returns

string

toWellFormed()

toWellFormed: () => string

Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).

Returns

string

trim()

trim: () => string

Removes the leading and trailing white space and line terminator characters from a string.

Returns

string

trimEnd()

trimEnd: () => string

Removes the trailing white space and line terminator characters from a string.

Returns

string

trimLeft()

trimLeft: () => string

Removes the leading white space and line terminator characters from a string.

Returns

string

Deprecated

A legacy feature for browser compatibility. Use trimStart instead

trimRight()

trimRight: () => string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Deprecated

A legacy feature for browser compatibility. Use trimEnd instead

trimStart()

trimStart: () => string

Removes the leading white space and line terminator characters from a string.

Returns

string

valueOf

valueOf: () => string | () => string & () => number | () => string & () => symbol

Type declaration

() => string

Returns the primitive value of the specified object.

Returns

string

() => string & () => number

() => string & () => symbol

---

EventMap

EventMap: object

---

EventReceiver()<KeyMap>

EventReceiver<KeyMap>: (params) => void

Type Parameters

Type Parameter
KeyMap

Parameters

Parameter	Type
params	KeyMap

Returns

void

---

EventRequest

EventRequest: object

Type declaration

attendees?

optional attendees: EventAttendeeRequest[]

canvas_id?

optional canvas_id: string

description?

optional description: string

end_at

end_at: string

external_objects?

optional external_objects: EventExternalObjectRequest[]

id?

optional id: string

location?

optional location: string

metadata?

optional metadata: any

start_at

start_at: string

status?

optional status: EventStatusEnum

subject?

optional subject: string

---

ExternalLinkSelection

ExternalLinkSelection: object

Type declaration

content_type

content_type: "video" | "image"

from

from: "custom" | "pexels" | "unsplash" | "ai"

type

type: "external_link"

url

url: string

---

ExternalMultimediaAssetType

ExternalMultimediaAssetType: object

Type declaration

asset_type

asset_type: typeof MULTIMEDIA_IMG_TYPE.external

external_url

external_url: string

from?

optional from: "custom" | "pexels" | "unsplash" | "ai"

horizontal_alignment?

optional horizontal_alignment: MultimediaHorizontalAlignmentOptions

poster_background_size?

optional poster_background_size: BackgroundSize

poster_url?

optional poster_url: string

type

type: "image" | "video"

---

Favorite

Favorite: object

Type declaration

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file

readonly file: FavoriteFile | null

folder

readonly folder: FavoriteFolder | null

id

readonly id: string

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

readonly name: string

owned_by

readonly owned_by: MiniUser

page

readonly page: MiniPage | null

thumbnail_url

readonly thumbnail_url: string

---

FavoriteCreateRequest

FavoriteCreateRequest: object

Type declaration

file_id?

optional file_id: string

folder_id?

optional folder_id: string

id?

optional id: string

name?

optional name: string

page_index?

optional page_index: number

---

FavoriteFile

FavoriteFile: object

Type declaration

content_type

readonly content_type: string | null

expires_at?

optional expires_at: string | null

id

readonly id: string

name

name: string

tags

readonly tags: string[]

---

FavoriteFolder

FavoriteFolder: object

Mixin for common file access filtering logic.

Type declaration

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

id

readonly id: string

name

name: string

thumbnail_url

readonly thumbnail_url: string | null

---

FetchFileList()

FetchFileList: <T>(payload) => Promise<File[]>

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type
payload	T

Returns

Promise<File[]>

---

FetchMode

FetchMode: "postmessage" | "prefer-online"

---

File

File: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

app_metadata?

optional app_metadata: Record<string, any>

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type: DownloadTypeEnum

expires_at?

optional expires_at: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name?

optional name: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions: FilePermission

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

FileCreateRequest

FileCreateRequest: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

app_metadata?

optional app_metadata: Record<string, any>

content?

optional content: Blob

content_upload_id?

optional content_upload_id: string

download_type?

optional download_type: DownloadTypeEnum

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string

instance_id

instance_id: string

is_asset?

optional is_asset: boolean

Deprecated: Please use the 'type' field instead. This field is maintained for backward compatibility and may be removed in future releases.

metadata?

optional metadata: Record<string, any>

name?

optional name: string

owned_by_id?

optional owned_by_id: number | null

permissions?

optional permissions: FilePermissionRequest

tags?

optional tags: string[]

thumbnail?

optional thumbnail: Blob

thumbnail_upload_id?

optional thumbnail_upload_id: string

type?

optional type: FileTypeEnum

url?

optional url: string

---

FilePermission

FilePermission: object

Type declaration

can_download?

optional can_download: boolean

can_share?

optional can_share: boolean

---

FilePermissionRequest

FilePermissionRequest: object

Type declaration

can_download?

optional can_download: boolean

can_share?

optional can_share: boolean

---

FileRetrieve

FileRetrieve: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

app_metadata?

optional app_metadata: Record<string, any>

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_thumbnails

readonly content_thumbnails: string[]

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type: DownloadTypeEnum

expires_at?

optional expires_at: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name?

optional name: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions: FilePermission

pspdfkit_auth_payload

readonly pspdfkit_auth_payload: Record<string, any> | null

pspdfkit_document_id

readonly pspdfkit_document_id: string | null

pspdfkit_server_url

readonly pspdfkit_server_url: string | null

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

version

readonly version: FileVersion

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

FileRevision

FileRevision: object

Type declaration

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

id

readonly id: string

name

name: string

---

FileUpdateRequest

FileUpdateRequest: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

app_metadata?

optional app_metadata: Record<string, any>

content?

optional content: Blob

content_upload_id?

optional content_upload_id: string

download_type?

optional download_type: DownloadTypeEnum

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string

metadata?

optional metadata: Record<string, any>

name?

optional name: string

owned_by_id?

optional owned_by_id: number | null

permissions?

optional permissions: FilePermissionRequest

tags?

optional tags: string[]

thumbnail?

optional thumbnail: Blob

thumbnail_upload_id?

optional thumbnail_upload_id: string

url?

optional url: string

---

FileVersion

FileVersion: object

Type declaration

comment

readonly comment: string

created_at

readonly created_at: string

id

readonly id: string

---

Folder

Folder: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

content_type

readonly content_type: string

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

id

readonly id: string

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

path

path: string

rules?

optional rules: FolderRule[]

thumbnail_url

readonly thumbnail_url: string | null

---

FolderCanvas

FolderCanvas: object

Type declaration

created_by

readonly created_by: MiniUser

id

readonly id: string

modified_at

readonly modified_at: string

name

name: string

owned_by

readonly owned_by: MiniUser

tags

readonly tags: string[]

thumbnail_url?

optional thumbnail_url: string | null

---

FolderCreateRequest

FolderCreateRequest: object

Serializer class for creating folder records. Available fields for creating a folder:

• id
• name
• parent_folder_id
• instance_id

Type declaration

access_type?

optional access_type: AccessTypeEnum

id?

optional id: string

name

name: string

owned_by_id?

optional owned_by_id: number | null

parent_folder_id

parent_folder_id: string

rules?

optional rules: FolderRuleRequest[]

thumbnail_id?

optional thumbnail_id: string | null

---

FolderFile

FolderFile: object

Type declaration

content_type

readonly content_type: FileContentTypeEnum

created_by

readonly created_by: MiniUser

expires_at

readonly expires_at: string | null

id

readonly id: string

metadata

readonly metadata: Record<string, any>

modified_at

readonly modified_at: string

name

readonly name: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions: FilePermission

status

readonly status: FileStatusEnum

tags

readonly tags: string[]

thumbnail_url

readonly thumbnail_url: string

---

FolderFolder

FolderFolder: object

Mixin for common file access filtering logic.

Type declaration

available_files_count

readonly available_files_count: number

available_folders_count

readonly available_folders_count: number

canvas_thumbnail_urls

readonly canvas_thumbnail_urls: string[]

canvases_count

readonly canvases_count: number

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

files_count

readonly files_count: number

folders_count

readonly folders_count: number

id

readonly id: string

name

name: string

thumbnail_url

readonly thumbnail_url: string | null

---

FolderRetrieve

FolderRetrieve: object

Mixin for common file access filtering logic.

Type declaration

access_type?

optional access_type: AccessTypeEnum

canvases

readonly canvases: FolderCanvas[]

content_type

readonly content_type: string

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

files

readonly files: FolderFile[]

folders

readonly folders: FolderFolder[]

id

readonly id: string

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

path

readonly path: FolderFolder[]

rules?

optional rules: FolderRule[]

thumbnail_url

readonly thumbnail_url: string | null

---

FolderRule

FolderRule: object

Type declaration

field

field: string

operator

operator: OperatorEnum

value

value: string

---

FolderRuleRequest

FolderRuleRequest: object

Type declaration

field

field: string

operator

operator: OperatorEnum

value

value: string

---

FolderUpdateRequest

FolderUpdateRequest: object

Serializer class for updating folder records. Available fields to update:

• name
• access_type
• parent_folder_id

Type declaration

access_type?

optional access_type: AccessTypeEnum

name

name: string

owned_by_id?

optional owned_by_id: number | null

parent_folder_id?

optional parent_folder_id: string

rules?

optional rules: FolderRuleRequest[]

thumbnail_id?

optional thumbnail_id: string | null

---

Instance

Instance: object

Type declaration

color?

optional color: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

environment

readonly environment: MiniEnvironment

id

readonly id: string

last_login

readonly last_login: string

logo?

optional logo: string | null

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

region

readonly region: MiniRegion

role

readonly role: InstanceMembershipRoleEnum

settings?

optional settings: Record<string, any>

storage_region

readonly storage_region: StorageRegionEnum

---

InstanceSettings

InstanceSettings: object

Type declaration

allow_revoke_shared_link?

optional allow_revoke_shared_link: undefined | boolean

alternative_canvas_fullscreen?

optional alternative_canvas_fullscreen: undefined | boolean

api_client_timeout?

optional api_client_timeout: undefined | number

assets_route_order?

optional assets_route_order: undefined | number

auto_assignment_rules?

optional auto_assignment_rules: undefined | object[]

business_logic_ids_to_section_ids_resolver?

optional business_logic_ids_to_section_ids_resolver: undefined | string

canvas?

optional canvas: undefined | object & object

canvases_route_order?

optional canvases_route_order: undefined | number

content_browser_route_order?

optional content_browser_route_order: undefined | number

default_pdf_page_dimensions?

optional default_pdf_page_dimensions: undefined | { height: number; printScale: number; width: number; }

disable_browser_search_context?

optional disable_browser_search_context: undefined | boolean

disable_core_canvas_metadata?

optional disable_core_canvas_metadata: undefined | boolean

disable_postcall?

optional disable_postcall: undefined | boolean

display_metadata_filters_in_modal?

optional display_metadata_filters_in_modal: undefined | boolean

enable_admin_asset_manager?

optional enable_admin_asset_manager: undefined | boolean

enable_content_rating_in_call?

optional enable_content_rating_in_call: undefined | boolean

enable_crm_privacy_mode?

optional enable_crm_privacy_mode: undefined | boolean

enable_download_original_file_in_impact?

optional enable_download_original_file_in_impact: undefined | boolean

enable_favorites?

optional enable_favorites: undefined | boolean

enable_folder_description_via_name?

optional enable_folder_description_via_name: undefined | boolean

enable_indicators?

optional enable_indicators: undefined | boolean

enable_js_api_recommended_files?

optional enable_js_api_recommended_files: undefined | boolean

enable_metadata_info_in_list_item?

optional enable_metadata_info_in_list_item: undefined | boolean

enable_monaco_html_editor?

optional enable_monaco_html_editor: undefined | boolean

enable_multi_language?

optional enable_multi_language: undefined | boolean

enable_multipeer_connectivity?

optional enable_multipeer_connectivity: undefined | boolean

enable_ppt_converter_in_canvas_templates?

optional enable_ppt_converter_in_canvas_templates: undefined | boolean

enable_presentation_annotations?

optional enable_presentation_annotations: undefined | boolean

enable_quick_filters_for_search_metadata_filters?

optional enable_quick_filters_for_search_metadata_filters: undefined | boolean

enable_recents?

optional enable_recents: undefined | boolean

enable_search_filter_with_suggestions?

optional enable_search_filter_with_suggestions: undefined | boolean

enable_search_with_suggestions?

optional enable_search_with_suggestions: undefined | boolean

enable_slotty_ui_asset_manager?

optional enable_slotty_ui_asset_manager: undefined | boolean

enable_speaker_notes?

optional enable_speaker_notes: undefined | boolean

enable_syncbox?

optional enable_syncbox: undefined | boolean

enable_thumbnails_for_templates_and_blocks?

optional enable_thumbnails_for_templates_and_blocks: undefined | boolean

file_annotations_mode?

optional file_annotations_mode: undefined | "admin" | "personal"

full_text_search_config?

optional full_text_search_config: undefined | string

generate_only_sections_in_ppt_converter?

optional generate_only_sections_in_ppt_converter: undefined | boolean

impact_show_only_saved_canvases_in_canvas_manager?

optional impact_show_only_saved_canvases_in_canvas_manager: undefined | boolean

include_canvas_content_in_full_text_search?

optional include_canvas_content_in_full_text_search: undefined | boolean

include_canvas_metadata_in_full_text_search?

optional include_canvas_metadata_in_full_text_search: undefined | boolean

include_file_content_in_full_text_search?

optional include_file_content_in_full_text_search: undefined | boolean

include_file_metadata_in_full_text_search?

optional include_file_metadata_in_full_text_search: undefined | boolean

ios?

optional ios: undefined | OrganizationSettings & object

is_meeting_bar_account_selection_disabled?

optional is_meeting_bar_account_selection_disabled: undefined | boolean

launch_in_present_mode_on_creation?

optional launch_in_present_mode_on_creation: undefined | boolean

location_prompt_message?

optional location_prompt_message: undefined | string

location_prompt_type?

optional location_prompt_type: undefined | "warning" | "block"

max_files_limit?

optional max_files_limit: undefined | number

metadata_highlight_properties?

optional metadata_highlight_properties: undefined | MetadataHighlightProperty[]

minimum_event_duration_in_call?

optional minimum_event_duration_in_call: undefined | number

pipe_multi_search_separator?

optional pipe_multi_search_separator: undefined | string

section_thumbnail_url_transformer?

optional section_thumbnail_url_transformer: undefined | string

skip_metadata_keys_in_list_item?

optional skip_metadata_keys_in_list_item: undefined | string[]

smart_folder_rule_attributes?

optional smart_folder_rule_attributes: undefined | SmartFolderRuleAttributes

translation_overrides?

optional translation_overrides: undefined | TranslationOverrides

use_collection_player_as_default_file_viewer?

optional use_collection_player_as_default_file_viewer: undefined | boolean

use_collection_player_as_default_file_viewer_for_content_extensions?

optional use_collection_player_as_default_file_viewer_for_content_extensions: undefined | string[]

use_collection_player_as_default_file_viewer_for_original_extensions?

optional use_collection_player_as_default_file_viewer_for_original_extensions: undefined | string[]

use_collection_player_with_annotations?

optional use_collection_player_with_annotations: undefined | boolean

---

Language

Language: [string, string]

---

LaunchDarklyBooleanFlagKey

LaunchDarklyBooleanFlagKey: "ai_code_generation_model" | "ai_text_generation_model" | "ai_image_generation_model" | "ai_video_generation_model" | "allow_ai_prompts_in_canvas_text" | "allow_bulk_actions_canvases_files" | "allow_content_grid_autofill" | "allow_canvas_duplication" | "allow_canvases_tables_columns_settings" | "allow_creating_canvas_with_no_template" | "allow_dynamic_data_table_for_scribble_component" | "allow_html_for_scribble_component" | "allow_embeddable_for_scribble_component" | "allow_embeddable_hiding" | "allow_multimedia_for_scribble_component" | "allow_note_taking" | "allow_rep_canvas_metadata_edit" | "allow_rep_file_rating" | "allow_rep_file_upload" | "allow_saving_annotations_in_personal_layer" | "allow_user_to_edit_font_size_and_color_in_canvas_tokens" | "are_sections_system_controlled" | "enable_canvas_core_distributions" | "enable_file_core_distributions" | "copy_context_to_canvas" | "copy_template_metadata_to_canvas" | "disable_canvas_edit_for_reps" | "disable_custom_tooltips" | "disable_file_edit_content" | "disable_fullscreen_canvas_builder" | "disable_impact_web_browser_fullscreen" | "display_section_list_name" | "disable_download_canvas" | "enable_ai_generated_thumbnails" | "enable_analytics" | "enable_app_developer_role" | "enable_algolia_search" | "enable_background_image_theme_options" | "enable_better_canvas_builder_control_bars_on_zoom" | "enable_bulk_update_file_attributes" | "enable_canvas_as_home" | "enable_canvas_blocks" | "enable_canvas_node_debugging" | "enable_canvas_locks" | "enable_canvas_template_edit_in_impact" | "enable_canvas_tokens" | "enable_client_only_canvas_context" | "enable_collaborations" | "enable_collection_player_data_accessor" | "enable_content_grid_data_accessor" | "enable_content_type_change_in_content_selector" | "enable_cross_tab_instance_reload_for_ld_sync" | "enable_create_section_from_section_template" | "enable_custom_display_overrides" | "enable_default_crm_shape" | "enable_detailed_date_format" | "enable_dsr_readonly_annotations" | "enable_dynamic_data_table_component" | "enable_embedded_video_autoplay" | "enable_embedded_video" | "enable_enhanced_canvas_drawer_app" | "enable_enhanced_indicators" | "enable_enhanced_section_execution_states" | "enable_experimental_canvas_builder_dnd" | "enable_extra_file_data" | "enable_file_pages_metadata" | "enable_file_revisions" | "enable_folder_details_edit" | "enable_handlebar_template_support" | "enable_height_in_component_theming" | "enable_hotspot_visibility" | "enable_improved_canvas_node_updating" | "enable_insearch_in_section_selector" | "enable_instance_cloner" | "enable_advanced_cloner" | "enable_instance_editor_role" | "enable_instance_navigation_from_management" | "enable_knock_notifications" | "enable_maintain_section_theme_control" | "enable_metadata_in_file_uploads_with_default_values" | "enable_more_intuitive_component_spacing" | "enable_multimedia_component_ai_images" | "enable_new_meeting_bar" | "enable_original_pdf_link" | "enable_scale_content" | "enable_sorting_in_tiptap_table" | "enable_theme_assets" | "enable_toc_enhancements_to_support_same_section_in_section_list" | "enable_pia_assistant" | "enable_pipe_character_multi_search" | "enable_popup_apps" | "enable_reorder_search" | "enable_reorder_scribble_isolation" | "enable_reorder_component_options_menu" | "enable_resizable_multimedia_component" | "enable_responsive_scribble_component" | "enable_saved_canvases_filters" | "enable_short_tag_column_in_tables" | "enable_scribble_component" | "enable_scribble_content_as_background" | "enable_search_and_filters_in_multimedia_component" | "enable_section_context_in_dsr" | "enable_selectors_dnd" | "enable_section_selector_edit_section" | "enable_smart_folders" | "enable_smart_folders_for_sections" | "enable_smart_folders_in_section_selector" | "enable_smart_folders_in_files" | "enable_sorting_in_sections" | "enable_suggested_tags" | "enable_template_folders" | "enable_theme_options_border_radius" | "enable_themes" | "hide_asset_uploader" | "include_files_content_in_print" | "interpolate_rep_canvases_on_edit_mode" | "is_fe_sentry_enabled" | "is_timeline_component_allowed" | "launch_in_full_screen_on_present_mode" | "prefer_online_handlers" | "show_asset_manager_for_multimedia" | "show_clear_all_annotations_button" | "show_content_selector_list_view" | "show_metadata_filters_in_all_canvas_things" | "show_only_preview_mode_for_html_component" | "show_popularity_icons" | "use_core_endpoint_for_analytics" | "convert_pptx_to_section_with_scribble_pdfjs" | "use_short_url_for_shared_link" | "use_zoho_instead_of_ms_wopi" | "enable_new_section_list" | "enable_sharebox_apps" | "enable_back_to_previous_location_in_canvas" | "enable_crm_shape_for_external_links" | "enable_adaptive_popup_apps" | "enable_file_version_polling" | "skip_pspdfkit_wait_for_high_res_thumbs" | "enable_reactive_scribble_component_toolbar" | "enable_embeddable_full_screen_mode" | "enable_enhanced_user_management" | "keep_static_pptx_editable"

---

LaunchDarklyEnv

LaunchDarklyEnv: object

Type declaration

ai_code_generation_model

ai_code_generation_model: undefined | boolean

ai_image_generation_model

ai_image_generation_model: undefined

ai_text_generation_model

ai_text_generation_model: undefined

ai_video_generation_model

ai_video_generation_model: undefined

allow_ai_prompts_in_canvas_text

allow_ai_prompts_in_canvas_text: undefined | boolean

allow_bulk_actions_canvases_files

allow_bulk_actions_canvases_files: undefined | boolean

allow_canvas_duplication

allow_canvas_duplication: undefined | boolean

allow_canvases_tables_columns_settings

allow_canvases_tables_columns_settings: undefined | boolean

allow_content_grid_autofill

allow_content_grid_autofill: undefined | boolean

allow_creating_canvas_with_no_template

allow_creating_canvas_with_no_template: undefined | boolean

allow_dynamic_data_table_for_scribble_component

allow_dynamic_data_table_for_scribble_component: undefined | boolean

allow_embeddable_for_scribble_component

allow_embeddable_for_scribble_component: undefined | boolean

allow_embeddable_hiding

allow_embeddable_hiding: undefined | boolean

allow_html_for_scribble_component

allow_html_for_scribble_component: undefined | boolean

allow_multimedia_for_scribble_component

allow_multimedia_for_scribble_component: undefined | boolean

allow_note_taking

allow_note_taking: undefined | boolean

allow_rep_canvas_metadata_edit

allow_rep_canvas_metadata_edit: undefined | boolean

allow_rep_file_rating

allow_rep_file_rating: undefined | boolean

allow_rep_file_upload

allow_rep_file_upload: undefined | boolean

allow_saving_annotations_in_personal_layer

allow_saving_annotations_in_personal_layer: undefined | boolean

allow_user_to_edit_font_size_and_color_in_canvas_tokens

allow_user_to_edit_font_size_and_color_in_canvas_tokens: undefined | boolean

are_sections_system_controlled

are_sections_system_controlled: undefined | boolean

batch_open_content_grid_ar_files

batch_open_content_grid_ar_files: undefined | "off" | "simultaneous" | "swap"

canvas_component_grouping

canvas_component_grouping: undefined | "page" | "page_break" | "none"

canvas_manager_table_columns

canvas_manager_table_columns: undefined | CanvasManagerTableColumns

canvas_section_selector_page_size

canvas_section_selector_page_size: undefined | number

canvas_section_selector_selected_items_with_thumbnail_size

canvas_section_selector_selected_items_with_thumbnail_size: undefined | number

context_crm_shape

context_crm_shape: undefined | Record<string, any>

convert_pptx_to_section_with_scribble_pdfjs

convert_pptx_to_section_with_scribble_pdfjs: undefined | boolean

copy_context_to_canvas

copy_context_to_canvas: undefined | boolean

copy_template_metadata_to_canvas

copy_template_metadata_to_canvas: undefined | boolean

disable_canvas_edit_for_reps

disable_canvas_edit_for_reps: undefined | boolean

disable_custom_tooltips

disable_custom_tooltips: undefined | boolean

disable_download_canvas

disable_download_canvas: undefined | boolean

disable_file_edit_content

disable_file_edit_content: undefined | boolean

disable_fullscreen_canvas_builder

disable_fullscreen_canvas_builder: undefined | boolean

disable_impact_web_browser_fullscreen

disable_impact_web_browser_fullscreen: undefined | boolean

display_section_list_name

display_section_list_name: undefined | boolean

dsr_remote_script_url

dsr_remote_script_url: undefined | "" | "https://anyvalidurl.xyz"

enable_adaptive_popup_apps

enable_adaptive_popup_apps: undefined | boolean

enable_advanced_cloner

enable_advanced_cloner: undefined | boolean

enable_ai_generated_thumbnails

enable_ai_generated_thumbnails: undefined | boolean

enable_algolia_search

enable_algolia_search: undefined | boolean

enable_analytics

enable_analytics: undefined | boolean

enable_app_developer_role

enable_app_developer_role: undefined | boolean

enable_back_to_previous_location_in_canvas

enable_back_to_previous_location_in_canvas: undefined | boolean

enable_background_image_theme_options

enable_background_image_theme_options: undefined | boolean

enable_better_canvas_builder_control_bars_on_zoom

enable_better_canvas_builder_control_bars_on_zoom: undefined | boolean

enable_bulk_update_file_attributes

enable_bulk_update_file_attributes: undefined | boolean

enable_canvas_as_home

enable_canvas_as_home: undefined | boolean

enable_canvas_blocks

enable_canvas_blocks: undefined | boolean

enable_canvas_core_distributions

enable_canvas_core_distributions: undefined | boolean

enable_canvas_locks

enable_canvas_locks: undefined | boolean

enable_canvas_node_debugging

enable_canvas_node_debugging: undefined | boolean

enable_canvas_template_edit_in_impact

enable_canvas_template_edit_in_impact: undefined | boolean

enable_canvas_tokens

enable_canvas_tokens: undefined | boolean

enable_client_only_canvas_context

enable_client_only_canvas_context: undefined | boolean

enable_collaborations

enable_collaborations: undefined | boolean

enable_collection_player_data_accessor

enable_collection_player_data_accessor: undefined | boolean

enable_content_grid_data_accessor

enable_content_grid_data_accessor: undefined | boolean

enable_content_type_change_in_content_selector

enable_content_type_change_in_content_selector: undefined | boolean

enable_create_section_from_section_template

enable_create_section_from_section_template: undefined | boolean

enable_crm_shape_for_external_links

enable_crm_shape_for_external_links: undefined | boolean

enable_cross_tab_instance_reload_for_ld_sync

enable_cross_tab_instance_reload_for_ld_sync: undefined | boolean

enable_custom_display_overrides

enable_custom_display_overrides: undefined | boolean

enable_default_crm_shape

enable_default_crm_shape: undefined | boolean

enable_detailed_date_format

enable_detailed_date_format: undefined | boolean

enable_dsr_readonly_annotations

enable_dsr_readonly_annotations: undefined | boolean

enable_dynamic_data_table_component

enable_dynamic_data_table_component: undefined | boolean

enable_embeddable_full_screen_mode

enable_embeddable_full_screen_mode: undefined | boolean

enable_embedded_video

enable_embedded_video: undefined | boolean

enable_embedded_video_autoplay

enable_embedded_video_autoplay: undefined | boolean

enable_enhanced_canvas_drawer_app

enable_enhanced_canvas_drawer_app: undefined | boolean

enable_enhanced_indicators

enable_enhanced_indicators: undefined | boolean

enable_enhanced_section_execution_states

enable_enhanced_section_execution_states: undefined | boolean

enable_enhanced_user_management

enable_enhanced_user_management: undefined | boolean

enable_experimental_canvas_builder_dnd

enable_experimental_canvas_builder_dnd: undefined | boolean

enable_extra_file_data

enable_extra_file_data: undefined | boolean

enable_file_core_distributions

enable_file_core_distributions: undefined | boolean

enable_file_pages_metadata

enable_file_pages_metadata: undefined | boolean

enable_file_revisions

enable_file_revisions: undefined | boolean

enable_file_version_polling

enable_file_version_polling: undefined | boolean

enable_folder_details_edit

enable_folder_details_edit: undefined | boolean

enable_handlebar_template_support

enable_handlebar_template_support: undefined | boolean

enable_height_in_component_theming

enable_height_in_component_theming: undefined | boolean

enable_hotspot_visibility

enable_hotspot_visibility: undefined | boolean

enable_improved_canvas_node_updating

enable_improved_canvas_node_updating: undefined | boolean

enable_insearch_in_section_selector

enable_insearch_in_section_selector: undefined | boolean

enable_instance_cloner

enable_instance_cloner: undefined | boolean

enable_instance_editor_role

enable_instance_editor_role: undefined | boolean

enable_instance_navigation_from_management

enable_instance_navigation_from_management: undefined | boolean

enable_knock_notifications

enable_knock_notifications: undefined | boolean

enable_maintain_section_theme_control

enable_maintain_section_theme_control: undefined | boolean

enable_metadata_in_file_uploads_with_default_values

enable_metadata_in_file_uploads_with_default_values: undefined | boolean

enable_more_intuitive_component_spacing

enable_more_intuitive_component_spacing: undefined | boolean

enable_multimedia_component_ai_images

enable_multimedia_component_ai_images: undefined | boolean

enable_new_meeting_bar

enable_new_meeting_bar: undefined | boolean

enable_new_section_list

enable_new_section_list: undefined | boolean

enable_original_pdf_link

enable_original_pdf_link: undefined | boolean

enable_pia_assistant

enable_pia_assistant: undefined | boolean

enable_pipe_character_multi_search

enable_pipe_character_multi_search: undefined | boolean

enable_popup_apps

enable_popup_apps: undefined | boolean

enable_reactive_scribble_component_toolbar

enable_reactive_scribble_component_toolbar: undefined | boolean

enable_reorder_component_options_menu

enable_reorder_component_options_menu: undefined | boolean

enable_reorder_scribble_isolation

enable_reorder_scribble_isolation: undefined | boolean

enable_reorder_search

enable_reorder_search: undefined | boolean

enable_resizable_multimedia_component

enable_resizable_multimedia_component: undefined | boolean

enable_responsive_scribble_component

enable_responsive_scribble_component: undefined | boolean

enable_saved_canvases_filters

enable_saved_canvases_filters: undefined | boolean

enable_scale_content

enable_scale_content: undefined | boolean

enable_scribble_component

enable_scribble_component: undefined | boolean

enable_scribble_content_as_background

enable_scribble_content_as_background: undefined | boolean

enable_search_and_filters_in_multimedia_component

enable_search_and_filters_in_multimedia_component: undefined | boolean

enable_section_context_in_dsr

enable_section_context_in_dsr: undefined | boolean

enable_section_selector_edit_section

enable_section_selector_edit_section: undefined | boolean

enable_selectors_dnd

enable_selectors_dnd: undefined | boolean

enable_sharebox_apps

enable_sharebox_apps: undefined | boolean

enable_short_tag_column_in_tables

enable_short_tag_column_in_tables: undefined | boolean

enable_smart_folders

enable_smart_folders: undefined | boolean

enable_smart_folders_for_sections

enable_smart_folders_for_sections: undefined | boolean

enable_smart_folders_in_files

enable_smart_folders_in_files: undefined | boolean

enable_smart_folders_in_section_selector

enable_smart_folders_in_section_selector: undefined | boolean

enable_sorting_in_sections

enable_sorting_in_sections: undefined | boolean

enable_sorting_in_tiptap_table

enable_sorting_in_tiptap_table: undefined | boolean

enable_suggested_tags

enable_suggested_tags: undefined | boolean

enable_template_folders

enable_template_folders: undefined | boolean

enable_theme_assets

enable_theme_assets: undefined | boolean

enable_theme_options_border_radius

enable_theme_options_border_radius: undefined | boolean

enable_themes

enable_themes: undefined | boolean

enable_toc_enhancements_to_support_same_section_in_section_list

enable_toc_enhancements_to_support_same_section_in_section_list: undefined | boolean

hide_asset_uploader

hide_asset_uploader: undefined | boolean

include_files_content_in_print

include_files_content_in_print: undefined | boolean

interpolate_rep_canvases_on_edit_mode

interpolate_rep_canvases_on_edit_mode: undefined | boolean

is_fe_sentry_enabled

is_fe_sentry_enabled: undefined | boolean

is_timeline_component_allowed

is_timeline_component_allowed: undefined | boolean

keep_static_pptx_editable

keep_static_pptx_editable: undefined | boolean

launch_in_full_screen_on_present_mode

launch_in_full_screen_on_present_mode: undefined | boolean

prefer_online_handlers

prefer_online_handlers: undefined | boolean

pspdfkit_client_version

pspdfkit_client_version: undefined | "2024.6.0" | "2024.7.0"

selectors_dnd_batch_add_style

selectors_dnd_batch_add_style: undefined | "button" | "buttons" | "dropdown"

show_asset_manager_for_multimedia

show_asset_manager_for_multimedia: undefined | boolean

show_clear_all_annotations_button

show_clear_all_annotations_button: undefined | boolean

show_content_selector_list_view

show_content_selector_list_view: undefined | boolean

show_metadata_filters_in_all_canvas_things

show_metadata_filters_in_all_canvas_things: undefined | boolean

show_only_preview_mode_for_html_component

show_only_preview_mode_for_html_component: undefined | boolean

show_popularity_icons

show_popularity_icons: undefined | boolean

skip_pspdfkit_wait_for_high_res_thumbs

skip_pspdfkit_wait_for_high_res_thumbs: undefined | boolean

slotty_ui_remote_script_url

slotty_ui_remote_script_url: undefined | "" | "https://anyvalidurl.xyz"

use_core_endpoint_for_analytics

use_core_endpoint_for_analytics: undefined | boolean

use_short_url_for_shared_link

use_short_url_for_shared_link: undefined | boolean

use_zoho_instead_of_ms_wopi

use_zoho_instead_of_ms_wopi: undefined | boolean

---

LaunchDarklyNumberFlagKey

LaunchDarklyNumberFlagKey: "canvas_section_selector_page_size" | "canvas_section_selector_selected_items_with_thumbnail_size"

---

LaunchDarklyObjectFlags

LaunchDarklyObjectFlags: object

Type declaration

canvas_manager_table_columns

canvas_manager_table_columns: CanvasManagerTableColumns

context_crm_shape

context_crm_shape: Record<string, any>

---

LaunchDarklyStringFlagKey

LaunchDarklyStringFlagKey: keyof typeof LaunchDarklyStringFlags

---

LaunchDarklyStringFlagValue<K>

LaunchDarklyStringFlagValue<K>: K extends LaunchDarklyStringFlagKey ? typeof LaunchDarklyStringFlags[K][number] : never

Type Parameters

Type Parameter	Default type
K extends LaunchDarklyStringFlagKey	LaunchDarklyStringFlagKey

---

MetadataHighlightProperty

MetadataHighlightProperty: object

Type declaration

background_color?

optional background_color: string

color?

optional color: string

icon?

optional icon: string

key

key: string

match_value

match_value: string | string[] | number | boolean

text

text: string

---

MetadataTemplate

MetadataTemplate: object

Type declaration

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file

readonly file: MiniFile

id

readonly id: string

instance

readonly instance: MiniInstance

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

owned_by

readonly owned_by: MiniUser

sections?

optional sections: MetadataTemplateSection[]

---

MetadataTemplateField

MetadataTemplateField: object

Type declaration

default?

optional default: string | boolean | number | null

help_text?

optional help_text: string

is_filterable?

optional is_filterable: boolean

is_pitch_master?

optional is_pitch_master: boolean

is_required?

optional is_required: boolean

is_sortable?

optional is_sortable: boolean

label

label: string

name

name: string

options?

optional options: MetadataTemplateOption[]

type

type: MetadataTemplateFieldTypeEnum

---

MetadataTemplateOption

MetadataTemplateOption: object

Type declaration

label

label: string

value

value: string

---

MetadataTemplateSection

MetadataTemplateSection: object

Type declaration

are_fields_dependent?

optional are_fields_dependent: boolean

fields

fields: MetadataTemplateField[]

label

label: string

---

MiniCanvas

MiniCanvas: object

Type declaration

id

readonly id: string

name

name: string

---

MiniEnvironment

MiniEnvironment: object

Type declaration

color?

optional color: string | null

id

readonly id: number

name

name: string

---

MiniEvent

MiniEvent: object

Type declaration

id

readonly id: string

start_at

start_at: string

subject

subject: string

---

MiniFile

MiniFile: object

Type declaration

id

readonly id: string

name

name: string

---

MiniFolder

MiniFolder: object

Type declaration

id

readonly id: string

name

name: string

---

MiniInstance

MiniInstance: object

Type declaration

id

readonly id: string

name

name: string

---

MiniPage

MiniPage: object

Type declaration

id

readonly id: string

page_index?

optional page_index: number

---

MiniRegion

MiniRegion: object

Type declaration

id

readonly id: number

name

name: string

---

MiniSharedLink

MiniSharedLink: object

Type declaration

short_url?

optional short_url: string | null

url

readonly url: string

---

MiniUser

MiniUser: object

Type declaration

email?

optional email: string

id

readonly id: number

name

readonly name: string

---

MultimediaProps

MultimediaProps: ExternalMultimediaAssetType | PitcherMultimediaAssetType

---

Mutable<T>

Mutable<T>: object

Type Parameters

Type Parameter
T

---

Organization

Organization: object

Type declaration

branding

readonly branding: OrganizationBranding

display_name

readonly display_name: string

id

readonly id: string

metadata

readonly metadata: Record<string, any>

name

readonly name: string

settings

readonly settings: Record<string, any>

---

OrganizationBranding

OrganizationBranding: object

Type declaration

colors?

optional colors: OrganizationBrandingColors | null

logo_url?

optional logo_url: string

---

OrganizationBrandingColors

OrganizationBrandingColors: object

Type declaration

page_background?

optional page_background: string

primary?

optional primary: string

---

OrganizationSettings

OrganizationSettings: object

Type declaration

allow_revoke_shared_link?

optional allow_revoke_shared_link: boolean

alternative_canvas_fullscreen?

optional alternative_canvas_fullscreen: boolean

api_client_timeout?

optional api_client_timeout: number

assets_route_order?

optional assets_route_order: number

auto_assignment_rules?

optional auto_assignment_rules: object[]

business_logic_ids_to_section_ids_resolver?

optional business_logic_ids_to_section_ids_resolver: string

canvas?

optional canvas: object

canvas.enable_read_only_canvas_creation_account?

optional enable_read_only_canvas_creation_account: boolean

canvas.enable_wizard_preview_button?

optional enable_wizard_preview_button: boolean

canvas.locks_polling_interval?

optional locks_polling_interval: number

canvas.scribble_file_renderer?

optional scribble_file_renderer: "image" | "pdfjs" | "pspdfkit"

canvas.shared_link?

optional shared_link: object

canvas.shared_link.disable_rep_changing_allow_download?

optional disable_rep_changing_allow_download: boolean

canvas.shared_link.email_disclaimer?

optional email_disclaimer: string

canvas.shared_link.initial_allow_download?

optional initial_allow_download: boolean

canvas.shared_link.logo_style?

optional logo_style: Record<string, any>

canvas.shared_link.logo_url?

optional logo_url: string

canvas.shared_link.title?

optional title: string

canvas.shared_link.valid_until_options?

optional valid_until_options: object[]

canvases_route_order?

optional canvases_route_order: number

content_browser_route_order?

optional content_browser_route_order: number

default_pdf_page_dimensions?

optional default_pdf_page_dimensions: object

default_pdf_page_dimensions.height?

optional height: number

default_pdf_page_dimensions.printScale?

optional printScale: number

default_pdf_page_dimensions.width?

optional width: number

disable_browser_search_context?

optional disable_browser_search_context: boolean

disable_core_canvas_metadata?

optional disable_core_canvas_metadata: boolean

disable_postcall?

optional disable_postcall: boolean

display_metadata_filters_in_modal?

optional display_metadata_filters_in_modal: boolean

enable_admin_asset_manager?

optional enable_admin_asset_manager: boolean

enable_content_rating_in_call?

optional enable_content_rating_in_call: boolean

enable_crm_privacy_mode?

optional enable_crm_privacy_mode: boolean

enable_download_original_file_in_impact?

optional enable_download_original_file_in_impact: boolean

enable_folder_description_via_name?

optional enable_folder_description_via_name: boolean

enable_indicators?

optional enable_indicators: boolean

enable_js_api_recommended_files?

optional enable_js_api_recommended_files: boolean

enable_metadata_info_in_list_item?

optional enable_metadata_info_in_list_item: boolean

enable_monaco_html_editor?

optional enable_monaco_html_editor: boolean

enable_multi_language?

optional enable_multi_language: boolean

enable_multipeer_connectivity?

optional enable_multipeer_connectivity: boolean

enable_ppt_converter_in_canvas_templates?

optional enable_ppt_converter_in_canvas_templates: boolean

enable_presentation_annotations?

optional enable_presentation_annotations: boolean

enable_quick_filters_for_search_metadata_filters?

optional enable_quick_filters_for_search_metadata_filters: boolean

enable_search_filter_with_suggestions?

optional enable_search_filter_with_suggestions: boolean

enable_search_with_suggestions?

optional enable_search_with_suggestions: boolean

enable_slotty_ui_asset_manager?

optional enable_slotty_ui_asset_manager: boolean

enable_speaker_notes?

optional enable_speaker_notes: boolean

enable_syncbox?

optional enable_syncbox: boolean

enable_thumbnails_for_templates_and_blocks?

optional enable_thumbnails_for_templates_and_blocks: boolean

file_annotations_mode?

optional file_annotations_mode: "admin" | "personal"

full_text_search_config?

optional full_text_search_config: string

generate_only_sections_in_ppt_converter?

optional generate_only_sections_in_ppt_converter: boolean

impact_show_only_saved_canvases_in_canvas_manager?

optional impact_show_only_saved_canvases_in_canvas_manager: boolean

include_canvas_content_in_full_text_search?

optional include_canvas_content_in_full_text_search: boolean

include_canvas_metadata_in_full_text_search?

optional include_canvas_metadata_in_full_text_search: boolean

include_file_content_in_full_text_search?

optional include_file_content_in_full_text_search: boolean

include_file_metadata_in_full_text_search?

optional include_file_metadata_in_full_text_search: boolean

ios?

optional ios: OrganizationSettings

is_meeting_bar_account_selection_disabled?

optional is_meeting_bar_account_selection_disabled: boolean

launch_in_present_mode_on_creation?

optional launch_in_present_mode_on_creation: boolean

location_prompt_message?

optional location_prompt_message: string

location_prompt_type?

optional location_prompt_type: "warning" | "block"

max_files_limit?

optional max_files_limit: number

metadata_highlight_properties?

optional metadata_highlight_properties: MetadataHighlightProperty[]

minimum_event_duration_in_call?

optional minimum_event_duration_in_call: number

pipe_multi_search_separator?

optional pipe_multi_search_separator: string

section_thumbnail_url_transformer?

optional section_thumbnail_url_transformer: string

skip_metadata_keys_in_list_item?

optional skip_metadata_keys_in_list_item: string[]

smart_folder_rule_attributes?

optional smart_folder_rule_attributes: SmartFolderRuleAttributes

translation_overrides?

optional translation_overrides: TranslationOverrides

use_collection_player_as_default_file_viewer?

optional use_collection_player_as_default_file_viewer: boolean

use_collection_player_as_default_file_viewer_for_content_extensions?

optional use_collection_player_as_default_file_viewer_for_content_extensions: string[]

use_collection_player_as_default_file_viewer_for_original_extensions?

optional use_collection_player_as_default_file_viewer_for_original_extensions: string[]

use_collection_player_with_annotations?

optional use_collection_player_with_annotations: boolean

---

PaginatedData<Data>

PaginatedData<Data>: object

Type Parameters

Type Parameter
Data

Type declaration

count

count: number

next

next: string | null

previous

previous: string | null

results

results: Data[]

---

PaginatedFavoriteList

PaginatedFavoriteList: object

Type declaration

count?

optional count: number

next?

optional next: string | null

previous?

optional previous: string | null

results?

optional results: Favorite[]

---

PaginatedFileList

PaginatedFileList: object

Type declaration

count?

optional count: number

next?

optional next: string | null

previous?

optional previous: string | null

results?

optional results: File[]

---

PaginatedFolderList

PaginatedFolderList: object

Type declaration

count?

optional count: number

next?

optional next: string | null

previous?

optional previous: string | null

results?

optional results: Folder[]

---

PaginatedMetadataTemplateList

PaginatedMetadataTemplateList: object

Type declaration

count?

optional count: number

next?

optional next: string | null

previous?

optional previous: string | null

results?

optional results: MetadataTemplate[]

---

PatchedCanvasUpdateRequest

PatchedCanvasUpdateRequest: object

Type declaration

access_type?

optional access_type: AccessTypeEnum

account?

optional account: AccountRequest | null

content?

optional content: Record<string, any>

context?

optional context: any

expires_at?

optional expires_at: string | null

folder_id?

optional folder_id: string | null

indicators?

optional indicators: Record<string, any> | null

instance_id?

optional instance_id: string

is_block?

optional is_block: boolean

is_default?

optional is_default: boolean

is_draft?

optional is_draft: boolean

is_editable?

optional is_editable: boolean

is_section?

optional is_section: boolean

is_template?

optional is_template: boolean

metadata?

optional metadata: any

name?

optional name: string

owned_by_id?

optional owned_by_id: number | null

start_at?

optional start_at: string | null

tags?

optional tags: string[]

theme?

optional theme: Record<string, any> | null

thumbnail_url?

optional thumbnail_url: string | null

---

PatchedEventRequest

PatchedEventRequest: object

Type declaration

attendees?

optional attendees: EventAttendeeRequest[]

canvas_id?

optional canvas_id: string

description?

optional description: string

end_at?

optional end_at: string

external_objects?

optional external_objects: EventExternalObjectRequest[]

id?

optional id: string

location?

optional location: string

metadata?

optional metadata: any

start_at?

optional start_at: string

status?

optional status: EventStatusEnum

subject?

optional subject: string

---

PitcherMultimediaAssetType

PitcherMultimediaAssetType: object

Type declaration

asset_type

asset_type: typeof MULTIMEDIA_IMG_TYPE.pitcher_asset

file

file: object

file.content_url?

optional content_url: File["content_url"]

file.id

id: File["id"]

file.name

name: File["name"]

horizontal_alignment?

optional horizontal_alignment: MultimediaHorizontalAlignmentOptions

poster_background_size?

optional poster_background_size: BackgroundSize

poster_url?

optional poster_url: string

type

type: "image" | "video"

---

Range<F, T>

Range<F, T>: Exclude<Enumerate<T>, Enumerate<F>> | T

Type Parameters

Type Parameter
F extends number
T extends number

---

SelectCollectionContent()

SelectCollectionContent: (payload) => Promise<{ content: CollectionPlayer; user_action: string; }>

Parameters

Parameter	Type
payload	{ attach_to: HTMLElement | string; initial_data: CollectionPlayer; initial_metadata_filters: Record<string, any>; open_settings: CollectionSelectorProps["openSettings"]; readonly_name: CollectionSelectorProps["readonlyName"]; }
payload.attach_to?	HTMLElement | string
payload.initial_data?	CollectionPlayer
payload.initial_metadata_filters?	Record<string, any>
payload.open_settings?	CollectionSelectorProps["openSettings"]
payload.readonly_name?	CollectionSelectorProps["readonlyName"]

Returns

Promise<{ content: CollectionPlayer; user_action: string; }>

---

SelectedFile

SelectedFile: object

Type declaration

content_type

content_type: FileContentTypeEnum

created_by

created_by: MiniUser

expires_at

expires_at: null | string

id

id: string

metadata

metadata: Record<string, any>

modified_at

modified_at: string

name

name: string

original_extension

original_extension: null | string

original_url

original_url: null | string

owned_by

owned_by: MiniUser

permissions

permissions: undefined | FilePermission

status

status: FileStatusEnum

tags

tags: string[]

thumbnail_url

thumbnail_url: string

type

type: "file"

---

SelectedPage

SelectedPage: object

Type declaration

file

file: object

file.id

id: File["id"]

file.name

name: File["name"]

id

id: string

name?

optional name: string

page_index

page_index: number

permissions?

optional permissions: File["permissions"]

thumbnail_url?

optional thumbnail_url: string

type

type: "page"

---

SelectFileContent()

SelectFileContent: (payload) => Promise<{ content: (SelectedFile | SelectedPage)[]; user_action: string; }>

Parameters

Parameter	Type
payload	{ allowed_asset_content_types: FileContentTypeEnum[]; allowed_content_types: FileContentTypeEnum[]; allowed_selector_types: SelectorType[]; attach_to: HTMLElement | string; initial_metadata_filters: Record<string, any>; selections: Selection[]; }
payload.allowed_asset_content_types?	FileContentTypeEnum[]
payload.allowed_content_types?	FileContentTypeEnum[]
payload.allowed_selector_types?	SelectorType[]
payload.attach_to?	HTMLElement | string
payload.initial_metadata_filters?	Record<string, any>
payload.selections?	Selection[]

Returns

Promise<{ content: (SelectedFile | SelectedPage)[]; user_action: string; }>

---

Selection

Selection: ContentSelection | ExternalLinkSelection | AssetSelection

---

SelectorType

SelectorType: "content" | "assets" | "external_links" | "ai_images" | "pexels_images" | "theme" | `multimedia-selector-${string}`

---

SfEvent

SfEvent: object

Type declaration

Account?

optional Account: object

Account.Name?

optional Name: string

AccountId?

optional AccountId: string

Description?

optional Description: string

DurationInMinutes?

optional DurationInMinutes: string

EndDateTime?

optional EndDateTime: string

EventWhoIds?

optional EventWhoIds: string[]

Id?

optional Id: string

IsAllDayEvent?

optional IsAllDayEvent: boolean

Name?

optional Name: string

OwnerId?

optional OwnerId: string

StartDateTime?

optional StartDateTime: string

Subject?

optional Subject: string

Type?

optional Type: string

WhatCount?

optional WhatCount: number

WhatId?

optional WhatId: string

WhoCount?

optional WhoCount: number

WhoId?

optional WhoId: string

---

SharedLink

SharedLink: object

Type declaration

canvas

readonly canvas: SharedLinkCanvas

file

readonly file: Record<string, any> | null

id

readonly id: string

instance

readonly instance: SharedLinkInstance

organization

readonly organization: SharedLinkOrganization

short_url?

optional short_url: string | null

status

readonly status: string

type

readonly type: string

url

readonly url: string

---

SharedLinkCanvas

SharedLinkCanvas: object

Type declaration

content?

optional content: Record<string, any>

context?

optional context: any

id

readonly id: string

name

name: string

sections

readonly sections: CanvasSection[]

theme?

optional theme: Record<string, any> | null

thumbnail_url?

optional thumbnail_url: string | null

---

SharedLinkInstance

SharedLinkInstance: object

Type declaration

color?

optional color: string | null

environment

readonly environment: Record<string, any>

id

readonly id: string

logo?

optional logo: string | null

name

name: string

settings?

optional settings: any

---

SharedLinkOrganization

SharedLinkOrganization: object

Type declaration

display_name?

optional display_name: string | null

id

id: string

metadata?

optional metadata: any

name

name: string

settings?

optional settings: any

---

SmartFolderRuleAttribute

SmartFolderRuleAttribute: object

Type declaration

accessor

accessor: string

display_name

display_name: string

name

name: string

type

type: "string" | "boolean" | "number" | "date" | "array"

---

SmartFolderRuleAttributes

SmartFolderRuleAttributes: object

Type declaration

canvas?

optional canvas: SmartFolderRuleAttribute[]

canvas_templates?

optional canvas_templates: SmartFolderRuleAttribute[]

files?

optional files: SmartFolderRuleAttribute[]

max_sync_limit?

optional max_sync_limit: number

section?

optional section: SmartFolderRuleAttribute[]

sync?

optional sync: boolean

sync_chunk_size?

optional sync_chunk_size: number

---

SupportedLocale

SupportedLocale: "en" | "de" | "pl" | "tr" | "el" | "fr" | "es" | "th" | "ja" | "zh" | "it" | "pt" | "nl"

---

TranslationOverrides

TranslationOverrides: object

Type declaration

de

de: undefined | Record<string, string>

el

el: undefined | Record<string, string>

en

en: undefined | Record<string, string>

es

es: undefined | Record<string, string>

fr

fr: undefined | Record<string, string>

it

it: undefined | Record<string, string>

ja

ja: undefined | Record<string, string>

nl

nl: undefined | Record<string, string>

pl

pl: undefined | Record<string, string>

pt

pt: undefined | Record<string, string>

th

th: undefined | Record<string, string>

tr

tr: undefined | Record<string, string>

zh

zh: undefined | Record<string, string>

---

Translations

Translations: object

Type declaration

createGroup?

optional createGroup: string

title?

optional title: string

warningMessage?

optional warningMessage: string

---

UpdateEnvParams

UpdateEnvParams: object

Type declaration

language

language: undefined | LanguageEnum

---

UpdateFolderPayload

UpdateFolderPayload: object

Type declaration

access_type

access_type: undefined | AccessTypeEnum

id

id: string

name

name: string

owned_by_id

owned_by_id: undefined | null | number

parent_folder_id

parent_folder_id: undefined | string

rules

rules: undefined | FolderRuleRequest[]

thumbnail_id

thumbnail_id: undefined | null | string

---

User

User: object

Type declaration

activated_at

readonly activated_at: string | null

connected_services

readonly connected_services: ConnectedService[]

deactivated_at

readonly deactivated_at: string | null

email

readonly email: string

first_name?

optional first_name: string

id

readonly id: number

is_active

readonly is_active: boolean

joined_date

readonly joined_date: string

language?

optional language: LanguageEnum

last_login_date

readonly last_login_date: string | null

last_name?

optional last_name: string

name

readonly name: string

picture

readonly picture: string | null

preferred_username?

optional preferred_username: string

role?

optional role: UserRoleEnum

tags?

optional tags: string[] | null

timezone?

optional timezone: string

---

ValuesOf<T>

ValuesOf<T>: T[keyof T]

Type Parameters

Type Parameter
T

Variables

CLIENT_TYPE

const CLIENT_TYPE: object

Type declaration

admin

readonly admin: "admin" = 'admin'

dsr

readonly dsr: "dsr" = 'dsr'

impact

readonly impact: "impact" = 'impact'

impactCanvasHome

readonly impactCanvasHome: "impact-canvas-home" = 'impact-canvas-home'

---

LaunchDarklyStringFlags

const LaunchDarklyStringFlags: object

Type declaration

ai_image_generation_model

readonly ai_image_generation_model: readonly ["minimax/image-01", ""]

ai_text_generation_model

readonly ai_text_generation_model: readonly ["anthropic/claude-3.5-sonnet", ""]

ai_video_generation_model

readonly ai_video_generation_model: readonly ["minimax/video-01", ""]

batch_open_content_grid_ar_files

readonly batch_open_content_grid_ar_files: readonly ["off", "simultaneous", "swap"]

canvas_component_grouping

readonly canvas_component_grouping: readonly ["page", "page_break", "none"]

dsr_remote_script_url

readonly dsr_remote_script_url: readonly ["https://anyvalidurl.xyz", ""]

pspdfkit_client_version

readonly pspdfkit_client_version: readonly ["2024.6.0", "2024.7.0"]

selectors_dnd_batch_add_style

readonly selectors_dnd_batch_add_style: readonly ["button", "buttons", "dropdown"]

slotty_ui_remote_script_url

readonly slotty_ui_remote_script_url: readonly ["https://anyvalidurl.xyz", ""]

Functions

Function	Description
createHighLevelApi	Creates a high-level API instance and caches it. Reterns a new instance only if new options are provided.