Cliente GrabzIt com Node.js

Descrição

Esta classe lida com toda a comunicação com os serviços da Web de captura de tela GrabzIt.

Métodos públicos

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)

Este método retorna a própria captura de tela. Se nada for retornado, algo deu errado ou a captura de tela ainda não está pronta.

parâmetros

id - o identificador exclusivo da captura de tela
- Exigido

url_to_animation(url, opções)

Especifique o URL do vídeo online que deve ser convertido intum GIF animado.

parâmetros

url - o URL do vídeo online a ser convertido into um GIF animado
- Exigido
- Aceita URLs de vídeo do Vimeo e do YouTube
  - O aviso de animação de vídeos do Vimeo e do YouTube depende de terceiros e, portanto, pode não fornecer resultados consistentes.
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar o GIF animado.

Valor de retorno

anular

Opções de animação

Todas as opções disponíveis ao criar um GIF animado.

customId - identificador personalizado pelo qual você pode passar para o serviço da web GIF animado. Isso será retornado com o URL de retorno que você especificou.
- Padrão: vazio
width - a largura do GIF animado resultante em pixels.
- Padrão: 180px
- Máximo: Largura máxima para o pacote
- Tamanho automático: -1 (passar -1 significa que a largura do GIF animado é redimensionado em relação à sua altura, se a largura estiver sendo dimensionada automaticamente, a altura não poderá)
height - a altura do GIF animado resultante em pixels.
- Padrão: 120px
- Máximo: Altura máxima para o pacote
- Tamanho automático: -1 (passar -1 significa que a altura do GIF animado é redimensionado em relação à sua largura, se a altura estiver sendo dimensionada automaticamente, a largura não poderá)
start - a posição inicial do vídeo que deve ser convertida intum GIF animado.
- Padrão: 0 segundos
duration - a duração em segundos do vídeo que deve ser convertido intum GIF animado.
- Padrão: comprimento máximo para o pacote
speed - a velocidade do GIF animado.
- Padrão: 1
- Mínimo: 0.2
- Máximo: 10
framesPerSecond - o número de quadros por segundo que devem ser capturados do vídeo.
- Padrão: 10
- Mínimo: 0.2
- Máximo: 60
repeat - número de vezes para repetir o GIF animado.
- Padrão: 0
- Loop continuamente: 0
- Nunca Loop: -1
reverse - se verdadeiro, os quadros do GIF animado são revertidos
- Padrão: false
customWaterMarkId - adicionar personalizado watermark para o GIF animado
- Padrão: vazio
quality - a qualidade da imagem retornada, que possui uma compactação padrão de 85%.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
country - o país o GIF animado deve ser retirado.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio

Exemplo de Opções

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

url_to_image(url, opções)

Especifica o URL que deve ser convertido intuma captura de tela da imagem.

parâmetros

url - o URL do qual a captura de tela deve ser feita
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar a captura de tela.

Valor de retorno

anular

html_to_image(html, opções)

Especifica o HTML que deve ser convertido intuma imagem.

parâmetros

html - o HTML para converter intoa imagem
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

file_to_image(caminho, opções)

Especifica um arquivo HTML que deve ser convertido intuma imagem.

parâmetros

path - o caminho do arquivo HTML para converter intoa imagem
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

Opções de imagem

Todas as opções disponíveis ao criar capturas de imagens.

customId - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
- Padrão: vazio
browserWidth - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
browserHeight - a altura do navegador em pixels
- Padrão: 1170
- Máximo: 10000
- Comprimento total: -1 (passar -1 significa que é feita uma captura de tela de toda a página da web)
width - a largura da miniatura resultante em pixels
- Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final, se a altura de saída for especificada, a largura de saída será proporcional à altura de saída
- Máximo: Largura máxima para o pacote
- Largura total: -1 (passar -1 significa que a largura da miniatura não é reduzida)
height - a altura da miniatura resultante em mm
- Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final; se a largura de saída for especificada, a altura de saída será proporcional à largura de saída
- Máximo: Altura máxima para o pacote
- Altura total: -1 (passar -1 significa que a altura da miniatura não é reduzida)
format - o formato em que a captura de tela deve estar.
- Padrão: "jpg"
- Opções: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
delay - o número de milissegundos a aguarde antes de tirar a captura de tela
- Padrão: 0
- Máximo: 30000
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
targetElement - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into uma captura de tela, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
- Padrão: vazio
hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
- Padrão: vazio
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
- Padrão: vazio
requestAs - o tipo de agente do usuário que você deseja usar
- Padrão: 0
- opções:
  - 0 = indica que o agente do usuário de um navegador padrão deve ser usado
  - 1 = indica que o agente do usuário de um navegador móvel deve ser usado
  - 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
customWaterMarkId - adicione um personalizado watermark para a imagem
- Padrão: vazio
quality - a qualidade da imagem retornada. Atualmente, isso afeta apenas imagens JPG e WEBP, que têm uma compactação padrão de 90%.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
transparent - se verdadeiro, o a captura de imagem deve ser transparente. Isso é compatível apenas com imagens png e tiff.
- Padrão: false
hd - se verdadeira a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
- Padrão: false
country - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
noAds - se for verdade anúncios devem ser ocultados automaticamente.
- Padrão: false
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
- Padrão: false
address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
- Padrão: vazio
post - define a consulta HTTP Poststring. Cada nome e valor na consultastring precisará ser codificado em URL. Usar esta opção forçará o GrabzIt a executar uma postagem HTTP.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio

Exemplo de Opções

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

url_to_rendered_html(url, opções)

Especifica o URL que deve ser convertido into HTML renderizado.

parâmetros

url - a URL da qual o HTML renderizado deve ser feito
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar o HTML renderizado.

Valor de retorno

anular

html_to_rendered_html(html, opções)

Especifica o HTML que deve ser convertido into HTML renderizado.

parâmetros

html - o HTML para converter into HTML renderizado
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar HTML renderizado.

Valor de retorno

anular

file_to_rendered_html(caminho, opções)

Especifica um arquivo HTML que deve ser convertido into HTML renderizado.

parâmetros

path - o caminho do arquivo HTML para converter into HTML renderizado
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar HTML renderizado.

Valor de retorno

anular

Opções de HTML

Todas as opções disponíveis quando criando capturas HTML renderizadas.

customId - identificador personalizado que você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
- Padrão: vazio
browserWidth - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
browserHeight - a altura do navegador em pixels
- Padrão: 1170
- Máximo: 10000
delay - o número de milissegundos a aguarde antes de tirar a captura de tela
- Padrão: 0
- Máximo: 30000
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
- Padrão: vazio
requestAs - o tipo de agente do usuário que você deseja usar
- Padrão: 0
- opções:
  - 0 = indica que o agente do usuário de um navegador padrão deve ser usado
  - 1 = indica que o agente do usuário de um navegador móvel deve ser usado
  - 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
country - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
noAds - se for verdade anúncios devem ser ocultados automaticamente.
- Padrão: false
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
- Padrão: false
address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
- Padrão: vazio
post - define a consulta HTTP Poststring. Cada nome e valor na consultastring precisará ser codificado em URL. Usar esta opção forçará o GrabzIt a executar uma postagem HTTP.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio

Exemplo de Opções

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

url_to_pdf(url, opções)

Especifica o URL que deve ser convertido intum PDF.

parâmetros

url - o URL que deve ser convertido intoa PDF
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

html_to_pdf(html, opções)

Especifica o HTML que deve ser convertido intum PDF.

parâmetros

html - o HTML para converter intoa PDF
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

file_to_pdf(caminho, opções)

Especifica um arquivo HTML que deve ser convertido intum PDF.

parâmetros

path - o caminho do arquivo HTML para converter intoa PDF
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

Opções de PDF

Todas as opções disponíveis ao criar capturas de PDF.

customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
- Padrão: vazio
includeBackground - se verdadeiro, o plano de fundo da página da web deve ser incluído na captura de tela
- Padrão: true

pagesize - o tamanho da página do PDF
- Padrão: "A4"
- Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
orientation - a orientação do documento PDF
- Padrão: "Retrato"
- Opções: "Retrato", "Paisagem"
cssMediaType - a Tipo de mídia CSS do documento PDF
- Tela padrão"
- Opções: "Tela", "Print"
includeLinks - true se os links devem ser incluídos no PDF
- Padrão: true
includeOutline - verdadeiro se Favoritos em PDF Deveria ser incluído
- Padrão: false
title - forneça um título para o documento PDF
- Padrão: vazio
coverUrl - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
- Padrão: vazio
marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
- Padrão: 10
marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
- Padrão: 10
marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
- Padrão: 10
marginRight - a margem em milímetros que deve aparecer à direita do documento PDF
- Padrão: 10
browserWidth - a largura do navegador em pixels
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
- Padrão: 1366
- Máximo: 10000
- Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento PDF)
pageWidth - a largura personalizada do PDF resultante em mm
- Padrão: tamanho da página largura
- Mínimo: 15
pageHeight - a altura personalizada do PDF resultante em mm
- Padrão: tamanho da página altura
- Mínimo: 15
delay - o número de milissegundos a aguarde antes de tirar a captura de tela
- Padrão: 0
- Máximo: 30000
requestAs - o tipo de agente do usuário que você deseja usar
- Padrão: 0
- opções:
  - 0 = indica que o agente do usuário de um navegador padrão deve ser usado
  - 1 = indica que o agente do usuário de um navegador móvel deve ser usado
  - 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
- Padrão: vazio
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
targetElement - a Seletor CSS dos únicos Elemento HTML na página da web de destino a ser ativada intoa PDF, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
- Padrão: vazio
hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
- Padrão: vazio
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
- Padrão: vazio
customWaterMarkId - adicione um personalizado watermark para cada página do documento PDF
- Padrão: vazio
quality - a qualidade do PDF retornado. O padrão usa a qualidade recomendada para o PDF.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
country - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
noAds - se for verdade anúncios devem ser ocultados automaticamente.
- Padrão: false
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
- Padrão: false
address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
- Padrão: vazio
post - define a consulta HTTP Poststring. Cada nome e valor na consultastring precisará ser codificado em URL. Usar esta opção forçará o GrabzIt a executar uma postagem HTTP.
- Padrão: vazio
templateVariables - define um modelo personalizado parâmetro e valor como uma consultastring. Cada nome e valor na consultastring precisará ser codificado em URL.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio
mergeId - o ID de uma captura que deve ser mesclados no início do novo documento PDF
- Padrão: vazio
password - a senha para proteger o documento PDF com
- Padrão: vazio

Exemplo de Opções

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

url_to_docx(url, opções)

Especifica o URL que deve ser convertido into DOCX.

parâmetros

url - o URL que deve ser convertido into DOCX
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

html_to_docx(html, opções)

Especifica o HTML que deve ser convertido into DOCX.

parâmetros

html - o HTML para converter into DOCX
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

file_to_docx(caminho, opções)

Especifica um arquivo HTML que deve ser convertido into DOCX.

parâmetros

path - o caminho do arquivo HTML para converter into DOCX
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

Opções DOCX

Todas as opções disponíveis ao criar capturas de DOCX.

customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
- Padrão: vazio
includeBackground - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
- Padrão: true
pagesize - o tamanho da página do DOCX
- Padrão: "A4"
- Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
orientation - a orientação do documento DOCX
- Padrão: "Retrato"
- Opções: "Retrato", "Paisagem"
includeLinks - true se os links devem ser incluídos no DOCX
- Padrão: true
includeImages - se verdadeiro, as imagens da página da web devem ser incluídas no DOCX
- Padrão: true
title - fornecer um título ao documento DOCX
- Padrão: vazio
marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
- Padrão: 10
marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
- Padrão: 10
marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
- Padrão: 10
marginRight - a margem em milímetros que deve aparecer à direita do documento DOCX
- Padrão: 10
browserWidth - a largura do navegador em pixels
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
- Padrão: 1366
- Máximo: 10000
- Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento DOCX)
pageWidth - a largura personalizada do DOCX resultante em mm
- Padrão: tamanho da página largura
- Mínimo: 15
pageHeight - a altura personalizada do DOCX resultante em mm
- Padrão: tamanho da página altura
- Mínimo: 15
delay - o número de milissegundos a aguarde antes de tirar a captura de tela
- Padrão: 0
- Máximo: 30000
requestAs - o tipo de agente do usuário que você deseja usar
- Padrão: 0
- opções:
  - 0 = indica que o agente do usuário de um navegador padrão deve ser usado
  - 1 = indica que o agente do usuário de um navegador móvel deve ser usado
  - 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
- Padrão: vazio
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
targetElement - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into DOCX, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
- Padrão: vazio
hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
- Padrão: vazio
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
- Padrão: vazio
quality - a qualidade do DOCX devolvido. A qualidade padrão das imagens no DOCX é 85%.
- Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
- Padrão: -1
- Mínimo: -1
- Máximo: 100
country - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
noAds - se for verdade anúncios devem ser ocultados automaticamente.
- Padrão: false
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
- Padrão: false
address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
- Padrão: vazio
post - define a consulta HTTP Poststring. Cada nome e valor na consultastring precisará ser codificado em URL. Usar esta opção forçará o GrabzIt a executar uma postagem HTTP.
- Padrão: vazio
templateVariables - define um modelo personalizado parâmetro e valor como uma consultastring. Cada nome e valor na consultastring precisará ser codificado em URL.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio
mergeId - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
- Padrão: vazio
password - a senha para proteger o documento DOCX com
- Padrão: vazio

Exemplo de Opções

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

url_to_table(url, opções)

Especifica a URL da qual as tabelas HTML devem ser extraídas.

parâmetros

url - o URL para extrair tabelas HTML de
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

html_to_table(html, opções)

Especifica o HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

html - o HTML para extrair tabelas HTML.
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

file_to_table(caminho, opções)

Especifica um arquivo HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

path - o caminho do arquivo HTML para extrair as tabelas HTML.
- Exigido
opções - um objeto JSON que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

Opções de tabela

Todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.

customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou
- Padrão: vazio
tableNumberToInclude - o índice da tabela a ser convertida, onde todas as tabelas em uma página da web são ordenadas da parte superior da página para a parte inferior
- Padrão: 1
format - o formato em que a tabela deve estar
- Padrão: "csv"
- Opções: "csv", "json", "xlsx"
includeHeaderNames - se nomes de cabeçalho verdadeiros serão incluídos na tabela
- Padrão: true
includeAllTables - se true, toda a tabela na página da Web será extraída, com cada tabela aparecendo em uma planilha separada. Disponível apenas no formato XLSX
- Padrão: false
targetElement - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
- Padrão: vazio
requestAs - o tipo de agente do usuário que você deseja usar
- Padrão: 0
- opções:
  - 0 = indica que o agente do usuário de um navegador padrão deve ser usado
  - 1 = indica que o agente do usuário de um navegador móvel deve ser usado
  - 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
country - o país a captura de tela deve ser retirada.
- Padrão: o local mais rápido atual
- Opções: "SG", "Reino Unido", "EUA"
exportUrl - a URL de exportação que especifica onde a captura também deve ser exportada
- Padrão: vazio
encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
- Padrão: vazio
post - define a consulta HTTP Poststring. Cada nome e valor na consultastring precisará ser codificado em URL. Usar esta opção forçará o GrabzIt a executar uma postagem HTTP.
- Padrão: vazio
address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
- Padrão: vazio
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
- Padrão: vazio

Exemplo de Opções

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

O uso da opção callBackUrl é o método recomendado para salvar um arquivo

save(callBackUrl, incompleto)

Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o get_result método.

parâmetros

callBackURL - o treinador o serviço GrabzIt deve ligar depois de concluir seu trabalho
oncomplete (error, id) - a função de retorno de chamada, chamada quando o ID da captura de tela é recuperado.

save_to(saveToArquivo, oncomplete)

Save o resultado de forma síncrona sem usar um URL de retorno de chamada.

parâmetros

saveToArquivo - o caminho do arquivo que a captura será saved uma vez que tenha sido concluída
oncomplete (erro, dados) - a função de retorno de chamada, chamada quando a captura de tela é baixada. O parâmetro data contém os bytes das capturas de tela.

get_status(id, incompleto)

Obtenha o status atual de uma captura de tela do GrabzIt.

parâmetros

id - o identificador exclusivo da captura de tela
- Exigido
incompleto (erro, estado) - a função de retorno de chamada, que é chamada quando o status da captura de tela é recuperado.
- Exigido

get_cookies(domínio, incompleto)

Obtenha todos os cookies que o GrabzIt está usando para um domínio específico. Isso também pode incluir cookies definidos pelo usuário.

parâmetros

domínio - o domínio para o qual retornar cookies para
- Exigido
incompleto (erro, bolinhos) - a função de retorno de chamada, que é chamada quando os cookies são recuperados.
- Exigido

set_cookie (nome, domínio, opções, incompleto)

Define um novo cookie personalizado no GrabzIt. Se o cookie personalizado tiver o mesmo nome e domínio que um cookie global, o cookie global será substituído.

Isso pode ser útil se a funcionalidade de um site for controlada por cookies.

parâmetros

nome - o nome do cookie a ser definido
- Exigido
domínio - o domínio do site para definir o cookie para
- Exigido
opções
- valor - o valor do cookie
- path - o caminho do site ao qual o cookie está relacionado
- httponly - se true, o cookie pode ser usado apenas com o protocolo HTTP
- expira - define quando o cookie expira. Passe um valor nulo se o cookie não expirar
```
{
    'value':'me@example.com',
    'httponly':false
}
```
oncomplete (erro, sucesso) - a função de retorno de chamada, que é chamada quando o cookie foi definido. O parâmetro success será verdadeiro se o cookie for definido com êxito, caso contrário, false

delete_cookie (nome, domínio, incompleto)

Excluir um cookie personalizado ou impedir que um cookie global seja usado

parâmetros

nome - o nome do cookie a ser excluído
- Exigido
domínio - o domínio do site para excluir o cookie para
- Exigido
oncomplete (erro, sucesso) - a função de retorno de chamada, que é chamada quando o cookie foi definido. O parâmetro success será verdadeiro se o cookie for excluído, caso contrário, false.

pegue_watermarks()

Obtenha todo o seu upload personalizado watermarks

parâmetros

incompleto (erro, watermarks) - a função de retorno de chamada, que é chamada quando o watermarks foram recuperados. o watermark parâmetro contém uma matriz de watermarks.
- Exigido

pegue_watermark(identificador, oncomplete)

Devolva seu costume watermark que corresponde ao identificador especificado

parâmetros

identificador - o identificador de um determinado costume watermark você quer ver
- Exigido
incompleto (erro, watermarks) - a função de retorno de chamada, que é chamada quando o watermark foi recuperado. o watermarks parâmetro contém um watermark matriz.
- Exigido

adicionar_watermark(identificador, caminho, xpos, ypos, oncomplete)

Adicionar um novo personalizado watermark

parâmetros

identificador - o identificador que você deseja fornecer ao watermark. É importante que esse identificador seja único.
- Exigido
caminho - o caminho absoluto do watermark no seu servidor. Por exemplo C: /watermark/1.png
- Exigido
xpos - a posição horizontal em que você deseja que a captura de tela apareça
- Exigido
- opções:
  - Esquerda = 0
  - Centro = 1
  - Direita = 2
ypos - posição vertical em que você deseja que a captura de tela apareça
- Exigido
- opções:
  - Topo = 0
  - Médio = 1
  - Parte inferior = 2
oncomplete (erro, sucesso) - a função de retorno de chamada, que é chamada quando o watermark foi adicionado. O parâmetro de sucesso é verdadeiro se o watermark foi adicionado com sucesso; caso contrário, será falso.
- Exigido

excluir_watermark(identificador, oncomplete)

Excluir um personalizado watermark

parâmetros

identificador - o identificador do costume watermark você quer deletar
- Exigido
oncomplete (erro, sucesso) - a função de retorno de chamada, que é chamada quando o watermark foi removido. O parâmetro de sucesso é verdadeiro se o watermark foi excluído com sucesso.
- Exigido

set_local_proxy (valor)

Este método permite uma servidor proxy local para ser usado para todas as solicitações.

parâmetros

value - o URL, que pode incluir uma porta, se necessário, do proxy. Fornecer um valor nulo removerá qualquer proxy definido anteriormente
- Exigido

use_ssl (valor)

Especifica se as solicitações ao GrabzIt API deve usar SSL

parâmetros

value - se true, todos os pedidos à API do GrabzIt usarão SSL
- Exigido

create_encryption_key ()

Crie uma chave de criptografia 64 básica com criptografia segura, com caracteres 44.

descriptografar (dados, chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros

path - o caminho da captura criptografada
- Exigido
chave - o Chave de encriptação
- Exigido

decrypt_file (caminho, chave, incompleto)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros

path - o caminho da captura criptografada
- Exigido
chave - o Chave de encriptação
- Exigido
oncomplete (erro) - a função de retorno de chamada, chamada quando o arquivo é descriptografado.

Classes de resultado

Cookie

Variáveis Públicas

nome - o nome do cookie
value - o valor do cookie
domínio - o domínio para o qual o cookie está definido
path - o caminho no domínio ao qual este cookie se aplica.
httponly - se este cookie é válido apenas quando o site é visualizado com o protocolo HTTP.
expira - a data em que esse cookie expira
type - o tipo de cookie que é esse
- opções:
  - Global - este é um cookie global definido por GrabzIt
  - Local - este é um cookie local definido por você
  - Substituído - um cookie global que foi substituído por você

Estado

A classe que representa o status atual da captura de tela.

Variáveis Públicas

processing - se true, a captura de tela ainda está sendo processada.
em cache - se verdadeiro, a captura de tela foi processada e está atualmente em cache.
expirou - se verdadeiro, a captura de tela não está mais no sistema GrabzIt.
message - uma mensagem de erro retornada pelo sistema.

WaterMark

Esta classe representa o costume watermarks armazenado no GrabzIt

Variáveis Públicas

identificador - o identificador do watermark
formato - o formato do watermark imagem
xPosition - a posição x que o watermark aparece na imagem
- opções:
  - Esquerda = 0
  - Centro = 1
  - Direita = 2
yPosition - a posição y que o watermark aparece na imagem
- opções:
  - Topo = 0
  - Médio = 1
  - Parte inferior = 2