Module: @nginstack/web-framework/lib/html/formatImageTag

Methods


<inner> formatImageTag(uri [, opt_options])

Gera uma tag para a exibição de uma imagem.

Parameters:
Name Type Argument Description
uri number | string

Chave ou URI da imagem na VFS.

opt_options Object <optional>

Opções de renderização para a imagem.

Properties
Name Type Argument Description
style string <optional>

Estilo CSS inline a ser usado na tag gerada.

id string

Identificador do elemento DOM associado a imagem.

cssClass string <optional>

Classe CSS a ser utilizada pela imagem.

mailObject Email <optional>

objeto de email no qual a imagem será inclusa.

Returns:

Tag formatada de acordo com os parâmetros informados. O uso desta função, quando utilizada para envio de emails, é restrita para arquivos existentes na VFS. Portanto, a URI deve ser uma chave da VFS ou uma URI que aponte para uma arquivo da VFS. Caso não seja, será retornada uma string vazia se mailObject for informado.

Type
string