Koncentrisani čitalac JavaScript SDK-referens (v1.4)

Koncentrisani čitalac SDK innehåller ett JavaScript-bibliotek som gör att du kan integrera Koncentrisani čitalac i ditt program.

Du kan använda npm, yarneller ett HTML-element <script> för att inkludera biblioteket för den senaste stabila versionen i webbappen:

<script type='text/javascript' src='https://ircdname.azureedge.net/immersivereadersdk/immersive-reader-sdk.1.4.0.js'></script>

npm install @microsoft/immersive-reader-sdk

yarn add @microsoft/immersive-reader-sdk

Funktioner

SDK:et exponerar följande funktioner:

• ImmersiveReader.launchAsync(token, underdomän, innehåll, alternativ)
• ImmersiveReader.close()
• ImmersiveReader.renderButtons(options)

Funktion: launchAsync

ImmersiveReader.launchAsync(token, subdomain, content, options)startar Koncentrisani čitalac i ett HTML-element iframe i webbappen. Storleken på ditt innehåll är begränsad till högst 50 MB.

launchAsync(token: string, subdomain: string, content: Content, options?: Options): Promise<LaunchResponse>;

Returer

Returnerar en Promise<LaunchResponse>, som matchar när Koncentrisani čitalac läses in. Matchar Promise ett LaunchResponse-objekt .

Undantag

Om Koncentrisani čitalac inte kan läsas in avvisas den returnerade Promise med ett felobjekt.

Funktion: close

ImmersiveReader.close()stänger Koncentrisani čitalac.

Ett exempel på användningsfall för den här funktionen är om avslutsknappen är dold genom att ange hideExitButton: true alternativ. Sedan kan en annan knapp (till exempel en mobil rubriks bakåtpil) anropa den här close funktionen när den klickas.

close(): void;

Funktion: renderButtons

Funktionen ImmersiveReader.renderButtons(options) är inte nödvändig om du använder vägledningen om hur du anpassar Koncentrisani čitalac-knappen.

Den här funktionen formatmallar och uppdaterar dokumentets Koncentrisani čitalac knappelement. Om options.elements anges återges knapparna i varje element som anges i options.elements. Att använda parametern options.elements är användbart när du har flera avsnitt i dokumentet där du kan starta Koncentrisani čitalac och vill ha ett förenklat sätt att återge flera knappar med samma format, eller vill återge knapparna med ett enkelt och konsekvent designmönster. Om du vill använda den här funktionen med parametern renderButtons-alternativ anropar ImmersiveReader.renderButtons(options: RenderButtonsOptions); du sidinläsningen enligt beskrivningen i följande kodfragment. Annars återges knapparna i dokumentets element som har klassen immersive-reader-button som visas i Så här anpassar du knappen Koncentrisani čitalac.

// This snippet assumes there are two empty div elements in
// the page HTML, button1 and button2.
const btn1: HTMLDivElement = document.getElementById('button1');
const btn2: HTMLDivElement = document.getElementById('button2');
const btns: HTMLDivElement[] = [btn1, btn2];
ImmersiveReader.renderButtons({elements: btns});

Fler återgivningsalternativ finns i startknappens valfria attribut. Om du vill använda de här alternativen lägger du till något av alternativattributen till var och en HTMLDivElement i sidans HTML-kod.

renderButtons(options?: RenderButtonsOptions): void;

renderButtons-alternativ

Alternativ för att återge Koncentrisani čitalac knapparna.

{
    elements: HTMLDivElement[];
}

Type: HTMLDivElement[]
Required: false

Knappen Starta

SDK:t tillhandahåller standardformatering för Koncentrisani čitalac-startknappen. Använd klassattributet immersive-reader-button för att aktivera den här formateringen. Mer information finns i Anpassa knappen Koncentrisani čitalac.

<div class='immersive-reader-button'></div>

Använd följande valfria attribut för att konfigurera knappens utseende och känsla.

LaunchResponse

Innehåller svaret från anropet till ImmersiveReader.launchAsync. En referens till HTML-elementet iframe som innehåller Koncentrisani čitalac kan nås via container.firstChild.

{
    container: HTMLDivElement;
    sessionId: string;
    charactersProcessed: number;
}

Fel

Innehåller information om ett fel.

{
    code: string;
    message: string;
}

Typer

Innehåll

Innehåller det innehåll som ska visas i Koncentrisani čitalac.

{
    title?: string;
    chunks: Chunk[];
}

title

Type: String
Required: false
Default value: "Immersive Reader" 

chunks

Type: Chunk[]
Required: true
Default value: null 

Segment

Ett enda datasegment som skickas till innehållet i Koncentrisani čitalac.

{
    content: string;
    lang?: string;
    mimeType?: string;
}

content

Type: String
Required: true
Default value: null 

lang

Type: String
Required: false
Default value: Automatically detected 

mimeType

Type: String
Required: false
Default value: "text/plain"

MIME-typer som stöds

Alternativ

Innehåller egenskaper som konfigurerar vissa beteenden för Koncentrisani čitalac.

{
    uiLang?: string;
    timeout?: number;
    uiZIndex?: number;
    useWebview?: boolean;
    onExit?: () => any;
    customDomain?: string;
    allowFullscreen?: boolean;
    parent?: Node; 
    hideExitButton?: boolean;
    cookiePolicy?: CookiePolicy;
    disableFirstRun?: boolean;
    readAloudOptions?: ReadAloudOptions;
    translationOptions?: TranslationOptions;
    displayOptions?: DisplayOptions;
    preferences?: string;
    onPreferencesChanged?: (value: string) => any;
    disableGrammar?: boolean;
    disableTranslation?: boolean;
    disableLanguageDetection?: boolean;
}

uiLang

Type: String
Required: false
Default value: User's browser language 

timeout

Type: Number
Required: false
Default value: 15000

uiZIndex

Type: Number
Required: false
Default value: 1000

onExit

Type: Function
Required: false
Default value: null

preferences

Type: String
Required: false
Default value: null

onPreferencesChanged

Type: Function
Required: false
Default value: null

customDomain

Type: String
Required: false
Default value: null

ReadAloudOptions

type ReadAloudOptions = {
    voice?: string;
    speed?: number;
    autoplay?: boolean;
};

voice

Type: String
Required: false
Default value: "Female" or "Male" (determined by language) 
Values available: "Female", "Male"

speed

Type: Number
Required: false
Default value: 1
Values available: 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2, 2.25, 2.5

TranslationOptions

type TranslationOptions = {
    language: string;
    autoEnableDocumentTranslation?: boolean;
    autoEnableWordTranslation?: boolean;
};

language

Type: String
Required: true
Default value: null 
Values available: For more information, see the Supported languages section

TemaAlternativ

enum ThemeOption { Light, Dark }

DisplayOptions

type DisplayOptions = {
    textSize?: number;
    increaseSpacing?: boolean;
    fontFamily?: string;
    themeOption?: ThemeOption
};

textSize

Type: Number
Required: false
Default value: 20, 36 or 42 (Determined by screen size)
Values available: 14, 20, 28, 36, 42, 48, 56, 64, 72, 84, 96

fontFamily

Type: String
Required: false
Default value: "Calibri"
Values available: "Calibri", "Sitka", "ComicSans"

CookiePolicy-alternativ

enum CookiePolicy { Disable, Enable }

Följande inställningar är endast i informationssyfte. Koncentrisani čitalac lagrar sina inställningar, eller användarinställningar, i cookies. Det här cookiePolicy-alternativet inaktiverar användningen av cookies som standard för att följa EU:s lagar om cookieefterlevnad. Om du vill återaktivera cookies och återställa standardfunktionerna för Koncentrisani čitalac användarinställningar behöver din webbplats eller ditt program rätt medgivande från användaren för att aktivera cookies. För att återaktivera cookies i Koncentrisani čitalac måste du uttryckligen ange cookiePolicy-alternativet till CookiePolicy.Enable när du startar Koncentrisani čitalac.

I följande tabell beskrivs vilka inställningar Koncentrisani čitalac lagrar i sin cookie när alternativet cookiePolicy är aktiverat.

Språk som stöds

Översättningsfunktionen i Koncentrisani čitalac stöder många språk. Mer information finns i Språkstöd.

HTML-stöd

När formatering är aktiverat återges följande innehåll som HTML i Koncentrisani čitalac.

Taggar som inte stöds återges jämförelsevis. Bilder och tabeller stöds för närvarande inte.

Webbläsarstöd

Använd de senaste versionerna av följande webbläsare för att få bästa möjliga upplevelse av Koncentrisani čitalac.

• Microsoft Edge
• Google Chrome
• Mozilla Firefox
• Apple Safari

Gå vidare