GrabzIt Client met Node.js

Omschrijving

Deze klasse verzorgt alle communicatie met de GrabzIt-screenshotwebservices.

Publieke methoden

get_result(id)
url_to_animation(url, options)
url_to_image(url, options)
html_to_image(html, options)
file_to_image(path, options)
url_to_pdf(url, options)
html_to_pdf(html, options)
file_to_pdf(path, options)
url_to_docx(url, options)
html_to_docx(html, options)
file_to_docx(path, options)
url_to_table(url, options)
html_to_table(html, options)
file_to_table(path, options)
url_to_rendered_html(url, options)
html_to_rendered_html(html, options)
file_to_rendered_html(path, options)
save(callBackUrl, oncomplete)
save_to(saveToFile, oncomplete)
get_status(id, oncomplete)
get_cookies(domain, oncomplete)
set_cookie(name, domain, options, oncomplete)
delete_cookie(name, domain, oncomplete)
get_watermarks(oncomplete)
get_watermark(identifier, oncomplete)
add_watermark(identifier, path, xpos, ypos, oncomplete)
delete_watermark(identifier, oncomplete)
set_local_proxy(value)
use_ssl(value)
create_encryption_key()
decrypt(data, key)
decrypt_file(path, key, oncomplete)

get_result (id)

Deze methode retourneert de screenshot zelf. Als er niets wordt geretourneerd, is er iets misgegaan of is de screenshot nog niet gereed.

parameters

id - de unieke identificatie van de screenshot
- Nodig

url_to_animation(Url, opties)

Geef de URL op van de online video die moet worden geconverteerd intoa geanimeerde GIF.

parameters

url - de URL van de online video die moet worden geconverteerd into een geanimeerde GIF
- Nodig
- Accepteert Vimeo en YouTube video-URL's
  - Waarschuwing voor het animeren van Vimeo- en YouTube-video's is afhankelijk van een derde partij en biedt dus mogelijk geen consistente resultaten.
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van de geanimeerde GIF.

Winstwaarde

komen te vervallen

Animatie opties

Alle beschikbare opties bij het maken van een geanimeerde GIF.

customId - aangepaste id die u kunt doorgeven aan de geanimeerde GIF-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
- Standaard: leeg
width - de breedte van de resulterende geanimeerde GIF in pixels.
- Standaard: 180px
- Maximum: maximale breedte voor pakket
- Auto-formaat: -1 (passerend -1 betekent dat de breedte van de geanimeerde GIF is geschaald in verhouding tot de hoogte, als de breedte automatisch wordt aangepast, kan de hoogte niet)
height - de hoogte van de resulterende geanimeerde GIF in pixels.
- Standaard: 120px
- Maximum: maximale hoogte voor pakket
- Auto-formaat: -1 (passeren van -1 betekent dat de hoogte van de geanimeerde GIF is geschaald in verhouding tot de breedte, als de hoogte automatisch wordt aangepast, kan de breedte niet)
start - de startpositie van de video die moet worden geconverteerd intoa geanimeerde GIF.
- Standaard: 0 seconden
duration - de lengte in seconden van de video die moet worden geconverteerd intoa geanimeerde GIF.
- Standaard: maximale lengte voor pakket
speed - de snelheid van de geanimeerde GIF.
- Standaard: 1
- Minimum: 0.2
- Maximaal: 10
framesPerSecond - het aantal frames per seconde dat moet worden vastgelegd van de video.
- Standaard: 10
- Minimum: 0.2
- Maximaal: 60
repeat - aantal keren dat de geanimeerde GIF in een lus moet worden geplaatst.
- Standaard: 0
- Lus continu: 0
- Loop nooit: -1
reverse - indien waar, worden de frames van de geanimeerde GIF omgekeerd
- Standaard: false
customWaterMarkId - voeg aangepast watermark naar de geanimeerde GIF
- Standaard: leeg
quality - de kwaliteit van de geretourneerde afbeelding, die een standaardcompressie van 85% heeft.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
country - het land de geanimeerde GIF moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg

Opties voorbeeld

{
    'width':250,
    'height':250,
    'speed':2
}

url_to_image(Url, opties)

Hiermee geeft u de URL op die moet worden geconverteerd intoa afbeelding screenshot.

parameters

url - de URL waarvan het screenshot moet worden gemaakt
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van de screenshot.

Winstwaarde

komen te vervallen

html_to_image(Html, opties)

Hiermee geeft u de HTML op die moet worden geconverteerd inteen afbeelding.

parameters

html - de HTML om te zetten inteen afbeelding
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.

Winstwaarde

komen te vervallen

file_to_image(pad, opties)

Geeft een HTML-bestand aan dat moet worden geconverteerd inteen afbeelding.

parameters

pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd inteen afbeelding
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.

Winstwaarde

komen te vervallen

Afbeelding opties

Alle beschikbare opties bij het maken van afbeeldingen.

customId - aangepaste id die u kunt doorgeven aan de screenshot-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
- Standaard: leeg
browserWidth - de breedte van de browser in pixels
- Standaard: 1366
- Maximaal: 10000
browserHeight - de hoogte van de browser in pixels
- Standaard: 1170
- Maximaal: 10000
- Volledige lengte: -1 (doorgeven van -1 betekent dat een sceenshot van de hele webpagina wordt gemaakt)
width - de breedte van de resulterende miniatuur in pixels
- Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerhoogte is opgegeven, is de uitvoerbreedte evenredig met de uitvoerhoogte
- Maximum: maximale breedte voor pakket
- Volledige breedte: -1 (passeren van -1 betekent dat de breedte van de miniatuur niet wordt verkleind)
height - de hoogte van de resulterende miniatuur in mm
- Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerbreedte is opgegeven, is de uitvoerhoogte evenredig met de uitvoerbreedte
- Maximum: maximale hoogte voor pakket
- Volledige hoogte: -1 (doorgeven van -1 betekent dat de hoogte van de miniatuur niet wordt verkleind)
format - het formaat waarin de screenshot moet zijn.
- Standaard: "jpg"
- Opties: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
clickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
targetElement - de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa screenshot, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
- Standaard: leeg
hideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
- Standaard: leeg
waitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
- Standaard: leeg
requestAs - het type user-agent dat u wilt gebruiken
- Standaard: 0
- Opties:
  - 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
  - 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
  - 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
customWaterMarkId - voeg een aangepast watermark naar de afbeelding
- Standaard: leeg
quality - de kwaliteit van de geretourneerde afbeelding. Dit heeft momenteel alleen effect op JPG- en WEBP-afbeeldingen, die een standaardcompressie van 90% hebben.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
transparent - indien waar beeldopname moet transparant zijn. Dit is alleen compatibel met png- en tiff-afbeeldingen.
- Standaard: false
hd - indien waar de afbeelding vastleggen zal in hoge definitie zijn dit verdubbelt de grootte van de afbeeldingsafmetingen.
- Standaard: false
country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
noAds - als het waar is advertenties moeten automatisch worden verborgen.
- Standaard: false
noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
- Standaard: false
address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
- Standaard: leeg
post - definieert de HTTP Post-querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn. Als u deze optie gebruikt, wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg

Opties voorbeeld

{
    'width':500,
    'height':500
}

url_to_rendered_html(Url, opties)

Hiermee geeft u de URL op die moet worden geconverteerd into gerenderde HTML.

parameters

url - de URL waarvan de gerenderde HTML moet worden gemaakt
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van de gerenderde HTML.

Winstwaarde

komen te vervallen

html_to_rendered_html(Html, opties)

Hiermee geeft u de HTML op die moet worden geconverteerd into gerenderde HTML.

parameters

html - de HTML om te zetten into gerenderde HTML
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.

Winstwaarde

komen te vervallen

file_to_rendered_html(pad, opties)

Geeft een HTML-bestand aan dat moet worden geconverteerd into gerenderde HTML.

parameters

pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd into gerenderde HTML
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.

Winstwaarde

komen te vervallen

HTML-opties

Alle beschikbare opties wanneer gerenderde HTML-vastleggingen maken.

customId - aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
- Standaard: leeg
browserWidth - de breedte van de browser in pixels
- Standaard: 1366
- Maximaal: 10000
browserHeight - de hoogte van de browser in pixels
- Standaard: 1170
- Maximaal: 10000
delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
clickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
waitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
- Standaard: leeg
requestAs - het type user-agent dat u wilt gebruiken
- Standaard: 0
- Opties:
  - 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
  - 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
  - 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
noAds - als het waar is advertenties moeten automatisch worden verborgen.
- Standaard: false
noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
- Standaard: false
address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
- Standaard: leeg
post - definieert de HTTP Post-querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn. Als u deze optie gebruikt, wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg

Opties voorbeeld

{
    'country':'SG',
    'delay':5000
}

url_to_pdf(Url, opties)

Hiermee geeft u de URL op die moet worden geconverteerd intoa PDF.

parameters

url - de URL die moet worden geconverteerd intoa PDF
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

html_to_pdf(Html, opties)

Hiermee geeft u de HTML op die moet worden geconverteerd intoa PDF.

parameters

html - de HTML om te zetten intoa PDF
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

file_to_pdf(pad, opties)

Geeft een HTML-bestand aan dat moet worden geconverteerd intoa PDF.

parameters

pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa PDF
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

PDF-opties

Alle beschikbare opties bij het maken van PDF-opnames.

customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
- Standaard: leeg
includeBackground - indien waar, moet de achtergrond van de webpagina in de screenshot worden opgenomen
- Standaard: waar

pagesize - het paginaformaat van de PDF
- Standaard: "A4"
- Opties: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - de richting van het PDF-document
- Standaard: "Portrait"
- Opties: "Portret", "Landschap"
cssMediaType - de CSS-mediatype van het PDF-document
- Standaard: "Screen"
- Opties: "Scherm", "Print"
includeLinks - waar als links in de PDF moeten worden opgenomen
- Standaard: waar
includeOutline - waar als PDF-bladwijzers moet worden opgenomen
- Standaard: false
title - geef een titel op voor het PDF-document
- Standaard: leeg
coverUrl - de URL van een webpagina die als voorblad voor de PDF moet worden gebruikt
- Standaard: leeg
marginTop - de marge in millimeter die bovenaan de PDF-documentpagina moet verschijnen
- Standaard: 10
marginLeft - de marge in millimeters die links van de PDF-documentpagina moet verschijnen
- Standaard: 10
marginBottom - de marge in millimeter die onderaan de PDF-documentpagina moet verschijnen
- Standaard: 10
marginRight - de marge in millimeters die rechts van het PDF-document moet verschijnen
- Standaard: 10
browserWidth - de breedte van de browser in pixels
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
- Standaard: 1366
- Maximaal: 10000
- Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het PDF-document)
pageWidth - de aangepaste breedte van de resulterende PDF in mm
- Standaard: paginaformaat Breedte
- Minimum: 15
pageHeight - de aangepaste hoogte van de resulterende PDF in mm
- Standaard: paginaformaat Hoogte
- Minimum: 15
delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
requestAs - het type user-agent dat u wilt gebruiken
- Standaard: 0
- Opties:
  - 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
  - 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
  - 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
templateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het PDF-document aangeeft
- Standaard: leeg
clickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
targetElement - de CSS-selector van de enige HTML-element op de doelpagina die moet worden omgedraaid intoa PDF, worden alle andere delen van de webpagina genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
- Standaard: leeg
hideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
- Standaard: leeg
waitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
- Standaard: leeg
customWaterMarkId - voeg een aangepast watermark naar elke pagina van het PDF-document
- Standaard: leeg
quality - de kwaliteit van de geretourneerde PDF. De standaard gebruikt de aanbevolen kwaliteit voor de PDF.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
noAds - als het waar is advertenties moeten automatisch worden verborgen.
- Standaard: false
noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
- Standaard: false
address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
- Standaard: leeg
post - definieert de HTTP Post-querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn. Als u deze optie gebruikt, wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- Standaard: leeg
templateVariables - definieert een aangepaste sjabloon parameter en waarde als een querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg
mergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe PDF-document
- Standaard: leeg
password - de wachtwoord om het PDF-document te beschermen met
- Standaard: leeg

Opties voorbeeld

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_docx(Url, opties)

Hiermee geeft u de URL op die moet worden geconverteerd intoa DOCX.

parameters

url - de URL die moet worden geconverteerd intoa DOCX
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

html_to_docx(Html, opties)

Hiermee geeft u de HTML op die moet worden geconverteerd intoa DOCX.

parameters

html - de HTML om te zetten intoa DOCX
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

file_to_docx(pad, opties)

Geeft een HTML-bestand aan dat moet worden geconverteerd intoa DOCX.

parameters

pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa DOCX
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

DOCX-opties

Alle beschikbare opties bij het maken van DOCX-opnames.

customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
- Standaard: leeg
includeBackground - indien waar, moeten de achtergrondafbeeldingen van de webpagina worden opgenomen in de DOCX
- Standaard: waar
pagesize - het paginaformaat van de DOCX
- Standaard: "A4"
- Opties: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - de richting van het DOCX-document
- Standaard: "Portrait"
- Opties: "Portret", "Landschap"
includeLinks - waar als links moeten worden opgenomen in de DOCX
- Standaard: waar
includeImages - indien waar, moeten de afbeeldingen van de webpagina worden opgenomen in de DOCX
- Standaard: waar
title - geef een titel op voor het DOCX-document
- Standaard: leeg
marginTop - de marge in millimeters die bovenaan de DOCX-documentpagina moet verschijnen
- Standaard: 10
marginLeft - de marge in millimeters die links van de DOCX-documentpagina moet verschijnen
- Standaard: 10
marginBottom - de marge in millimeter die onderaan de DOCX-documentpagina moet verschijnen
- Standaard: 10
marginRight - de marge in millimeter die rechts van het DOCX-document moet verschijnen
- Standaard: 10
browserWidth - de breedte van de browser in pixels
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
- Standaard: 1366
- Maximaal: 10000
- Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het DOCX-document)
pageWidth - de aangepaste breedte van de resulterende DOCX in mm
- Standaard: paginaformaat Breedte
- Minimum: 15
pageHeight - de aangepaste hoogte van de resulterende DOCX in mm
- Standaard: paginaformaat Hoogte
- Minimum: 15
delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
requestAs - het type user-agent dat u wilt gebruiken
- Standaard: 0
- Opties:
  - 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
  - 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
  - 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
templateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het DOCX-document aangeeft
- Standaard: leeg
clickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
targetElement - de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa DOCX, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
- Standaard: leeg
hideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
- Standaard: leeg
waitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
- Standaard: leeg
quality - de kwaliteit van de geretourneerde DOCX. De standaardkwaliteit van de afbeeldingen in de DOCX is 85%.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
noAds - als het waar is advertenties moeten automatisch worden verborgen.
- Standaard: false
noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
- Standaard: false
address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
- Standaard: leeg
post - definieert de HTTP Post-querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn. Als u deze optie gebruikt, wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- Standaard: leeg
templateVariables - definieert een aangepaste sjabloon parameter en waarde als een querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg
mergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe DOCX-document
- Standaard: leeg
password - de wachtwoord om het DOCX-document te beschermen met
- Standaard: leeg

Opties voorbeeld

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_table(Url, opties)

Hiermee geeft u de URL op waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

url - de URL om HTML-tabellen uit te extraheren
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

html_to_table(Html, opties)

Hiermee geeft u de HTML op waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

html - de HTML om HTML-tabellen uit te extraheren.
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

file_to_table(pad, opties)

Geeft een HTML-bestand aan waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

pad - het bestandspad van een HTML-bestand om HTML-tabellen uit te extraheren.
- Nodig
opties - een JSON-object dat speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

Tabel opties

Alle beschikbare opties bij het converteren van HTML-tabellen naar CSV, XLSX of JSON.

customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL
- Standaard: leeg
tableNumberToInclude - de index van de te converteren tabel, waarbij alle tabellen op een webpagina van boven naar beneden zijn geordend
- Standaard: 1
format - het formaat waarin de tabel moet zijn
- Standaard: "csv"
- Opties: "csv", "json", "xlsx"
includeHeaderNames - of echte kopnamen in de tabel worden opgenomen
- Standaard: waar
includeAllTables - indien waar, worden alle tabellen op de webpagina geëxtraheerd en wordt elke tabel weergegeven in een afzonderlijk spreadsheetblad. Alleen beschikbaar met het XLSX-formaat
- Standaard: false
targetElement - de id van het enige HTML-element op de webpagina dat moet worden gebruikt om tabellen uit te halen
- Standaard: leeg
requestAs - het type user-agent dat u wilt gebruiken
- Standaard: 0
- Opties:
  - 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
  - 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
  - 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: "SG", "UK", "US"
exportUrl - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
- Standaard: leeg
encryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
- Standaard: leeg
post - definieert de HTTP Post-querystring. Elke naam en waarde in de querystring moet URL-gecodeerd zijn. Als u deze optie gebruikt, wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- Standaard: leeg
address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
- Standaard: leeg
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
- Standaard: leeg

Opties voorbeeld

{
    'format':'xlsx',
    'includeHeaderNames':true
}

Het gebruik van de optie callBackUrl is de aanbevolen methode om een bestand op te slaan

save(callBackUrl, oncomplete)

Save het resultaat asynchroon en retourneert een unieke identificatie, die kan worden gebruikt om de screenshot met de te krijgen get_result methode.

parameters

callBackURL - de handler de GrabzIt-service moet bellen nadat deze zijn werk heeft voltooid
oncomplete (fout, id) - de callback-functie, die wordt aangeroepen wanneer de id van de screenshot wordt opgehaald.

save_to(saveToBestand, niet voltooid)

Save het resultaat synchroon zonder een callback-URL te gebruiken.

parameters

saveToBestand - het bestandspad dat wordt vastgelegd saved tot het eenmaal is voltooid
oncomplete (fout, gegevens) - de callback-functie, die wordt opgeroepen wanneer de screenshot is gedownload. De parameter data bevat de screenshotsbytes.

get_status(id, oncomplete)

Download de huidige status van een GrabzIt-schermafbeelding.

parameters

id - de unieke identificatie van de screenshot
- Nodig
onComplete (error, toestand) - de callback-functie, die wordt opgeroepen wanneer de screenshot-status is opgehaald.
- Nodig

get_cookies(domein, oncomplete)

Download alle cookies die GrabzIt voor een bepaald domein gebruikt. Dit kan ook door de gebruiker gedefinieerde cookies zijn.

parameters

domein - het domein waarvoor cookies worden geretourneerd
- Nodig
onComplete (error, cookies) - de callback-functie, die wordt opgeroepen wanneer de cookies zijn opgehaald.
- Nodig

set_cookie (naam, domein, opties, oncomplete)

Stelt een nieuwe aangepaste cookie in op GrabzIt, als de aangepaste cookie dezelfde naam en hetzelfde domein heeft als een globale cookie, wordt de globale cookie genegeerd.

Dit kan handig zijn als de functionaliteit van een website wordt beheerd door cookies.

parameters

naam - de naam van de cookie die moet worden ingesteld
- Nodig
domein - het domein van de website waarvoor de cookie wordt ingesteld
- Nodig
opties
- waarde - de waarde van de cookie
- pad - het websitepad waar de cookie betrekking op heeft
- httponly - indien waar, kan de cookie alleen worden gebruikt met het HTTP-protocol
- verloopt - bepaalt wanneer de cookie verloopt. Geef een nulwaarde door als de cookie niet vervalt
```
{
    'value':'me@example.com',
    'httponly':false
}
```
oncomplete (fout, succes) - de callback-functie, die wordt aangeroepen wanneer de cookie is ingesteld. De parameter succes is waar als de cookie succesvol is ingesteld, anders onwaar

delete_cookie (naam, domein, oncomplete)

Verwijder een aangepaste cookie of blokkeer het gebruik van een globale cookie

parameters

naam - de naam van de te verwijderen cookie
- Nodig
domein - het domein van de website waarvoor de cookie moet worden verwijderd
- Nodig
oncomplete (fout, succes) - de callback-functie, die wordt aangeroepen wanneer de cookie is ingesteld. De parameter succes is waar als de cookie is verwijderd, anders onwaar.

krijgen_watermarks()

Krijg al uw geüploade aangepaste watermarks

parameters

onComplete (error, watermarks) - de callback-functie, die wordt aangeroepen wanneer de watermarks zijn opgehaald. De watermark parameter bevat een array van watermarks.
- Nodig

krijgen_watermark(identificatie, onvolledig)

Retourneer uw aangepaste watermark die overeenkomt met de opgegeven identifier

parameters

identifier - de identifier van een bepaalde custom watermark je wilt bekijken
- Nodig
onComplete (error, watermarks) - de callback-functie, die wordt aangeroepen wanneer de watermark is opgehaald. De watermarks parameter bevat een watermark matrix.
- Nodig

toevoegen_watermark(identifier, pad, xpos, ypos, oncomplete)

Voeg een nieuwe gewoonte toe watermark

parameters

identifier - de identifier die u de custom watermark. Het is belangrijk dat deze identifier uniek is.
- Nodig
pad - het absolute pad van het watermark op uw server. Bijvoorbeeld C: /watermark/1.png
- Nodig
xpos - de horizontale positie waarop u de schermafbeelding wilt weergeven
- Nodig
- Opties:
  - Links = 0
  - Midden = 1
  - Rechts = 2
ypos - verticale positie waarin u de schermafbeelding wilt weergeven
- Nodig
- Opties:
  - Boven = 0
  - Midden = 1
  - Onder = 2
oncomplete (fout, succes) - de callback-functie, die wordt aangeroepen wanneer de watermark is toegevoegd. De parameter success is waar als het watermark is succesvol toegevoegd, anders false.
- Nodig

verwijderen_watermark(identificatie, onvolledig)

Verwijder een custom watermark

parameters

identifier - de identifier van het custom watermark u wilt verwijderen
- Nodig
oncomplete (fout, succes) - de callback-functie, die wordt aangeroepen wanneer de watermark is verwijderd. De parameter success is waar als het watermark is succesvol verwijderd.
- Nodig

set_local_proxy (value)

Met deze methode kan een lokale proxyserver te gebruiken voor alle verzoeken.

parameters

waarde - de URL, die indien nodig een poort kan bevatten, van de proxy. Als u een nul opgeeft, wordt alle eerder ingestelde proxy verwijderd
- Nodig

use_ssl (value)

Geeft aan of verzoeken aan GrabzIt's zijn API moet SSL gebruiken

parameters

waarde - indien true zullen alle verzoeken aan de API van GrabzIt SSL gebruiken
- Nodig

create_encryption_key ()

Maak een cryptografisch veilige basis 64-coderingssleutel, 44-tekens lang.

decoderen (data, sleutel)

Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.

parameters

pad - het pad van de gecodeerde opname
- Nodig
sleutel - de coderingssleutel
- Nodig

decrypt_file (pad, sleutel, oncomplete)

Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.

parameters

pad - het pad van de gecodeerde opname
- Nodig
sleutel - de coderingssleutel
- Nodig
oncomplete (fout) - de callback-functie, die wordt aangeroepen wanneer het bestand wordt gedecodeerd.

Resultaatklassen

Cookiebleid

Publieke variabelen

naam - de cookienaam
waarde - de cookiewaarde
domein - het domein waarvoor de cookie is ingesteld
pad - het pad op het domein waarop deze cookie van toepassing is.
httponly - als deze cookie alleen geldig is wanneer de website wordt bekeken met het HTTP-protocol.
verloopt - de datum waarop deze cookie verloopt
type - het type cookie dat dit is
- Opties:
  - Wereldwijd - dit is een wereldwijd cookie ingesteld door GrabzIt
  - Lokaal - dit is een door u ingesteld lokaal cookie
  - Overschreven - een globale cookie die door u is overschreven

Status

De klasse die de huidige status van de schermafbeelding weergeeft.

Publieke variabelen

verwerking - indien waar wordt de screenshot nog steeds verwerkt.
in de cache - indien waar is de screenshot is verwerkt en wordt deze in de cache opgeslagen.
verlopen - indien waar is de screenshot niet langer op het GrabzIt-systeem.
bericht - een foutmelding geretourneerd door het systeem.

WaterMark

Deze klasse vertegenwoordigt de gewoonte watermarks opgeslagen in GrabzIt

Publieke variabelen

identifier - de identifier van het watermark
format - het formaat van het watermark beeld
xPosition - de x-positie die de watermark verschijnt op op de schermafbeelding
- Opties:
  - Links = 0
  - Midden = 1
  - Rechts = 2
yPosition - de y-positie die de watermark verschijnt op op de schermafbeelding
- Opties:
  - Boven = 0
  - Midden = 1
  - Onder = 2