SVGToPDFConversionAPI - com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 6 min. de leitura

    • A API SVGToPDFConversion fornece métodos que permitem adicionar um SVG a um PDF e converter um SVG em PDF.

    Esta API faz parte do plug-in ServiceNow PDF Generator Utilities (com.snc.apppdfgenerator) e é fornecida no namespace sn_pdfgeneratorutils. O plug-in é ativado por padrão.

    Consulte também PDFGenerationAPI.

    SVGToPDFConversionAPI - SVGToPDFConversionAPI()

    Instancia um novo objeto SVGToPDFConversionAPI.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    Os exemplos a seguir mostram como criar um objeto SVGToPDFConversionAPI.

    var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

    SVGToPDFConversionAPI - addSVGToPDF(cadeia de caracteres svg, cadeia de caracteres inputPdfSysId, cadeia de caracteres targetTable, cadeia de caracteres targetSysId, cadeia de caracteres nameForPdf, número pageNo, número x, número y, número svgImgWidth, número svgImgHeight)

    Adiciona uma imagem SVG a um PDF em uma página especificada com tamanho de imagem e coordenadas de local.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    SVG Cadeia de caracteres SVG a ser convertido em um documento PDF.
    inputPdfSysId Cadeia de caracteres Sys_id do PDF de destino no qual uma cópia será criada com um SVG. O PDF de destino está na tabela Anexos [sys_attachment].
    targetTable Cadeia de caracteres Nome da tabela que contém o registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    targetTableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF está anexado. Você pode encontrar este valor na mesma linha do anexo listado na tabela Anexos [sys_attachment].
    targetTable Cadeia de caracteres Nome da tabela à qual o PDF convertido será anexado.
    targetTableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF convertido será anexado.
    NomeDopdf Cadeia de caracteres Nome para fornecer ao PDF.

    Padrão: Sys_id do PDF na tabela Anexos [sys_attachment].
    pageNo Número Número da página no PDF anexado no qual o SVG será colocado.
    x Número Posição horizontal do SVG na página. O valor está em pontos.
    u Número Posição vertical do SVG na página. O valor está em pontos.
    svgImgWidth Número Largura da imagem SVG em pixels.
    svgImgAltura Número Altura da imagem SVG em pixels.
    Tabela 3. Retorna
    Tipo Descrição
    Objeto Objeto que contém o sys_id de um novo anexo em PDF com o SVG inserido se for bem-sucedido, caso contrário, uma mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Se a conversão de SVG for bem-sucedida, sys_id do PDF anexado. O arquivo está listado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Falha ao adicionar conteúdo SVG ao PDF.
    • A adição de SVG ao PDF e a criação de um novo PDF foram bem-sucedidas.
    • Registro de destino fornecido [<tableName> -<targetTableSysId> ] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • O SYS ID do anexo em PDF de entrada para adicionar o conteúdo SVG é nulo
    • O conteúdo SVG de entrada está vazio ou é nulo
    • PdfReader não é aberto com a senha do proprietário
    • O nome da tabela de destino para anexar o PDF modificado :<targetTable> está vazio ou é nulo
    • O nome da tabela de destino para anexar o PDF modificado :<targetTable> não é válido

    Tipo de dados: cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • sucesso — A operação foi bem-sucedida.
    • falha – A operação não foi bem-sucedida. O message fornece detalhes.

    Tipo de dados: cadeia de caracteres

    O exemplo a seguir mostra como obter SVG do campo de descrição de um registro de incidente e adicioná-lo à página 5 de um anexo em PDF. O novo PDF com SVG está localizado na tabela Anexos [sys_attachment].

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var result = new sn_pdfgeneratorutils.SVGToPDFConversionAPI().addSVGToPDF(svg, "<inputPdfSysId>", "incident", "<tableSysId>", "AddSVGToPDF", 5, 30, 30, 300, 100);
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<sys_id>","message":"Adding SVG to PDF and creating new PDF is successful.","status":"success"}

    SVGToPDFConversionAPI - convertSVGToPDF(cadeia de caracteres svg, cadeia de caracteres pdfName, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId)

    Converte um SVG fornecido como cadeia de caracteres em PDF.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    SVG Cadeia de caracteres SVG a ser convertido em um documento PDF.
    NomeDopdf Cadeia de caracteres Nome para fornecer ao PDF.

    Padrão: Sys_id do PDF na tabela Anexos [sys_attachment].
    targetTable Cadeia de caracteres Nome da tabela à qual o PDF convertido será anexado.
    targetTableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF convertido será anexado.
    Tabela 5. Retorna
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo em PDF convertido de SVG se for bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Se a conversão de SVG for bem-sucedida, sys_id do PDF anexado. O arquivo está listado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Falha ao converter imagem SVG em documento PDF.
    • Exceção ao ler o conteúdo do documento de origem.
    • Registro de destino fornecido [<tableName> -<targetTableSysId> ] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • A conversão de SVG para PDF foi bem-sucedida.
    • O nome da tabela de destino -<tableName> anexar o SVG convertido não é válido
    • O nome da tabela de destino -<tableName> para anexar o SVG convertido está vazio ou é nulo

    Tipo de dados: cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • sucesso — A operação foi bem-sucedida.
    • falha – A operação não foi bem-sucedida. O message fornece detalhes.

    Tipo de dados: cadeia de caracteres

    O exemplo a seguir mostra como obter SVG do campo de descrição de um registro de incidente para converter o SVG em PDF e anexá-lo a um registro.

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

var result = v.convertSVGToPDF(svg, "ConvertSVGToPDF", "incident", "<targetTableSysId>");
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<pdf_attachment_sys_id>","message":"SVG to PDF conversion is successful.","status":"success"}

    SVGToPDFConversionAPI - convertSVGToPDFWithSize(cadeia de caracteres svg, cadeia de caracteres nameForPDF, cadeia de caracteres targetTable, cadeia de caracteres targetTableSysId, número svgImgWidth, número svgImgHeight)

    Converte um SVG fornecido como cadeia de caracteres em PDF com valores de largura e altura da imagem.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    SVG Cadeia de caracteres SVG a ser convertido em um documento PDF.
    NomeDopdf Cadeia de caracteres Nome para fornecer ao PDF.

    Padrão: Sys_id do PDF na tabela Anexos [sys_attachment].
    targetTable Cadeia de caracteres Nome da tabela à qual o PDF convertido será anexado.
    targetTableSysId Cadeia de caracteres Sys_id do registro ao qual o PDF convertido será anexado.
    svgImgWidth Número Largura da imagem SVG em pixels.
    svgImgAltura Número Altura da imagem SVG em pixels.
    Tabela 7. Retorna
    Tipo Descrição
    Objeto Objeto que contém sys_id do anexo em PDF convertido de SVG se for bem-sucedido, caso contrário, mensagem de erro.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Se a conversão de SVG for bem-sucedida, sys_id do PDF anexado. O arquivo está listado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    <Object>.mensagem Mensagem confirmando sucesso ou erro.
    Valores possíveis:
    • Falha ao converter imagem SVG em documento PDF.
    • Exceção ao ler o conteúdo do documento de origem.
    • Registro de destino fornecido [<tableName> -<targetTableSysId> ] não existe. – A tabela de destino sys_id não está na tabela fornecida. Certifique-se de incluir o nome da tabela correto para o registro.
    • O nome da tabela de destino -<tableName> anexar o SVG convertido não é válido
    • O nome da tabela de destino -<tableName> para anexar o SVG convertido está vazio ou é nulo
    • A conversão de SVG para PDF foi bem-sucedida.

    Tipo de dados: cadeia de caracteres
    <Object>.status Status que indica se a operação foi bem-sucedida.
    Valores possíveis:
    • sucesso — A operação foi bem-sucedida.
    • falha – A operação não foi bem-sucedida. O message fornece detalhes.

    Tipo de dados: cadeia de caracteres

    O exemplo a seguir mostra como obter SVG do campo de descrição de um registro de incidente para converter o SVG em PDF e anexá-lo a um registro.

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

var result = v.convertSVGToPDFWithSize(svg, "ConvertSVGToPDF", "incident", "<targetTableSysId>", 600, 150);
gs.info(JSON.stringify(result));

    Saída:

    {"attachment_id":"<pdf_attachment_sys_id>","message":"SVG to PDF conversion is successful.","status":"success"}