GrabzIt Client avec Node.js

Description

Cette classe gère toutes les communications avec les services Web de capture d’écran GrabzIt.

Méthodes publiques

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)

Cette méthode renvoie la capture d'écran elle-même. Si rien n'est renvoyé, alors quelque chose s'est mal passé ou la capture d'écran n'est pas encore prête.

Paramètres

id - l'identifiant unique de la capture d'écran
- Requis

url_to_animation(url, Options)

Spécifiez l'URL de la vidéo en ligne à convertir into un GIF animé.

Paramètres

url - l'URL de la vidéo en ligne à convertir into un GIF animé
- Requis
- Accepte les URL de vidéos Vimeo et YouTube
  - Avertissement L'animation de vidéos Vimeo et YouTube dépend d'un tiers et peut donc ne pas fournir des résultats cohérents.
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création du fichier GIF animé.

Valeur de retour

annuler

Options d'animation

Toutes les options disponibles lors de la création d'un fichier GIF animé.

customId - identificateur personnalisé que vous pouvez transmettre au service Web GIF animé. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
- Par défaut: vide
width - la largeur du GIF animé obtenu en pixels.
- Par défaut: 180px
- Maximum: Largeur maximale pour le colis
- Taille automatique: -1 (passage -1 signifie que la largeur de la le GIF animé est mis à l'échelle par rapport à sa hauteur, si la largeur est auto-dimensionnée, la hauteur ne peut pas)
height - la hauteur du GIF animé obtenu en pixels.
- Par défaut: 120px
- Maximum: hauteur maximale pour le colis
- Taille automatique: -1 (passage -1 signifie que la hauteur de la le GIF animé est mis à l'échelle par rapport à sa largeur, si la hauteur est automatiquement dimensionnée, la largeur ne peut pas)
start - la position de départ de la vidéo à convertir into un GIF animé.
- Par défaut: secondes 0
duration - la durée en secondes de la vidéo à convertir into un GIF animé.
- Valeur par défaut: longueur maximale du paquet
speed - la vitesse du GIF animé.
- Par défaut: 1
- Minimum: 0.2
- Maximum: 10
framesPerSecond - le nombre d'images par seconde devant être capturées à partir de la vidéo.
- Par défaut: 10
- Minimum: 0.2
- Maximum: 60
repeat - nombre de fois pour boucler le GIF animé.
- Par défaut: 0
- Boucle en continu: 0
- Ne jamais boucler : -1
reverse - si vrai, les images du GIF animé sont inversées
- Par défaut: false
customWaterMarkId - ajouter personnalisé watermark au GIF animé
- Par défaut: vide
quality - la qualité de l'image retournée, qui a une compression par défaut de 85%.
- Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
- Par défaut: -1
- Minimum: -1
- Maximum: 100
country - le pays le GIF animé doit provenir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide

Exemple d'options

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

url_to_image(url, Options)

Spécifie l'URL à convertir into une image capture d'écran.

Paramètres

url - l'URL de la capture d'écran
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création de la capture d'écran.

Valeur de retour

annuler

html_to_image(html, Options)

Spécifie le HTML à convertir into une image.

Paramètres

html - le HTML à convertir into une image
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'une image.

Valeur de retour

annuler

file_to_image(chemin, Options)

Spécifie un fichier HTML à convertir into une image.

Paramètres

chemin - le chemin du fichier HTML à convertir into une image
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'une image.

Valeur de retour

annuler

Options d'image

Toutes les options disponibles lors de la création de captures d'image.

customId - identifiant personnalisé que vous pouvez transmettre au service Web de capture d'écran. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
- Par défaut: vide
browserWidth - la largeur du navigateur en pixels
- Par défaut: 1366
- Maximum: 10000
browserHeight - la hauteur du navigateur en pixels
- Par défaut: 1170
- Maximum: 10000
- Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
width - la largeur de la vignette obtenue en pixels
- Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la hauteur de sortie est spécifiée, la largeur de sortie sera proportionnelle à la hauteur de sortie
- Maximum: Largeur maximale pour le colis
- Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
height - la hauteur de la vignette obtenue en mm
- Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la largeur de sortie est spécifiée, la hauteur de sortie sera proportionnelle à la largeur de sortie
- Maximum: hauteur maximale pour le colis
- Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
format - le format de la capture d'écran doit être.
- Par défaut: "jpg"
- Options: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
- Par défaut: 0
- Maximum: 30000
clickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
targetElement - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une capture d’écran, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
- Par défaut: vide
hideElement - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
- Par défaut: vide
waitForElement - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
- Par défaut: vide
requestAs - le type d'agent utilisateur que vous souhaitez utiliser
- Par défaut: 0
- options:
  - 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
  - 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
  - 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
customWaterMarkId - ajouter une personnalisation watermark à l'image
- Par défaut: vide
quality - la qualité de l'image retournée. Actuellement, cela affecte uniquement les images JPG et WEBP, qui ont une compression par défaut de 90%.
- Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
- Par défaut: -1
- Minimum: -1
- Maximum: 100
transparent - si c'est vrai le la capture d'image doit être transparente. Ceci est uniquement compatible avec les images png et tiff.
- Par défaut: false
hd - si vrai l'image capture sera en haute définition cela double la taille des dimensions de l'image.
- Par défaut: false
country - le pays la capture d'écran doit être prise à partir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
noAds - si vrai les annonces doivent être automatiquement masquées.
- Par défaut: false
noCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
- Par défaut: false
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
- Par défaut: vide
post - définit la requête HTTP Poststring. Chaque nom et valeur dans la requêtestring devra être encodé en URL. Utiliser cette option forcera GrabzIt à effectuer un post HTTP.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide

Exemple d'options

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

url_to_rendered_html(url, Options)

Spécifie l'URL à convertir into rendu HTML.

Paramètres

url - l'URL dont le HTML rendu devrait être composé
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création du code HTML rendu.

Valeur de retour

annuler

html_to_rendered_html(html, Options)

Spécifie le HTML à convertir into rendu HTML.

Paramètres

html - le HTML à convertir into rendu HTML
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un code HTML rendu.

Valeur de retour

annuler

file_to_rendered_html(chemin, Options)

Spécifie un fichier HTML à convertir into rendu HTML.

Paramètres

chemin - le chemin du fichier HTML à convertir into rendu HTML
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un code HTML rendu.

Valeur de retour

annuler

Options HTML

Toutes les options disponibles lorsque création de captures HTML rendues.

customId - identifiant personnalisé que vous pouvez transmettre au service Web. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
- Par défaut: vide
browserWidth - la largeur du navigateur en pixels
- Par défaut: 1366
- Maximum: 10000
browserHeight - la hauteur du navigateur en pixels
- Par défaut: 1170
- Maximum: 10000
delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
- Par défaut: 0
- Maximum: 30000
clickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
waitForElement - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
- Par défaut: vide
requestAs - le type d'agent utilisateur que vous souhaitez utiliser
- Par défaut: 0
- options:
  - 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
  - 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
  - 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
country - le pays la capture d'écran doit être prise à partir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
noAds - si vrai les annonces doivent être automatiquement masquées.
- Par défaut: false
noCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
- Par défaut: false
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
- Par défaut: vide
post - définit la requête HTTP Poststring. Chaque nom et valeur dans la requêtestring devra être encodé en URL. Utiliser cette option forcera GrabzIt à effectuer un post HTTP.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide

Exemple d'options

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

url_to_pdf(url, Options)

Spécifie l'URL à convertir into un PDF.

Paramètres

url - l'URL à convertir into un PDF
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

html_to_pdf(html, Options)

Spécifie le HTML à convertir into un PDF.

Paramètres

html - le HTML à convertir into un PDF
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

file_to_pdf(chemin, Options)

Spécifie un fichier HTML à convertir into un PDF.

Paramètres

chemin - le chemin du fichier HTML à convertir into un PDF
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

Options PDF

Toutes les options disponibles lors de la création de captures PDF.

customId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
- Par défaut: vide
includeBackground - si vrai, l'arrière-plan de la page Web devrait être inclus dans la capture d'écran
- Par défaut: true

pagesize - la taille de la page du PDF
- Par défaut: "A4"
- Options: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Juridique", "Lettre"
orientation - l'orientation du document PDF
- Par défaut: "Portrait"
- Options: "Portrait", "Paysage"
cssMediaType - la Type de média CSS du document PDF
- Écran par défaut"
- Options: "Écran", "Print"
includeLinks - vrai si les liens doivent être inclus dans le PDF
- Par défaut: true
includeOutline - vrai si Signets PDF devrait être inclus
- Par défaut: false
title - donner un titre au document PDF
- Par défaut: vide
coverUrl - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
- Par défaut: vide
marginTop - la marge en millimètres devant apparaître en haut de la page du document PDF
- Par défaut: 10
marginLeft - la marge en millimètres devant apparaître à gauche de la page du document PDF
- Par défaut: 10
marginBottom - la marge en millimètres qui devrait apparaître au bas de la page du document PDF
- Par défaut: 10
marginRight - la marge en millimètres devant apparaître à droite du document PDF
- Par défaut: 10
browserWidth - la largeur du navigateur en pixels
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
- Par défaut: 1366
- Maximum: 10000
- Largeur automatique: -1 (passant -1 signifie que la largeur du navigateur correspond à la largeur du document PDF)
pageWidth - la largeur personnalisée du PDF résultant en mm
- Valeur par défaut: taille de la page largeur
- Minimum: 15
pageHeight - la hauteur personnalisée du PDF résultant en mm
- Valeur par défaut: taille de la page la taille
- Minimum: 15
delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
- Par défaut: 0
- Maximum: 30000
requestAs - le type d'agent utilisateur que vous souhaitez utiliser
- Par défaut: 0
- options:
  - 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
  - 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
  - 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
templateId - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document PDF
- Par défaut: vide
clickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
targetElement - la Sélecteur CSS du seul Élément HTML sur la page Web cible à tourner into un PDF, toutes les autres parties de la page Web sont ignorées. S'il y a plusieurs éléments HTML correspondants, le premier est choisi
- Par défaut: vide
hideElement - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
- Par défaut: vide
waitForElement - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
- Par défaut: vide
customWaterMarkId - ajouter une personnalisation watermark à chaque page du document PDF
- Par défaut: vide
quality - la qualité du PDF retourné. La valeur par défaut utilise la qualité recommandée pour le PDF.
- Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
- Par défaut: -1
- Minimum: -1
- Maximum: 100
country - le pays la capture d'écran doit être prise à partir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
noAds - si vrai les annonces doivent être automatiquement masquées.
- Par défaut: false
noCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
- Par défaut: false
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
- Par défaut: vide
post - définit la requête HTTP Poststring. Chaque nom et valeur dans la requêtestring devra être encodé en URL. Utiliser cette option forcera GrabzIt à effectuer un post HTTP.
- Par défaut: vide
templateVariables - définit un modèle personnalisé paramètre et valeur en tant que requêtestring. Chaque nom et valeur dans la requêtestring devra être encodé en URL.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide
mergeId - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document PDF
- Par défaut: vide
password - la mot de passe pour protéger le document PDF avec
- Par défaut: vide

Exemple d'options

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

url_to_docx(url, Options)

Spécifie l'URL à convertir into un DOCX.

Paramètres

url - l'URL à convertir into un DOCX
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

html_to_docx(html, Options)

Spécifie le HTML à convertir into un DOCX.

Paramètres

html - le HTML à convertir into un DOCX
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

file_to_docx(chemin, Options)

Spécifie un fichier HTML à convertir into un DOCX.

Paramètres

chemin - le chemin du fichier HTML à convertir into un DOCX
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

Options DOCX

Toutes les options disponibles lors de la création de captures DOCX.

customId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
- Par défaut: vide
includeBackground - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
- Par défaut: true
pagesize - la taille de la page du DOCX
- Par défaut: "A4"
- Options: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Juridique", "Lettre"
orientation - l'orientation du document DOCX
- Par défaut: "Portrait"
- Options: "Portrait", "Paysage"
includeLinks - vrai si les liens doivent être inclus dans le DOCX
- Par défaut: true
includeImages - si vrai, les images de la page Web doivent être incluses dans le fichier DOCX
- Par défaut: true
title - donner un titre au document DOCX
- Par défaut: vide
marginTop - la marge en millimètres devant apparaître en haut de la page du document DOCX
- Par défaut: 10
marginLeft - la marge en millimètres devant apparaître à gauche de la page du document DOCX
- Par défaut: 10
marginBottom - la marge en millimètres devant apparaître au bas de la page du document DOCX
- Par défaut: 10
marginRight - la marge en millimètres devant figurer à droite du document DOCX
- Par défaut: 10
browserWidth - la largeur du navigateur en pixels
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
- Par défaut: 1366
- Maximum: 10000
- Largeur automatique: -1 (passer -1 signifie que la largeur du navigateur correspond à la largeur du document DOCX)
pageWidth - la largeur personnalisée du DOCX résultant en mm
- Valeur par défaut: taille de la page largeur
- Minimum: 15
pageHeight - la hauteur personnalisée du DOCX résultant en mm
- Valeur par défaut: taille de la page la taille
- Minimum: 15
delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
- Par défaut: 0
- Maximum: 30000
requestAs - le type d'agent utilisateur que vous souhaitez utiliser
- Par défaut: 0
- options:
  - 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
  - 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
  - 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
templateId - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document DOCX
- Par défaut: vide
clickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
- Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
targetElement - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into DOCX, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
- Par défaut: vide
hideElement - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
- Par défaut: vide
waitForElement - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
- Par défaut: vide
quality - la qualité du DOCX retourné. La qualité par défaut des images dans le fichier DOCX est 85%.
- Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
- Par défaut: -1
- Minimum: -1
- Maximum: 100
country - le pays la capture d'écran doit être prise à partir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
noAds - si vrai les annonces doivent être automatiquement masquées.
- Par défaut: false
noCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
- Par défaut: false
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
- Par défaut: vide
post - définit la requête HTTP Poststring. Chaque nom et valeur dans la requêtestring devra être encodé en URL. Utiliser cette option forcera GrabzIt à effectuer un post HTTP.
- Par défaut: vide
templateVariables - définit un modèle personnalisé paramètre et valeur en tant que requêtestring. Chaque nom et valeur dans la requêtestring devra être encodé en URL.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide
mergeId - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document DOCX
- Par défaut: vide
password - la mot de passe pour protéger le document DOCX avec
- Par défaut: vide

Exemple d'options

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

url_to_table(url, Options)

Spécifie l'URL à partir de laquelle les tables HTML doivent être extraites.

Paramètres

url - l'URL à partir de laquelle extraire les tables HTML
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

html_to_table(html, Options)

Spécifie le HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

html - HTML pour extraire les tables HTML.
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

file_to_table(chemin, Options)

Spécifie un fichier HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

chemin - le chemin du fichier HTML à partir duquel extraire les tableaux HTML.
- Requis
Options - un objet JSON qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

Options de table

Toutes les options disponibles lors de la conversion de tableaux HTML en fichiers CSV, XLSX ou JSON.

customId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée
- Par défaut: vide
tableNumberToInclude - l'index de la table à convertir, si toutes les tables d'une page Web sont ordonnées du haut de la page Web vers le bas
- Par défaut: 1
format - le format dans lequel le tableau doit être
- Par défaut: "csv"
- Options: "csv", "json", "xlsx"
includeHeaderNames - si de vrais noms d'en-tête seront inclus dans la table
- Par défaut: true
includeAllTables - Si vrai, tous les tableaux de la page Web seront extraits, chaque tableau apparaissant dans une feuille de calcul distincte. Disponible uniquement avec le format XLSX
- Par défaut: false
targetElement - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
- Par défaut: vide
requestAs - le type d'agent utilisateur que vous souhaitez utiliser
- Par défaut: 0
- options:
  - 0 = indique que l'agent utilisateur d'un navigateur standard doit être utilisé
  - 1 = indique que l'agent utilisateur d'un navigateur mobile doit être utilisé
  - 2 = indique que l'agent utilisateur d'un moteur de recherche doit être utilisé
country - le pays la capture d'écran doit être prise à partir de.
- Par défaut: l'emplacement le plus rapide actuel
- Options: "SG", "UK", "US"
exportUrl - la URL d'exportation qui spécifie également où la capture doit être exportée
- Par défaut: vide
encryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
- Par défaut: vide
post - définit la requête HTTP Poststring. Chaque nom et valeur dans la requêtestring devra être encodé en URL. Utiliser cette option forcera GrabzIt à effectuer un post HTTP.
- Par défaut: vide
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
- Par défaut: vide
proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
- Par défaut: vide

Exemple d'options

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

L'utilisation de l'option callBackUrl est la méthode recommandée pour enregistrer un fichier.

save(callBackUrl, oncomplete)

Save le résultat de manière asynchrone et renvoie un identifiant unique, qui peut être utilisé pour obtenir la capture d'écran avec le get_result méthode.

Paramètres

callBackURL - le maître le service GrabzIt doit appeler après avoir terminé son travail
oncomplete (error, id) - la fonction de rappel, appelée lorsque l'identifiant de la capture d'écran est récupéré.

save_to(saveToFichier, une fois terminé)

Save le résultat de manière synchrone sans utiliser d'URL de rappel.

Paramètres

saveToFichier - le chemin du fichier qui sera capturé saved à une fois qu'il a été complété
oncomplete (error, data) - la fonction de rappel, appelée lorsque la capture d'écran a été téléchargée. Le paramètre data contient les octets de screenshots.

get_status(id, oncomplete)

Obtenir le statut actuel d'une capture d'écran GrabzIt.

Paramètres

id - l'identifiant unique de la capture d'écran
- Requis
oncomplete (erreur, Commande) - la fonction de rappel, appelée lorsque l'état de la capture d'écran a été récupéré.
- Requis

get_cookies(domaine, oncomplete)

Obtenez tous les cookies que GrabzIt utilise pour un domaine particulier. Cela peut également inclure les cookies définis par l'utilisateur.

Paramètres

domain - le domaine pour lequel les cookies sont renvoyés
- Requis
oncomplete (erreur, biscuits) - la fonction de rappel, appelée lorsque les cookies ont été récupérés.
- Requis

set_cookie (nom, domaine, options, oncomplete)

Définit un nouveau cookie personnalisé sur GrabzIt. Si le cookie personnalisé porte le même nom et le même domaine qu'un cookie global, le cookie global est remplacé.

Cela peut être utile si une fonctionnalité de site Web est contrôlée par des cookies.

Paramètres

name - le nom du cookie à définir
- Requis
domain - le domaine du site Web pour définir le cookie pour
- Requis
Options
- valeur - la valeur du cookie
- chemin - le chemin du site auquel le cookie se rapporte
- httponly - si vrai, le cookie ne peut être utilisé qu'avec le protocole HTTP
- expires - définit quand le cookie expire. Passer une valeur nulle si le cookie ne doit pas expirer
```
{
    'value':'me@example.com',
    'httponly':false
}
```
oncomplete (error, success) - la fonction de rappel, appelée lorsque le cookie a été défini. Le paramètre success est true si le cookie est correctement défini. Sinon, false

delete_cookie (nom, domaine, à compléter)

Supprimer un cookie personnalisé ou bloquer l'utilisation d'un cookie global

Paramètres

name - le nom du cookie à supprimer
- Requis
domain - le domaine du site Web pour supprimer le cookie pour
- Requis
oncomplete (error, success) - la fonction de rappel, appelée lorsque le cookie a été défini. Le paramètre success est true si le cookie est supprimé, sinon false.

avoir_watermarks()

Obtenez toute votre personnalisation téléchargée watermarks

Paramètres

oncomplete (erreur, watermarks) - la fonction de rappel, qui est appelée lorsque le watermarks ont été récupérés. le watermark paramètre contient un tableau de watermarks.
- Requis

avoir_watermark(identifiant, incomplet)

Renvoyez votre coutume watermark qui correspond à l'identifiant spécifié

Paramètres

identifier - l'identifiant d'une coutume particulière watermark tu veux voir
- Requis
oncomplete (erreur, watermarks) - la fonction de rappel, qui est appelée lorsque le watermark a été récupéré. le watermarks le paramètre contient un watermark Tableau.
- Requis

ajouter_watermark(identifiant, chemin, xpos, ypos, une fois terminé)

Ajouter une nouvelle personnalisation watermark

Paramètres

identifiant - l'identifiant que vous souhaitez donner à la personnalisation watermark. Il est important que cet identifiant soit unique.
- Requis
chemin - le chemin absolu du watermark sur votre serveur. Par exemple C: /watermark/1.png
- Requis
xpos - la position horizontale dans laquelle vous voulez que la capture d'écran apparaisse
- Requis
- options:
  - Gauche = 0
  - Centre = 1
  - Droite = 2
ypos - position verticale sur laquelle vous voulez que la capture d'écran apparaisse
- Requis
- options:
  - Top = 0
  - Milieu = 1
  - Bas = 2
oncomplete (erreur, succès) - la fonction de rappel, qui est appelée lorsque le watermark a été ajouté. Le paramètre success est vrai si le watermark a été ajouté avec succès, sinon faux.
- Requis

effacer_watermark(identifiant, incomplet)

Supprimer une personnalisation watermark

Paramètres

identifier - l'identifiant de la coutume watermark tu veux supprimer
- Requis
oncomplete (erreur, succès) - la fonction de rappel, qui est appelée lorsque le watermark a été retiré. Le paramètre success est vrai si le watermark a été supprimé avec succès.
- Requis

set_local_proxy (valeur)

Cette méthode permet une serveur proxy local à utiliser pour toutes les demandes.

Paramètres

valeur - l'URL, qui peut inclure un port si nécessaire, du proxy. Fournir une valeur nulle supprimera tout proxy précédemment défini
- Requis

use_ssl (valeur)

Spécifie si les demandes à GrabzIt API devrait utiliser SSL

Paramètres

valeur - si vrai, toutes les demandes adressées à l'API de GrabzIt utiliseront SSL
- Requis

create_encryption_key ()

Créez une clé de chiffrement 64 de base sécurisée sur le plan cryptographique, longue de caractères 44.

déchiffrer (données, clé)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

chemin - le chemin de la capture cryptée
- Requis
clé - la clé de chiffrement
- Requis

decrypt_file (chemin, clé, oncomplete)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

chemin - le chemin de la capture cryptée
- Requis
clé - la clé de chiffrement
- Requis
oncomplete (error) - la fonction de rappel appelée lorsque le fichier est déchiffré.

Classes de résultat

Biscuits

Variables publiques

name - le nom du cookie
valeur - la valeur du cookie
domain - le domaine pour lequel le cookie est défini
chemin - le chemin sur le domaine auquel ce cookie s'applique.
httponly - si ce cookie n'est valide que lorsque le site Web est visualisé avec le protocole HTTP.
expire - la date d'expiration de ce cookie
type - le type de cookie c'est
- options:
  - Global - il s'agit d'un cookie global défini par GrabzIt
  - Local - il s'agit d'un cookie local défini par vous
  - Overridden - un cookie global que vous avez remplacé

Statut

La classe représentant le statut actuel de la capture d'écran.

Variables publiques

processing - si true, la capture d’écran est toujours en cours de traitement.
mis en cache - si vrai, la capture d'écran a été traitée et est actuellement mise en cache.
expired - si true, la capture d'écran n'est plus sur le système GrabzIt.
message - un message d'erreur renvoyé par le système.

WaterMark

Cette classe représente la coutume watermarks stocké dans GrabzIt

Variables publiques

identifiant - l'identifiant du watermark
format - le format du watermark image
xPosition - la position x que le watermark apparaît à sur la capture d'écran
- options:
  - Gauche = 0
  - Centre = 1
  - Droite = 2
yPosition - la position y que le watermark apparaît à sur la capture d'écran
- options:
  - Top = 0
  - Milieu = 1
  - Bas = 2