@@ -96,26 +96,31 @@ export interface PoDynamicViewField extends PoDynamicField {
9696 isArrayOrObject ?: boolean ;
9797
9898 /**
99- * Formato de exibição do valor do campo.
100- *
101- * Aplicado para casos específicos de acordo com o tipo do campo.
102- *
103- * **types**:
104- * - `currency`: Aceita valores definidos para a propriedade `currencyCode` do
105- * [**CurrencyPipe**](https://angular.io/api/common/CurrencyPipe)
106- * + Exemplos: 'BRL', 'USD'.
107- * - `date`: Aceita valores definidos para a propriedade `format` do [**DatePipe**](https://angular.io/api/common/DatePipe)
108- * e também aceita os caracteres de dia(dd), mês(MM) e ano (yyyy ou yy),
109- * caso não seja informado um formato o mesmo será 'dd/MM/yyyy'. Exemplos: 'dd/MM/yyyy', 'dd-MM-yy', 'mm/dd/yyyy'.
110- * - `time`: Aceita apenas os caracteres de hora(HH), minutos(mm), segundos(ss) e
111- * milisegundos(f-ffffff), os milisegundos são opcionais, caso não seja informado um formato o mesmo será
112- * 'HH:mm:ss'. Exemplos: 'HH:mm', 'HH:mm:ss.ffffff', 'HH:mm:ss.ff', 'mm:ss.fff'.
113- * - `number`: Aceita valores definidos para a propriedade `digitsInfo` do [**DecimalPipe**](https://angular.io/api/common/DecimalPipe)
114- * para formatação, e caso não seja informado, o número será exibido na sua forma original.
115- *
116- * + Exemplo: com o valor de entrada: `50` e a valor para formatação: `'1.2-5'` o resultado será: `50.00`.
99+ * Define o formato de exibição para o valor de um campo.
100+ *
101+ * - Quando `format` é uma `string`, o formato aplicado depende da propriedade **type** segue como usar cada tipo:
102+ * - `currency`: Utiliza códigos de moeda definidos pelo [CurrencyPipe](https://angular.io/api/common/CurrencyPipe).
103+ * Exemplos: Use 'BRL' para Real Brasileiro e 'USD' para Dólar Americano.
104+ * - `date`: Adota formatos de data especificados pelo [DatePipe](https://angular.io/api/common/DatePipe).
105+ * Suporta formatos personalizados, como dia (dd), mês (MM) e ano (yyyy ou yy).
106+ * Formato padrão é 'dd/MM/yyyy'. Exemplos: 'dd/MM/yyyy', 'dd-MM-yy', 'mm/dd/yyyy'.
107+ * - `time`: Aceita formatos de tempo, incluindo hora (HH), minutos (mm), segundos (ss) e opcionalmente
108+ * milisegundos (f-ffffff). Formato padrão é 'HH:mm:ss'. Exemplos: 'HH:mm', 'HH:mm:ss.ffffff', 'HH:mm:ss.ff'.
109+ * - `number`: Usa especificações do [DecimalPipe](https://angular.io/api/common/DecimalPipe) para formatação numérica.
110+ * Na ausência de um formato específico, o número é exibido como fornecido.
111+ * Exemplo: Entrada `50`, formato `'1.2-5'`, resulta em `50.00`.
112+ *
113+ * - Quando `format` é um `Array<string>`:
114+ * - Cada elemento do array representa uma propriedade do objeto.
115+ * - Os valores dessas propriedades são concatenados, separados pelo padrão ' - '.
116+ * - Exemplo: Para `format: ["id", "name"]` e um objeto `{ id: 1, name: 'Carlos Diego' }`,
117+ * o resultado será `'1 - Carlos Diego'`.
118+ *
119+ * @example Para formatar um campo de moeda, use format: "BRL".
120+ * Para um campo de data, use format: "dd/MM/yyyy".
121+ * Para combinar propriedades de um objeto em um campo, use format: ["id", "name"].
117122 */
118- format ?: string ;
123+ format ?: string | Array < string > ;
119124
120125 /**
121126 * Informa a ordem de exibição do campo.
0 commit comments