Acrolinx Sidebar API Reference
Loading
- Load your host editor and your integration code.
- Register your integration as an
acrolinxPlugin
(See AcrolinxPluginInterface
).
var acrolinxPlugin = {...}
-
Load the Sidebar and the referenced libraries code (usually sidebar.js, libs.js, sidebar.css).
Initializing
-
Once the Sidebar has finished loading, it will request the integration
to initialize by calling
requestInit
.
-
The AcrolinxPlugin now must call
init
.
-
Once the init process has finished, the integration will be notified
onInitFinished
.
-
After initializing, the Sidebar will call
configure
and push the latest
configuration to the integration.
Checking
If the user pushes the button "Check" (in the Acrolinx Sidebar), requestGlobalCheck
is called.
The acrolinxPlugin must call checkGlobal
to perform a check.
When the check finished, onCheckResult
is called and the Sidebar displays cards for the issues.
Other Actions
- When the user clicks on a card the Sidebar will invoke
selectRanges
on the Acrolinx
Integration.
- When the user clicks on a replacement the Sidebar will call
replaceRanges
.
Batch Checking
Batch checking is supported from Acrolinx Sidebar version 15.0 and Core Platform version 2021.12.
If batch checking is supported and the user pushes the button "Batch Check" (in the Acrolinx Sidebar),
requestGlobalCheck
is called with the option batchCheck
set to true.
To start a batch check, the acrolinxPlugin must call initBatchCheck
with the list of documents
that needs to be checked.
For each document to be checked, requestCheckForDocumentInBatch
is called.
The acrolinxPlugin must then call checkDocumentInBatch
to perform a check. The Sidebar displays a card
for each document and the check process is started.
When the user clicks on a card, openDocumentInEditor
is called to request the acrolinxPlugin to open the document.