WarningThis is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.

Internationalization

This article outlines the approach to internationalization of labels and text rendered by the Annotations API UI and details the available labels for override.

When calling LearnosityAnnotations.init() an internationalization bundle of key value pairs can be supplied as labelBundle.

Follow the Annotations API label bundle link to access the raw json data.

Below is the current list of labels that can be changed through the labelBundle object. It is intended to cover all text that is displayed to the user.

object

Object of labels and values can be passed to override default English labeling

Properties:
drawingAreaExitButton
Type: string
Default: Exit drawing mode
drawingAreaHideGridButton
Type: string
Default: Hide grid
drawingAreaShowGridButton
Type: string
Default: Show grid
drawingToolbarEraserButton
Type: string
Default: Eraser
drawingToolbarExitButton
Type: string
Default: Exit drawing mode
drawingToolbarHideGridButton
Type: string
Default: Hide grid
drawingToolbarPencilButton
Type: string
Default: Pencil
drawingToolbarShowColorPaletteButton
Type: string
Default: Select color
drawingToolbarShowGridButton
Type: string
Default: Show grid
notepadCollapse
Type: string
Default: Collapse
notepadExpand
Type: string
Default: Expand
notepadHide
Type: string
Default: Hide
notepadMaximize
Type: string
Default: Maximize
notepadMinimize
Type: string
Default: Minimize
notepadTitle
Type: string
Default: Notepad
characterLimit
Type: string
Default: {{currentCount}}/{{totalCount}} character limit
characterLimitReached
Type: string
Default: {{currentCount}}/{{totalCount}} character limit reached
stickynoteCancelRemove
Type: string
Default: Cancel
stickynoteCollapse
Type: string
Default: Collapse
stickynoteConfirmBlurb
Type: string
Default: Remove Sticky Note?
stickynoteConfirmRemove
Type: string
Default: Remove
stickynoteExpand
Type: string
Default: Expand
stickynoteRemove
Type: string
Default: Remove
texthighlightApply
Type: string
Default: Highlight
texthighlightHidePalette
Type: string
Default: Hide color palette
texthighlightRemove
Type: string
Default: Remove
texthighlightShowPalette
Type: string
Default: Show color palette