Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

  • IConfig

Index

Properties

Optional backend

setup the backend endpoints to override the default

Optional clientId

clientId?: string

The client ID key provided by Annoto

remarks

If not set, the widget will load in demo mode

Optional demoMode

demoMode?: boolean

If set to true, the widget will load in demo mode

Optional features

features?: F

Enable/disable and configure features Modifying the features will override the backend configured features.

remarks

If Feature is not enabled on backend it cannot be enabled via this api.

Optional fsZIndex

fsZIndex?: number

same as zIndex, only for when the player is in fullscreen.

default

100

Optional group

Course/group details If provided the discussions on the media will be categorized by groups allowing private discussions per group for same media

Optional hooks

hooks?: IHooks

Callback hooks for triggering actions such as auth and getting info

Optional launchSource

launchSource?: ILaunchSourceConfig

Launch source credentials for widget integration via proxy domain For example LTI

Optional locale

locale?: string

Language code in IETF BCP 47 or ISO/IEC 15897.

default

'en'

Optional ux

ux?: IUx

Configuration options that affect the user experience

widgets

widgets: IWidgetConfig<F>[]

Widget configuration settings.

remarks

only single widget is supported. the array is for future use.

Optional zIndex

zIndex?: number

Set the zIndex to appropriate value to make the app visible and not iterfer with other elements.

default

100