Interface AcrolinxSidebar

The sidebar will provide this interface in window.acrolinxSidebar.

interface AcrolinxSidebar {
    checkDocumentInBatch?(
        documentIdentifier: string,
        documentContent: string,
        options: CheckOptions,
    ): void;
    checkGlobal(documentContent: string, options: CheckOptions): Check;
    configure(configuration: SidebarConfiguration): void;
    init(initParameters: InitParameters): void;
    initBatchCheck?(documentIdentifiers: BatchCheckRequestOptions[]): void;
    invalidateRanges(invalidCheckedDocumentRanges: CheckedDocumentPart[]): void;
    liveSearch?(query: string): void;
    onGlobalCheckRejected(): void;
    onVisibleRangesChanged(checkedDocumentRanges: CheckedDocumentPart[]): void;
    showMessage(message: Message): void;
}

Index

Methods

checkDocumentInBatch? checkGlobal configure init initBatchCheck? invalidateRanges liveSearch? onGlobalCheckRejected onVisibleRangesChanged showMessage

Methods

`Optional`checkDocumentInBatch

checkDocumentInBatch?(
    documentIdentifier: string,
    documentContent: string,
    options: CheckOptions,
): void
Initiates a check for the document with the given document identifier.
Parameters
- documentIdentifier: string
  Identifier for the document to be checked.
- documentContent: string
  The document to be checked.
- options: CheckOptions
  Check options.
Returns void
- Defined in index.ts:589

checkGlobal

checkGlobal(documentContent: string, options: CheckOptions): Check
Perform a check of the whole document. Once the check is done, AcrolinxPlugin.onCheckResult will be notified.
```
acrolinxSidebar.checkGlobal('<sample>my text</sample>', {
   inputFormat: 'XML',
   requestDescription: {
     documentReference: 'myfile.xml'
   }
});
```
Parameters
- documentContent: string
  The document you want to check.
- options: CheckOptions
Returns Check
Object containing the ID of the check.
- Defined in index.ts:574

configure

configure(configuration: SidebarConfiguration): void
Configures the sidebar with the specified parameters. This method can be called repeatedly after init was called.
```
 acrolinxSidebar.configure({
   readOnlySuggestions: true
 });
```
Parameters
- configuration: SidebarConfiguration
Returns void
- Defined in index.ts:555

init

init(initParameters: InitParameters): void
Initializes the sidebar with the specified initParameters. After calling this method, the sidebar will become ready for checking and call onInitFinished.
```
 acrolinxSidebar.init({
   clientSignature: 'sdfasdfiIOJEIEJIOR',
   clientComponents: [{
     id: 'com.acrolinx.myEditor'
     name:'Acrolinx for myEditor',
     version:'1.0.0.42'
   }]
 });
```
Parameters
- initParameters: InitParameters
Returns void
- Defined in index.ts:543

`Optional`initBatchCheck

initBatchCheck?(documentIdentifiers: BatchCheckRequestOptions[]): void
Perform a batch check of the document components.
Parameters
- documentIdentifiers: BatchCheckRequestOptions[]
  List of document identifiers on which to perfrom a batch check.
Returns void
- Defined in index.ts:580

invalidateRanges

invalidateRanges(invalidCheckedDocumentRanges: CheckedDocumentPart[]): void
This function can be used to invalidate check result cards that link to invalid parts of the document. That can happen due to changes or deletions in the document.
Parameters
- invalidCheckedDocumentRanges: CheckedDocumentPart[]
  checkIds and offsets belonging to a previous performed check.
Returns void
- Defined in index.ts:599

`Optional`liveSearch

liveSearch?(query: string): void
Perform a search for suggestions with the given query .
Parameters
- query: string
  The query on which to perform a search for suggestions.
Returns void
- Defined in index.ts:619

onGlobalCheckRejected

onGlobalCheckRejected(): void
Returns void
- Defined in index.ts:591

onVisibleRangesChanged

onVisibleRangesChanged(checkedDocumentRanges: CheckedDocumentPart[]): void
Notify the sidebar of the currently displayed part of the document.
Parameters
- checkedDocumentRanges: CheckedDocumentPart[]
  The ranges of previous performed checks.
Returns void
- Defined in index.ts:606

showMessage

showMessage(message: Message): void
Show a message in the Sidebar. Supported since Acrolinx Platform 2021.2 (Sidebar version 14.28).
Parameters
- message: Message
  The message to show.
Returns void
- Defined in index.ts:613