This 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.

Note: support has been added for i18n (internationalization) labels that were previously hard-coded, since version: v2021.1.LTS.

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
string
Default: Exit drawing mode
drawingAreaHideGridButton
string
Default: Hide grid
drawingAreaShowGridButton
string
Default: Show grid
drawingToolbarEraserButton
string
Default: Eraser
drawingToolbarExitButton
string
Default: Exit drawing mode
drawingToolbarHideGridButton
string
Default: Hide grid
drawingToolbarPencilButton
string
Default: Pencil
drawingToolbarShowColorPaletteButton
string
Default: Select color
drawingToolbarShowGridButton
string
Default: Show grid
notepadMove
string
Default: Move notepad. Select to move notepad
notepadCollapse
string
Default: Collapse
notepadExpand
string
Default: Expand
notepadHide
string
Default: Hide
notepadMaximize
string
Default: Maximize
notepadMinimize
string
Default: Minimize
notepadClose
string
Default: Close
notepadTitle
string
Default: Notepad
notepadResize
string
Default: Resize notepad. Select to resize notepad.
characterLimit
string
Default: {{currentCount}}/{{totalCount}} character limit
characterLimitReached
string
Default: {{currentCount}}/{{totalCount}} character limit reached
stickynoteCancelRemove
string
Default: Cancel
stickynoteCollapse
string
Default: Collapse sticky note
stickynoteConfirmBlurb
string
Default: Remove sticky note?
stickynoteConfirmRemove
string
Default: Remove
stickynoteCancelRemoveAriaLabel
string
Default: Do you want to remove the sticky note?
stickynoteExpand
string
Default: Expand sticky note
stickynoteRemove
string
Default: Remove
stickynoteMove
string
Default: Move sticky note. Select to move sticky note
stickynoteMoveActive
string
Default: Sticky note grabbed. For MacOS hold Option Key + Arrow keys, for WindowsOS hold Alt key + Arrow keys. To stop moving selection, press either: Enter, Spacebar or Escape keys.
stickynoteMoveDropped
string
Default: Sticky note dropped.
stickynoteResize
string
Default: Resize sticky note. Select to resize sticky note.
stickynoteResizeActive
string
Default: Resize sticky note. For MacOS hold Option Key + Arrow keys, for WindowsOS hold Alt key + Arrow keys. To stop resize selection, press either: Enter, Spacebar or Escape keys.
stickynoteResizeDropped
string
Default: Sticky note resized.
texthighlightApply
string
Default: Highlight
texthighlightHidePalette
string
Default: Hide color palette
texthighlightRemove
string
Default: Remove
texthighlightShowPalette
string
Default: Show color palette