chrome.app.venster

Beschrijving

Gebruik de chrome.app.window API om vensters te maken. Windows heeft een optioneel frame met titelbalk en grootteregelaars. Ze zijn niet gekoppeld aan Chrome-browservensters. Zie het voorbeeld van de vensterstatus voor een demonstratie van deze opties.

Soorten

AppWindow

Eigenschappen

  • inhoudVenster

    Raam

    Het JavaScript 'window'-object voor het gemaakte kind.

  • Identiteitskaart

    snaar

    De ID waarmee het venster is gemaakt.

  • binnengrenzen

    Grenzen

    De positie, grootte en beperkingen van de inhoud van het venster, exclusief raamdecoraties. Deze eigenschap is nieuw in Chrome 36.

  • buitengrenzen

    Grenzen

    De positie, grootte en beperkingen van het venster, inclusief raamdecoraties, zoals de titelbalk en het frame. Deze eigenschap is nieuw in Chrome 36.

  • helderAandacht

    leegte

    Duidelijke aandacht voor het raam.

    De clearAttention functie ziet er als volgt uit: 

    () => {...}

  • dichtbij

    leegte

    Sluit het venster.

    De close ziet er als volgt uit: 

    () => {...}

  • trekAandacht

    leegte

    Vestig de aandacht op het raam.

    De drawAttention functie ziet er als volgt uit: 

    () => {...}

  • focus

    leegte

    Stel het raam scherp.

    De focus ziet er als volgt uit: 

    () => {...}

  • volledig scherm

    leegte

    Hiermee wordt het venster op volledig scherm weergegeven.

    De gebruiker kan het venster herstellen door op ESC te drukken. Een toepassing kan voorkomen dat de status op volledig scherm wordt verlaten wanneer ESC wordt ingedrukt door de toestemming app.window.fullscreen.overrideEsc aan te vragen en de gebeurtenis te annuleren door .preventDefault() aan te roepen in de keydown- en keyup-handlers, zoals dit:

    window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };

    Let op: window.fullscreen() zorgt ervoor dat het hele venster op volledig scherm wordt weergegeven en vereist geen gebruikersgebaar. De HTML5-API voor volledig scherm kan ook worden gebruikt om de modus Volledig scherm te openen (zie Web-API's voor meer details).

    De fullscreen schermfunctie ziet er als volgt uit: 

    () => {...}

  • krijgGrenzen

    leegte

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Haal de binnengrenzen van het venster op als een ContentBounds object.

    De getBounds functie ziet er als volgt uit: 

    () => {...}

  • verbergen

    leegte

    Verberg het venster. Doet niets als het venster al verborgen is.

    De hide ziet er als volgt uit: 

    () => {...}

  • isAltijdOnTop

    leegte

    Staat het raam altijd bovenaan?

    De isAlwaysOnTop functie ziet er als volgt uit: 

    () => {...}

    • retourneert

      Booleaans

  • isVolledig scherm

    leegte

    Is het venster volledig scherm? Dit is het geval als het venster op volledig scherm is gemaakt of op volledig scherm is gemaakt via de AppWindow of HTML5-API's op volledig scherm.

    De isFullscreen functie ziet er als volgt uit: 

    () => {...}

    • retourneert

      Booleaans

  • is gemaximaliseerd

    leegte

    Is het venster gemaximaliseerd?

    De isMaximized functie ziet er als volgt uit: 

    () => {...}

    • retourneert

      Booleaans

  • is geminimaliseerd

    leegte

    Is het venster geminimaliseerd?

    De isMinimized functie ziet er als volgt uit: 

    () => {...}

    • retourneert

      Booleaans

  • maximaliseren

    leegte

    Maximaliseer het venster.

    De maximize ziet er als volgt uit: 

    () => {...}

  • minimaliseren

    leegte

    Minimaliseer het venster.

    De minimize ziet er als volgt uit: 

    () => {...}

  • verplaatsNaar

    leegte

    Verouderd sinds Chrome 43

    Gebruik buitenste grenzen.

    Verplaats het venster naar de positie ( left , top ).

    De moveTo functie ziet er als volgt uit: 

    (left: number, top: number) => {...}

    • links

      nummer

    • bovenkant

      nummer

  • formaat wijzigenTo

    leegte

    Verouderd sinds Chrome 43

    Gebruik buitenste grenzen.

    Wijzig het formaat van het venster naar width x height pixels.

    De resizeTo functie ziet er als volgt uit: 

    (width: number, height: number) => {...}

    • breedte

      nummer

    • hoogte

      nummer

  • herstellen

    leegte

    Herstel het venster en verlaat de gemaximaliseerde, geminimaliseerde of volledig schermstatus.

    De restore ziet er als volgt uit: 

    () => {...}

  • setAlwaysOnTop

    leegte

    Stel in of het venster boven de meeste andere vensters moet blijven. Vereist de toestemming alwaysOnTopWindows .

    De setAlwaysOnTop -functie ziet er als volgt uit: 

    (alwaysOnTop: boolean) => {...}

    • altijdOnTop

      Booleaans

  • stelgrenzen in

    leegte

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Stel de binnengrenzen van het venster in.

    De setBounds functie ziet er als volgt uit: 

    (bounds: ContentBounds) => {...}

  • setVisibleOnAllWorkspaces

    leegte

    Stel in of het venster zichtbaar is op alle werkruimten. (Alleen voor platforms die dit ondersteunen).

    De setVisibleOnAllWorkspaces -functie ziet er als volgt uit: 

    (alwaysVisible: boolean) => {...}

    • altijdZichtbaar

      Booleaans

  • show

    leegte

    Laat het raam zien. Doet niets als het venster al zichtbaar is. Stel het venster scherp als focused is ingesteld op waar of weggelaten.

    De show ziet er als volgt uit: 

    (focused?: boolean) => {...}

    • gefocust

      Booleaans optioneel

Bounds

Eigenschappen

  • hoogte

    nummer

    Deze eigenschap kan worden gebruikt om de huidige hoogte van de inhoud of het venster te lezen of te schrijven.

  • links

    nummer

    Deze eigenschap kan worden gebruikt om de huidige X-coördinaat van de inhoud of het venster te lezen of te schrijven.

  • maxHoogte

    nummer optioneel

    Deze eigenschap kan worden gebruikt om de huidige maximale hoogte van de inhoud of het venster te lezen of te schrijven. Een waarde null geeft 'niet gespecificeerd' aan.

  • maximale breedte

    nummer optioneel

    Deze eigenschap kan worden gebruikt om de huidige maximale breedte van de inhoud of het venster te lezen of te schrijven. Een waarde null geeft 'niet gespecificeerd' aan.

  • minHoogte

    nummer optioneel

    Deze eigenschap kan worden gebruikt om de huidige minimale hoogte van de inhoud of het venster te lezen of te schrijven. Een waarde null geeft 'niet gespecificeerd' aan.

  • minBreedte

    nummer optioneel

    Deze eigenschap kan worden gebruikt om de huidige minimale breedte van de inhoud of het venster te lezen of te schrijven. Een waarde null geeft 'niet gespecificeerd' aan.

  • bovenkant

    nummer

    Deze eigenschap kan worden gebruikt om de huidige Y-coördinaat van de inhoud of het venster te lezen of te schrijven.

  • breedte

    nummer

    Deze eigenschap kan worden gebruikt om de huidige breedte van de inhoud of het venster te lezen of te schrijven.

  • stelMaximale Grootte in

    leegte

    Stel de maximale groottebeperkingen van de inhoud of het venster in. De maximale breedte of hoogte kan op null worden ingesteld om de beperking op te heffen. Een waarde van undefined laat een beperking ongewijzigd.

    De setMaximumSize functie ziet er als volgt uit: 

    (maxWidth: number, maxHeight: number) => {...}

    • maximale breedte

      nummer

    • maxHoogte

      nummer

  • stel Minimale Grootte in

    leegte

    Stel de minimale groottebeperkingen van de inhoud of het venster in. De minimale breedte of hoogte kan op null worden ingesteld om de beperking te verwijderen. Een waarde van undefined laat een beperking ongewijzigd.

    De setMinimumSize functie ziet er als volgt uit: 

    (minWidth: number, minHeight: number) => {...}

    • minBreedte

      nummer

    • minHoogte

      nummer

  • setPositie

    leegte

    Stel de linker- en bovenste positie van de inhoud of het venster in.

    De setPosition functie ziet er als volgt uit: 

    (left: number, top: number) => {...}

    • links

      nummer

    • bovenkant

      nummer

  • setgrootte

    leegte

    Stel de breedte en hoogte van de inhoud of het venster in.

    De setSize functie ziet er als volgt uit: 

    (width: number, height: number) => {...}

    • breedte

      nummer

    • hoogte

      nummer

BoundsSpecification

Eigenschappen

  • hoogte

    nummer optioneel

    De hoogte van de inhoud of het venster.

  • links

    nummer optioneel

    De X-coördinaat van de inhoud of het venster.

  • maxHoogte

    nummer optioneel

    De maximale hoogte van de inhoud of het venster.

  • maximale breedte

    nummer optioneel

    De maximale breedte van de inhoud of het venster.

  • minHoogte

    nummer optioneel

    De minimale hoogte van de inhoud of het venster.

  • minBreedte

    nummer optioneel

    De minimale breedte van de inhoud of het venster.

  • bovenkant

    nummer optioneel

    De Y-coördinaat van de inhoud of het venster.

  • breedte

    nummer optioneel

    De breedte van de inhoud of het venster.

ContentBounds

Eigenschappen

  • hoogte

    nummer optioneel

  • links

    nummer optioneel

  • bovenkant

    nummer optioneel

  • breedte

    nummer optioneel

CreateWindowOptions

Eigenschappen

  • altijdOnTop

    Booleaans optioneel

    Als dit waar is, blijft het venster boven de meeste andere vensters. Als er meerdere van dit soort vensters zijn, bevindt het momenteel gefocuste venster zich op de voorgrond. Vereist de toestemming alwaysOnTopWindows . Standaard ingesteld op false.

    Roep setAlwaysOnTop() aan in het venster om deze eigenschap na het maken te wijzigen.

  • grenzen

    ContentBounds optioneel

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Grootte en positie van de inhoud in het venster (exclusief de titelbalk). Als er ook een ID is opgegeven en er al eerder een venster met een overeenkomende ID is weergegeven, worden in plaats daarvan de onthouden grenzen van het venster gebruikt.

  • gefocust

    Booleaans optioneel

    Indien waar, zal het venster gefocust zijn wanneer het gemaakt wordt. Standaard ingesteld op waar.

  • kader

    tekenreeks | FrameOptions optioneel

    Frametype: none of chrome (standaard is chrome ). Voor none kan de CSS-eigenschap -webkit-app-region worden gebruikt om versleepbaarheid toe te passen op het venster van de app. -webkit-app-region: drag kan worden gebruikt om gebieden te markeren die versleepbaar zijn. no-drag kan worden gebruikt om deze stijl op geneste elementen uit te schakelen.

    Het gebruik van FrameOptions is nieuw in M36.

  • verborgen

    Booleaans optioneel

    Indien waar, wordt het venster in een verborgen staat gemaakt. Roep show() aan in het venster om het weer te geven zodra het is gemaakt. Standaard ingesteld op false.

  • icon

    tekenreeks optioneel

    Chroom 54+

    URL van het vensterpictogram. Een venster kan een eigen pictogram hebben als showInShelf is ingesteld op true. De URL moet een globale of een lokale extensie-URL zijn.

  • Identiteitskaart

    tekenreeks optioneel

    ID om het raam te identificeren. Dit zal worden gebruikt om de grootte en positie van het venster te onthouden en die geometrie te herstellen wanneer later een venster met dezelfde ID wordt geopend. Als een venster met een bepaald ID wordt gemaakt terwijl er al een ander venster met hetzelfde ID bestaat, wordt het huidig ​​geopende venster gefocust in plaats van dat er een nieuw venster wordt gemaakt.

  • binnengrenzen

    BoundsSpecificatie optioneel

    Wordt gebruikt om de initiële positie, initiële grootte en beperkingen van de inhoud van het venster (met uitzondering van raamdecoraties) te specificeren. Als er ook een id is opgegeven en er al eerder een venster met een overeenkomende id is weergegeven, worden in plaats daarvan de onthouden grenzen gebruikt.

    Houd er rekening mee dat de opvulling tussen de binnen- en buitengrenzen wordt bepaald door het besturingssysteem. Daarom resulteert het instellen van dezelfde bounds-eigenschap voor zowel innerBounds als outerBounds in een fout.

    Deze eigenschap is nieuw in Chrome 36.

  • maxHoogte

    nummer optioneel

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Maximale hoogte van het raam.

  • maximale breedte

    nummer optioneel

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Maximale breedte van het raam.

  • minHoogte

    nummer optioneel

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Minimale hoogte van het raam.

  • minBreedte

    nummer optioneel

    Afgekeurd

    Gebruik innerBounds of outsideBounds.

    Minimale breedte van het raam.

  • buitengrenzen

    BoundsSpecificatie optioneel

    Wordt gebruikt om de initiële positie, initiële grootte en beperkingen van het venster op te geven (inclusief raamdecoraties zoals de titelbalk en het frame). Als er ook een id is opgegeven en er al eerder een venster met een overeenkomende id is weergegeven, worden in plaats daarvan de onthouden grenzen gebruikt.

    Houd er rekening mee dat de opvulling tussen de binnen- en buitengrenzen wordt bepaald door het besturingssysteem. Daarom resulteert het instellen van dezelfde bounds-eigenschap voor zowel innerBounds als outerBounds in een fout.

    Deze eigenschap is nieuw in Chrome 36.

  • aanpasbaar

    Booleaans optioneel

    Als dit waar is, kan de grootte van het venster door de gebruiker worden aangepast. Standaard ingesteld op waar.

  • toonInShelf

    Booleaans optioneel

    Chroom 54+

    Als dit waar is, heeft het venster een eigen plankpictogram. Anders wordt het venster in de plank gegroepeerd met andere vensters die aan de app zijn gekoppeld. Standaard ingesteld op false. Als showInShelf is ingesteld op true, moet u een ID voor het venster opgeven.

  • eenling

    Booleaans optioneel

    Afgekeurd

    Meerdere vensters met dezelfde ID worden niet langer ondersteund.

    Als u een ID voor het venster opgeeft, wordt het venster standaard alleen gemaakt als er nog geen ander venster met dezelfde ID bestaat. Als er al een venster met dezelfde ID bestaat, wordt dat venster geactiveerd. Als u meerdere vensters met dezelfde ID wilt maken, kunt u deze eigenschap op false instellen.

  • staat

    Staat optioneel

    De beginstatus van het venster, waardoor het al op volledig scherm, gemaximaliseerd of geminimaliseerd kan worden gemaakt. Standaard ingesteld op 'normaal'.

  • type

    WindowType optioneel

    Chrome 45+ Verouderd sinds Chrome 69

    Alle app-vensters gebruiken het venstertype 'shell'

    Type venster dat moet worden gemaakt.

  • zichtbaarOnAllWorkspaces

    Booleaans optioneel

    Indien waar en ondersteund door het platform, zal het venster zichtbaar zijn op alle werkruimten.

FrameOptions

Eigenschappen

  • actieveKleur

    tekenreeks optioneel

    Hiermee kan de framekleur van het venster worden ingesteld wanneer het actief is. Framekleuring is alleen beschikbaar als het frametype chrome is.

    Framekleuring is alleen beschikbaar als het frametype chrome is.

    Framekleuring is nieuw in Chrome 36.

  • kleur

    tekenreeks optioneel

    Hiermee kan de framekleur worden ingesteld. Framekleuring is alleen beschikbaar als het frametype chrome is.

    Framekleuring is nieuw in Chrome 36.

  • inactiefKleur

    tekenreeks optioneel

    Hiermee kan de framekleur van het venster wanneer het inactief is, anders worden ingesteld dan de actieve kleur. Framekleuring is alleen beschikbaar als het frametype chrome is.

    inactiveColor moet worden gebruikt in combinatie met color .

    Framekleuring is nieuw in Chrome 36.

  • type

    tekenreeks optioneel

    Frametype: none of chrome (standaard is chrome ).

    Voor none kan de CSS-eigenschap -webkit-app-region worden gebruikt om versleepbaarheid toe te passen op het venster van de app.

    -webkit-app-region: drag kan worden gebruikt om gebieden te markeren die versleepbaar zijn. no-drag kan worden gebruikt om deze stijl op geneste elementen uit te schakelen.

State

Staat van een venster: normaal, volledig scherm, gemaximaliseerd, geminimaliseerd.

Enum

"normaal"

"volledig scherm"

"gemaximaliseerd"

"geminimaliseerd"

WindowType

Chroom 45+

Specificeert het type venster dat moet worden gemaakt.

Enum

"schelp"
Standaard venstertype.

"paneel"
Door het besturingssysteem beheerd venster (verouderd).

Methoden

canSetVisibleOnAllWorkspaces()

chrome.app.window.canSetVisibleOnAllWorkspaces()

Of het huidige platform ondersteunt dat vensters zichtbaar zijn op alle werkruimten.

Retouren

  • Booleaans

create()

Belofte
chrome.app.window.create(
  url: string,
  options?: CreateWindowOptions,
  callback?: function,
)

De grootte en positie van een raam kunnen op verschillende manieren worden gespecificeerd. De meest eenvoudige optie is helemaal niets specificeren, in welk geval een standaardgrootte en platformafhankelijke positie zal worden gebruikt.

Om de positie, grootte en beperkingen van het venster in te stellen, gebruikt u de eigenschappen innerBounds of outerBounds . Binnengrenzen zijn exclusief raamdecoratie. De buitengrenzen omvatten de titelbalk en het frame van het venster. Houd er rekening mee dat de opvulling tussen de binnen- en buitengrenzen wordt bepaald door het besturingssysteem. Daarom wordt het instellen van dezelfde eigenschap voor zowel binnen- als buitengrenzen als een fout beschouwd (bijvoorbeeld het instellen van zowel innerBounds.left als outerBounds.left ).

Om de posities van vensters automatisch te onthouden, kunt u ze ID's geven. Als een venster een ID heeft, wordt deze ID gebruikt om de grootte en positie van het venster te onthouden wanneer het wordt verplaatst of vergroot of verkleind. Deze grootte en positie worden vervolgens gebruikt in plaats van de opgegeven grenzen bij het later openen van een venster met dezelfde ID. Als u een venster met een ID op een andere locatie dan de onthouden standaard wilt openen, kunt u het verborgen maken, naar de gewenste locatie verplaatsen en vervolgens weergeven.

Parameters

  • URL

    snaar

  • opties

    CreateWindowOptions optioneel

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (createdWindow: AppWindow) => void

Retouren

  • Beloof < AppWindow >

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

current()

chrome.app.window.current()

Retourneert een AppWindow object voor de huidige scriptcontext (dat wil zeggen JavaScript-vensterobject). Dit kan ook worden aangeroepen via een handle naar een scriptcontext voor een andere pagina, bijvoorbeeld: otherWindow.chrome.app.window.current().

Retouren

get()

chrome.app.window.get(
  id: string,
)

Krijgt een AppWindow met de opgegeven id. Als er geen venster met de opgegeven ID bestaat, wordt null geretourneerd. Deze methode is nieuw in Chrome 33.

Parameters

  • Identiteitskaart

    snaar

Retouren

getAll()

chrome.app.window.getAll()

Krijgt een array van alle momenteel gemaakte app-vensters. Deze methode is nieuw in Chrome 33.

Retouren

Evenementen

onBoundsChanged

chrome.app.window.onBoundsChanged.addListener(
  callback: function,
)

Wordt geactiveerd wanneer het formaat van het venster wordt gewijzigd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onClosed

chrome.app.window.onClosed.addListener(
  callback: function,
)

Wordt afgevuurd als het raam gesloten is. Let op: dit moet worden beluisterd vanuit een ander venster dan het venster dat wordt gesloten, bijvoorbeeld vanaf de achtergrondpagina. Dit komt omdat het venster dat wordt gesloten, bezig is te worden afgebroken wanneer de gebeurtenis wordt geactiveerd, wat betekent dat niet alle API's in de scriptcontext van het venster functioneel zullen zijn.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onFullscreened

chrome.app.window.onFullscreened.addListener(
  callback: function,
)

Wordt geactiveerd wanneer het venster op volledig scherm wordt weergegeven (via de AppWindow of HTML5-API's).

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onMaximized

chrome.app.window.onMaximized.addListener(
  callback: function,
)

Wordt geactiveerd wanneer het venster is gemaximaliseerd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onMinimized

chrome.app.window.onMinimized.addListener(
  callback: function,
)

Wordt geactiveerd wanneer het venster wordt geminimaliseerd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onRestored

chrome.app.window.onRestored.addListener(
  callback: function,
)

Wordt geactiveerd wanneer het venster wordt hersteld van geminimaliseerd of gemaximaliseerd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void