Paramètres d'API JavaScript de GrabzIt

L’API JavaScript GrabzIt vous permet de: personnaliser vos captures d'écran et capture en spécifiant différents paramètres. Sélectionnez simplement ce que vous voulez faire dans le filtre ci-dessous et les paramètres disponibles seront affichés.

• format - le format dans lequel la capture d'écran / capture doit être.
  • Par défaut: jpg
  • options:
    • bmp8
    • bmp16
    • bmp24
    • bmp
    • csv
      • Les fichiers CSV sont automatiquement téléchargés.
    • gif
    • html
      • Les fichiers HTML sont automatiquement téléchargés.
    • jpg
    • json
      • Les fichiers JSON sont automatiquement téléchargés.
    • pdf
      • Les fichiers PDF sont automatiquement téléchargés.
    • docx
      • Les fichiers DOCX sont automatiquement téléchargés.
    • png
    • querelle
    • webp
    • XLSX
      • Les fichiers XLSX sont automatiquement téléchargés.
• address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise des URL relatives vers des ressources telles que CSS et des images.
  • Par défaut: vide
• background - si vrai, l'arrière-plan de la page Web devrait être inclus dans le PDF
  • Par défaut: 1
  • options:
    • 0 = indique que le document PDF ne doit pas inclure l'arrière-plan de la page Web
    • 1 = indique que le document PDF doit inclure l'arrière-plan de la page Web.
• background - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: 1
  • options:
    • 0 = indique que le document DOCX ne doit pas inclure les images d'arrière-plan de la page Web
    • 1 = indique que le document DOCX doit inclure les images d'arrière-plan de la page Web.
• bwidth - 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: 1024
  • Maximum: 10000
  • Largeur automatique: -1 (passant -1 signifie que le largeur du navigateur correspond à la largeur du document)
• bheight - la hauteur du navigateur en pixels.
  • Par défaut: 768
  • Maximum: 10000
  • Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
• cache - ce paramètre spécifie si la capture d'écran / capture doit être mise en cache ou non
  • Par défaut: 1
  • options:
    • 0 = indique qu'il le fera ne sont pas être caché
    • 1 = indique qu'il sera mis en cache
• cachelength - ce paramètre spécifie la durée pendant laquelle une capture d'écran / capture doit être mise en cache en minutes
  • Valeur par défaut: longueur du cache du compte si défini, ou longueur du cache du paquet
  • Minimum: 15
  • Maximum: longueur maximale du cache pour votre paquet
• country - le pays la capture d'écran / capture doit être prise à partir.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • Options: "SG", "UK", "US"
• coverurl - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
  • Par défaut: vide
• customwatermarkid - ajouter un filigrane personnalisé au fichier
  • Par défaut: vide
• delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• displayclass - ajoutez ceci en tant que attribut de classe à l'image de capture / capture
  • Par défaut: vide
• displayid - ajoutez ceci en tant que attribut id à l'image de capture / capture
  • Par défaut: vide
• download - Ce paramètre spécifie si la capture doit être téléchargée ou affichée dans la page Web.
  • Par défaut: 0
  • options:
    • 0 = indique que la capture sera affichée dans la page Web
    • 1 = indique que la capture sera automatiquement téléchargée
• durée - la durée en secondes de la vidéo à convertir into un GIF animé.
  • Valeur par défaut: longueur maximale du paquet
• encryption - la clé de chiffrement à utiliser pour chiffrer la capture. Si vous créez la clé en JavaScript, il est recommandé d’utiliser le méthode de chiffrement comme indiqué dans cet exemple.
• errorid - ajoutez ceci en tant que attribut id au message d'erreur élément span
  • Par défaut: vide
• errorclass - ajoutez ceci en tant que attribut de classe au message d'erreur élément span
  • Par défaut: vide
• export - la URL d'exportation qui spécifie également où la capture doit être exportée.
• filename - écraser le nom du fichier téléchargé
  • Valable uniquement lorsque la capture d'écran / capture est en cours de téléchargement
  • Par défaut: vide
• fps - le nombre d'images par seconde devant être capturées à partir de la vidéo.
  • Par défaut: 10
  • Minimum: 0.2
  • Maximum: 60
• hd - si vrai l'image capture sera en haute définition cela double la taille des dimensions de l'image.
  • Par défaut: 0
  • options:
    • 0 = créer une image haute définition
    • 1 = créer une image haute définition
• height - la hauteur de la vignette obtenue en pixels
  • Valeur par défaut: le ratio le plus élevé possible entre la hauteur du navigateur et celle qui convient à l'utilisateur.
  • Maximum: hauteur maximale pour le colis
  • Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
• height - la hauteur personnalisée du document résultant en mm
  • Valeur par défaut: taille de la page la taille
  • Minimum: 15
• la taille - 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)
• hide - l'identifiant ou la classe Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, pour spécifier plusieurs éléments HTML à masquer, séparez chaque sélecteur par une virgule.
  • Par défaut: vide
• 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: 0
  • options:
    • 0 = indique que toutes les tables ne seront pas extraites
    • 1 = indique que toutes les tables seront extraites
• includeheadernames - si de vrais noms d'en-tête seront inclus dans la table
  • Par défaut: 1
  • options:
    • 0 = indique que les noms d'en-tête ne seront pas inclus dans la table
    • 1 = indique que les noms d'en-tête seront inclus dans la table
• includeimages - si vrai, les images de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: 1
  • options:
    • 0 = indique que le document DOCX n'inclura pas d'images de page Web
    • 1 = indique que le document DOCX inclura des images de page Web
• includelinks - vrai si des liens doivent être inclus dans le document
  • Par défaut: 1
  • options:
    • 0 = indique que le document ne doit pas inclure de liens
    • 1 = indique que le document doit inclure des liens
• includeoutline - vrai si Signets PDF devrait être inclus
  • Par défaut: 0
  • options:
    • 0 = indique que le document PDF n'inclura pas de contour
    • 1 = indique que le document PDF comprendra un contour
• mergeid - ajouter l'ID d'une capture qui devrait être fusionné au début du nouveau document
  • Par défaut: vide
• mtop - la marge en millimètres qui devrait apparaître en haut de la page du document
  • Par défaut: 10
• mleft - la marge en millimètres devant apparaître à gauche de la page du document
  • Par défaut: 10
• mbottom - la marge en millimètres qui devrait apparaître au bas de la page du document
  • Par défaut: 10
• mright - la marge en millimètres devant apparaître à droite du document PDF
  • Par défaut: 10
• media - la Type de média CSS du document PDF
  • Par défaut: Print
  • options:
    • Imprimé
    • PARAVENT
• noads - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: 0
  • options:
    • 0 = afficher des publicités
    • 1 = masquer les publicités
• nonotify - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: 0
  • options:
    • 0 = afficher les notifications de cookies
    • 1 = masquer les notifications de cookies
• onerror - la fonction à appeler en cas d'erreur ou le nom de la fonction.
  • Par défaut: vide
• onfinish - la fonction qui devrait être appelée après le chargement de la capture d'écran ou le nom de la fonction.
  • Par défaut: vide
• onstart - la fonction à appeler lorsque le téléchargement de la capture d'écran commence ou le nom de la fonction.
  • Par défaut: vide
• orientation - l'orientation du document
  • Par défaut: Portrait
  • options:
    • Portrait
    • paysage
• pagesize - la taille de la page du document
  • Par défaut: A4
  • options:
    • A3
    • A4
    • A5
    • A6
    • B3
    • B4
    • B5
    • B6
    • Mentions légales
    • Lettre
• password - la mot de passe pour protéger le document avec
  • Par défaut: vide
• proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
• post - les paramètres de publication que vous souhaitez envoyer. Il est recommandé d’utiliser le Méthode AddPostVariable à la place, cela garantit que les paramètres sont correctement codés.
• quality - la qualité de la capture, JPG et GIF ont une compression par défaut de 85% et WEBP 80%. Ce paramètre n'a aucun effet sur les images BMP, PNG ou TIFF.
  • 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
• répéter - nombre de fois pour boucler le GIF animé.
  • Par défaut: 0
  • Boucle en continu: 0
• inverser - si vrai, les images du GIF animé sont inversées
  • Par défaut: 0
  • options:
    • 0 = indique que l'animation ne sera pas respectée
    • 1 = indique que l'animation sera inversée
• requestas - le type d'agent utilisateur que vous souhaitez utiliser
  • Par défaut: 0
  • options:
    • 0 = indique que la version standard du site Web doit être renvoyée
    • 1 = indique le version mobile d'un site doit être rendu
    • 2 = indique que la vue du moteur de recherche d'un site Web doit être renvoyée
    • 3 = indique que la version de secours d'un site Web doit être renvoyée à l'aide d'un agent utilisateur d'un navigateur de base
• vitesse - la vitesse du GIF animé.
  • Par défaut: 1
  • Minimum: 0.2
  • Maximum: 10
• Démarrer - la position de départ de la vidéo à convertir into un GIF animé.
  • Par défaut: secondes 0
• suppresserrors - supprime le signalement des erreurs
  • Valide uniquement lorsque le résultat de la capture d'écran est en cours de téléchargement
  • Par défaut: 0
  • options:
    • 0 = affiche les erreurs éventuelles
    • 1 = cache toutes les erreurs
• tabletoinclude - 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
• target - ce paramètre spécifie l'id ou la classe Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into un document, 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
• target - ce paramètre spécifie le identifiant ou classe Sélecteur CSS du seul élément HTML sur la page Web cible à activer into une image, 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
• target - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
  • Par défaut: vide
• 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: 0
  • options:
    • 0 = créer une image non transparente
    • 1 = créer une image transparente
• templateid - ajouter un modèle ID qui spécifie l'en-tête et le pied de page du document
  • Par défaut: vide
• title - donner un titre au document PDF
  • Par défaut: vide
• waitfor - cela spécifie l'id ou la classe d'un élément HTML, en utilisant un Sélecteur CSS. Une fois que l'élément est visible la capture est exécutée. S'il existe plusieurs éléments HTML correspondants, le premier est choisi. Lorsque ce paramètre est utilisé, il attend un maximum de 25 secondes avant que la capture ne soit effectuée.
• width - la largeur de la vignette obtenue en pixels
  • Valeur par défaut: le rapport le plus élevé possible entre la largeur du navigateur et la largeur maximale autorisée pour le package des utilisateurs.
  • Maximum: Largeur maximale pour le colis
  • Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
• width - la largeur personnalisée du document résultant en mm
  • Valeur par défaut: taille de la page largeur
  • Minimum: 15
• largeur - 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)