Parâmetros de código inserido para exibições
O código de incorporação do Tableau Server 2022.3 e posterior e Tableau Cloud mudou para usar a Embedding API v3. Para obter uma lista atual de classes e métodos na Embedding API v3, consulte a Referência da Embedding API na ajuda da Embedding API. As informações neste tópico são para versões anteriores de incorporação (usando a API JavaScript do Tableau v1 e v2).
Parâmetros para versões anteriores de inserção
A configuração de uma exibição inserida pode ser feita por meio de um destes métodos:
Parâmetros de objeto para marcas de JavaScript
| Parâmetro de objeto | Valores | Descrição | Exemplos |
|---|---|---|---|
dataDetails | no | Oculta o botão Detalhes de dados na barra de ferramentas, que permite aos usuários ver detalhes sobre os dados usados nessa exibição. | <param name='dataDetails' value='no' /> |
showDataDetails | yes | Se o Tableau Catalog estiver habilitado, mostra a exibição com o painel Detalhes dos dados aberto. | <param name='showDataDetails' value='yes' /> |
alerts | no | Oculta o botão Alertas na barra de ferramentas, que permite aos usuários criar alertas orientados por dados. | <param name='alerts' value='no'/> |
customViews. | no. | Oculta o botão Exibição na barra de ferramentas, que permite aos usuários salvar exibições personalizadas. | <param name='customViews' value='no'/>. |
device. | desktop; tablet; phone. | Se um painel possui layouts para dispositivos móveis, ele exibe um layout específico, independente do tamanho da tela. Se esse parâmetro não estiver definido, o Tableau Server ou o Tableau Cloud detecta o tamanho da tela e carrega um layout correspondente. Consulte Inserir painéis para obter exemplos. | <param name='device' value='phone'/>. |
filter. | cadeia de caracteres | Filtra os dados exibidos quando a exibição é aberta. Também é possível filtrar por meio dos parâmetros da URL. | <param name='filter' value='Team=Blue'/>. |
host_url. | cadeia de caracteres | Obrigatório. O nome do servidor conforme ele aparece na URL. | <param name='host_url' value='http://myserver.exampleco.com/'>.
|
linktarget. | cadeia de caracteres | O nome da janela de destino para hiperlinks externos. | <param name="linktarget" value="_blank"/>. |
load-order. | number | Quando diversas exibições são inseridas, determina a ordem em que elas carregam na página. Números negativos são permitidos. | <param name="load-order" value="2"/>. |
mobile | yes | Exibe filtros rápidos otimizados para dispositivos móveis. | <param
name='mobile' value='yes'/> |
name. | cadeia de caracteres | Parâmetro de objeto obrigatório, com esta estrutura: [nome da pasta de trabalho]/[nome da planilha]/[nome da exibição personalizada opcional] Formate os nomes de exibição personalizada opcionais, como: username@domain/[nomes de exibição personalizada] | <param name='name' value='ExampleCoSales/Sales'/>.
|
:original_view. | yes. | Se o parâmetro name refere-se a uma URL da pasta de trabalho ou da planilha (e não se refere explicitamente a uma exibição personalizada), incluindo este parâmetro, será mostrada a exibição como a exibição original. | <param name='filter' value=':original_view=yes'/>. |
path.(Somente no Tableau Server. Não aplicável ao Tableau Cloud.) | cadeia de caracteres | Somente para autenticação confiável; não pode ser usado com o parâmetro ticket. Substitui o valor do parâmetro name e é usado como a URL. Para obter mais informações, consulte Ver a exibição como o tíquete(O link abre em nova janela) na ajuda do administrador do Tableau Server. | <param name='path' value='trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4'/>.
|
showShareOptions. | true; false | Controla se as opções de Compartilhar são exibidas na exibição inserida. | <param name='showShareOptions' value='true' />. |
site_root. | cadeia de caracteres | Obrigatório. O nome do site. O valor do site Padrão é nulo (value=''). Se o seu servidor tiver vários sites e você desejar usar a autenticação confiável, consulte Ver a exibição com o tíquete(O link abre em nova janela) na ajuda do Tableau Server. | <param name='site_root' value='/#/Sales'/>.
|
subscriptions | no | Oculta o botão Assinaturas na barra de ferramentas, que permite aos usuários configurar assinaturas de e-mail para receber instantâneos de exibições em intervalos regulares. |
|
tabs. | yes; no. | Exibe ou oculta as guias. | <param name='tabs' value='yes'/>. |
ticket.(Somente no Tableau Server. Não aplicável ao Tableau Cloud.) | cadeia de caracteres | Somente para autenticação confiável; não pode ser usado com o parâmetro de objeto path. Deve ser usado com o objeto name para construir a URL de resgate do tíquete confiável. Para obter mais informações, consulte Ver a exibição com o tíquete(O link abre em nova janela) na Ajuda do Tableau Server. | <param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/>.
|
toolbar. | yes; no; top. | A barra de ferramentas é exibida na parte inferior por padrão. A barra de ferramentas é colocada acima da exibição ao definir este parâmetro como top e excluída da exibição inserida ao definí-lo como no. | <param name='toolbar' value='top'/> |
tooltip. | yes; no. | As dicas de ferramentas são exibidas por padrão ao definir esse parâmetro como no, no entanto, as dicas de ferramenta são excluídas da exibição inserida. | <param name='tooltip' value='no'/>. |
Parâmetros da URL para marcas de iframe
Observação: antes de adicionar parâmetros à URL, remova :iid=[#] do fim da URL. Trata-se de um contador de visualizações temporário para a sua sessão atual do navegador.
| Parâmetro de URL | Valores | Descrição | Exemplos |
|---|---|---|---|
:dataDetails | no | Oculta o botão Detalhes de dados na barra de ferramentas, que permite aos usuários ver detalhes sobre os dados usados nessa exibição. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:dataDetails=no |
:showDataDetails | yes | Se o Tableau Catalog estiver habilitado, mostra a exibição com o painel Detalhes dos dados aberto. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showDataDetails=yes |
:alerts | no | Oculta o botão Alertas em uma exibição inserida. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:alerts=no |
:customViews. | no. | Opção Lembrar minhas alterações. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:customViews=no. |
:device. | desktop; tablet; phone. | Se um painel possui layouts para dispositivos móveis, ele exibe um layout específico, independente do tamanho da tela. Se esse parâmetro não estiver definido, o Tableau Server ou o Tableau Cloud detecta o tamanho da tela e carrega um layout correspondente. Consulte Inserir painéis para obter exemplos. | http://tabserver/views/sales/sales_dashboard?:device=tablet. |
:display_count(Somente no Tableau Public) | yes | Mostra o número total de exibições de página ao clicar no logotipo do Tableau, no cando inferior esquerdo. | https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:display_count=yes |
:embed. | yes. | Parãmetro da URL obrigatório. Oculta a área de navegação superior, mesclando melhor a exibição com a página da Web. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes. |
:format. | pdf; png. | Mostra uma exibição como um arquivo PDF ou .png. | http://tabserver/views/Sales/Q2?:format=pdf. |
:highdpi. | false. | Renderiza uma exibição por meio de DPI (dots per inch, pontos por polegada) padrão para monitores e dispositivos de alta resolução. | http://tableauserver/views/Sales/Q2?:highdpi=false. |
:linktarget. | cadeia de caracteres | O nome da janela de destino para hiperlinks externos. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:linktarget=_blank. |
:openid_hd | cadeia de caracteres | Usado ao autenticar com OpenID Connect. Especifica o domínio hospedado ao qual um usuário pertence. Por exemplo, você pode usar esta opção se não quiser renderizar o painel de seleção de domínio. Usado em conjunto com:openid_login_hint para especificar o identificador de usuário completo. | http://tabserver/views/Sales/Q2?:openid_hd=example.com |
:openid_login_hint | cadeia de caracteres | Usado ao autenticar com OpenID Connect. Especifica o identificador de usuário completo (endereço de e-mail). Usado em conjunto com :openid_hd para especificar o domínio hospedado ao qual o usuário pertence. | http://tabserver/views/Sales/Q2?:openid_login_hint=tara@example.com |
:record_performance(Somente no Tableau Server. Não aplicável ao Tableau Cloud.) | yes. | Inicia um registro de desempenho para uma exibição. Adicione isso no final da URL, imediatamente antes da ID da sessão (:iid=<n>). Para obter mais informações, consulte Criar um registro de desempenho(O link abre em nova janela) na Ajuda do Tableau Server. | http://tabserver/views/Sales2013/Regions?:recordperformance=yes. |
:refresh | yes. | Renderiza a exibição usando os dados mais recentes do Tableau Server e do Tableau Cloud. Dica: para atualizar continuamente uma exibição, na seção | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:refresh=yes. |
:render. | true; false; número | Se a renderização do lado do cliente estiver habilitada (o padrão), configurá-la como false força a renderização do lado do servidor dessa sessão. Definir isso para true força a renderização do lado do cliente para a sessão.Pode ser inserido um número de 1 a 100 para definir o limite de complexidade acima do qual as exibições são renderizadas pelo servidor. Para obter mais informações, consulte Sobre a renderização do lado do cliente(O link abre em nova janela) na ajuda do Tableau Server. | http://tabserver/views/Date-Time/DateCalcs?:render=false. |
:revert. | all; filters; sorts; axes; shelves. | Retorna o item para seu estado original. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:revert=all. |
:showAppBanner | false | Oculta o aviso “Abrir no Tableau Mobile” em navegadores móveis na Web. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAppBanner=false |
:showAskData | false | Oculta o botão Pergunte aos dados na barra de ferramentas em uma exibição inserida. Por padrão, o botão Pergunte aos dados é exibido. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAskData=false |
:showShareOptions. | true; false | Controla se as opções de Compartilhar são exibidas na exibição inserida. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showShareOptions=true. |
:showVizHome(Somente no Tableau Public) | yes; no | Mostra ou oculta a interface de navegação de conteúdo do Tableau Public. Definido como não ao inserir visualizações em outras páginas da Web. | https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:showVizHome=no |
:subscriptions | no | Oculta o botão Assinar em uma exibição inserida. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:subscriptions=no |
:tabs. | yes; no. | Exibe ou oculta as guias. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:tabs=no. |
:toolbar. | yes; no; top. | A barra de ferramentas é exibida por padrão na parte inferior quando esse parâmetro não está definido. Quando no, a barra de ferramentas é excluída da exibição inserida. Quando top, a barra de ferramentas é colocada acima da exibição. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:toolbar=no. |
:tooltip. | yes; no. | As dicas de ferramentas são exibidas por padrão na exibição, quando esse parâmetro não está definido. Se definido como no, as dicas de ferramenta serão excluídas da exibição inserida. | http://tabserver/views/workbookQ4/SalesQ4?:embed=yes&:tooltip=no. |