Ir para conteúdo principal

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

Esta função retorna um valor correspondente a um carimbo de data/hora com o último milissegundo do último dia do ano que contém date. O formato de saída padrão será o DateFormat definido no script.

Sintaxe:  

YearEnd( date[, period_no[, first_month_of_year = 1]])

Em outras palavras, a função yearend() determina em qual ano a data cai. Em seguida, ela retorna um carimbo de data/hora, em formato de data, para o último milissegundo daquele ano. O primeiro mês do ano é, por padrão, janeiro. No entanto, você pode alterar o mês definido como o primeiro usando o argumento first_month_of_year na função yearend().

Nota informativa A função yearend() não considera a variável de sistema FirstMonthOfYear. O ano começa em 1º de janeiro, a menos que o argumento first_month_of_year seja usado para alterá-lo.

Diagrama da função yearend().

Diagrama que mostra como a função yerend() identifica uma data e o final do ano em que ela ocorre.

A função yearend() é usada como parte de uma expressão quando você deseja que o cálculo use a fração do ano que ainda não ocorreu. Por exemplo, se você quiser calcular o total de juros ainda não acumulados durante o ano.

Tipo de dados de retorno: dual

Argumentos
Argumento Descrição
date A data para avaliar.
period_no period_no é um inteiro, em que o valor 0 indica o ano que contém a date. Valores negativos em period_no indicam anos precedentes e valores positivos indicam anos sucessivos.
first_month_of_year Se desejar trabalhar com anos (fiscais) que não comecem em janeiro, indique um valor entre 2 e 12 em first_month_of_year.

Você pode usar os seguintes valores para definir o primeiro mês do ano no argumento first_month_of_year:

Valores first_month_of_year
Month Valor
Fevereiro 2
Março 3
Abril 4
Maio 5
Junho 6
Julho 7
Agosto 8
Setembro 9
Outubro 10
Novembro 11
Dezembro 12

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 as configurações regionais do aplicativo.

As configurações regionais padrão nos aplicativos são baseadas em uma combinação de configurações do provedor de identidade, configurações do sistema ou configurações do navegador. 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 Definindo suas configurações regionais preferidas para a criação de aplicativos.

Exemplos de funções
Exemplo Resultado
yearend('10/19/2001') Returns 12/31/2001 23:59:59.
yearend('10/19/2001', -1) Returns 12/31/2000 23:59:59.
yearend('10/19/2001', 0, 4) Returns 03/31/2002 23:59:59.

Exemplo 1: Sem argumentos adicionais

Exemplo 2: period_no

Exemplo 3: first_month_of_year

Exemplo 4: Exemplo de objeto de gráfico

Exemplo 5: Cenário