Ir para conteúdo principal Pular para conteúdo complementar

yeartodate – função de script e gráfico

Esta função descobre se o carimbo de data e hora de entrada cai dentro de um ano da data em que o script foi carregado pela última vez, e retorna True se cair, False se não cair.

Sintaxe:  

YearToDate(timestamp[ , yearoffset [ , firstmonth [ , todaydate] ] ])

Tipo de dados de retorno: Booleano

Nota informativa

No Qlik Sense, o valor booleano “true” é representado por -1, e o valor falso é representado por 0.

Exemplo de diagrama da função yeartodate()

Diagrama que exibe os valores de data para os quais a função yeartodate retornará um valor True ou False.

Se nenhum dos parâmetros opcionais for usado, o acumulado no ano será qualquer data que ocorrer dentro de um ano civil, a partir de 1º de janeiro até a data da última execução do script, inclusive.

Em outras palavras, a função yeartodate(), quando acionada sem parâmetros adicionais, é usada para avaliar um carimbo de data/hora e retornar um resultado booleano com base no fato de a data ter ocorrido no ano civil até a data em que o carregamento ocorreu.

No entanto, também é possível substituir a data de início do ano usando o argumento firstmonth, bem como fazer comparações com anos anteriores ou seguintes usando o argumento yearoffset.

Finalmente, em casos de conjuntos de dados históricos, a função yeartodate() fornece um parâmetro a ser definido como todaydate, que comparará o carimbo de data/hora com o ano civil até e incluindo a data fornecida no argumento todaydate.

Argumentos
Argumento Descrição
timestamp

O carimbo de data/hora a ser avaliado, por exemplo, "10/12/2012".

yearoffset

Ao especificar um yearoffset, yeartodate retorna True para o mesmo período em outro ano. Um yearoffset negativo indica um ano anterior e um offset positivo um ano futuro. O year-to-date mais recente é alcançado ao especificar yearoffset = -1. Se omitido, o valor 0 é assumido.

firstmonth

Ao especificar um firstmonth entre 1 e 12 (1, se omitido), o início do ano pode ser movido para o primeiro dia de qualquer mês. Por exemplo, se quiser trabalhar com um ano fiscal começando em 1º de maio, especifique firstmonth = 5. Um valor de 1 indicaria um ano fiscal começando em 1º de janeiro, e um valor de 12 indicaria um ano fiscal começando em 1º de dezembro.

todaydate Ao especificar um todaydate (carimbo de data/hora da execução do último script, se omitido), é possível mover o dia usado como o limite superior do período.

Quando usar

A função yeartodate() retorna um resultado booleano. Normalmente, esse tipo de função será usado como uma condição em uma expressão If. Isso retornaria uma agregação ou cálculo dependendo se a data avaliada ocorreu no ano até e incluindo a data da última recarga do aplicativo.

Por exemplo, a função YearToDate() pode ser usada para identificar todos os equipamentos fabricados até o momento no ano atual.

Os exemplos a seguir presumem que o tempo do último carregamento é de 18/11/2011.

Exemplos de funções
Exemplo Resultado
yeartodate( '11/18/2010') retorna False
yeartodate( '02/01/2011') retorna True
yeartodate( '11/18/2011') retorna True
yeartodate( '11/19/2011') retorna False
yeartodate( '11/19/2011', 0, 1, '12/31/2011') retorna True
yeartodate( '11/18/2010', -1) retorna True
yeartodate( '11/18/2011', -1) retorna False
yeartodate( '04/30/2011', 0, 5) retorna False
yeartodate( '05/01/2011', 0, 5) retorna True

Configurações regionais

A menos que especificado de outra forma, os exemplos neste tópico usam o seguinte formato de data: MM/DD/AAAA. O formato de data é especificado na instrução SET DateFormat no seu script de carregamento de dados. A formatação de data padrão pode ser diferente no seu sistema devido às suas configurações regionais e outros fatores. Você pode alterar os formatos nos exemplos abaixo para atender às suas necessidades. Ou pode alterar os formatos no seu script de carregamento para corresponder a esses exemplos. Para obter mais informações, consulte Modificando configurações regionais para aplicativos e scripts.

As configurações regionais padrão nos aplicativos são baseadas no perfil do usuário. Essas configurações de formato regional não estão relacionadas ao idioma exibido na interface do usuário do Qlik Cloud. O Qlik Cloud será exibido no mesmo idioma do navegador que você está usando.

Se você for um criador de aplicativos, poderá definir a região padrão para os aplicativos que criar. Para obter mais informações, consulte Definir suas configurações regionais preferidas para criar aplicativos e scripts no Qlik Cloud Analytics.

Exemplo 1: Exemplo básico

Exemplo 2: yearoffset

Exemplo 3: firstmonth

Exemplo 4: todaydate

Exemplo 5: Exemplo de objeto de gráfico

Exemplo 6: cenário

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo - um erro de digitação, uma etapa ausente ou um erro técnico - informe-nos como podemos melhorar!