Vizualizări

O vizualizare este o configurație salvată pentru modul în care sunt afișate înregistrările unui obiect: ce câmpuri apar, ordinea lor, dacă sunt vizibile și ce filtre sau grupuri sunt aplicate. Utilizați defineView() pentru a livra vizualizări preconfigurate împreună cu aplicația. Fiecărui obiect i se atribuie automat vizualizarea principală de listă (tabelul „All …” pe care îl deschide un element de navigare OBJECT) furnizată de server — inclusiv obiectele pe care le creează aplicația dvs., cu o coloană pentru fiecare câmp declarat de aplicația dvs. Vizualizările pe care le definiți cu defineView() sunt întotdeauna vizualizări suplimentare pe lângă cea implicită.

src/views/example-view.ts

import { defineView } from 'twenty-sdk/define';
import { EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER } from '../objects/example-object';
import { NAME_FIELD_UNIVERSAL_IDENTIFIER } from '../objects/example-object';

export default defineView({
  universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  name: 'All example items',
  objectUniversalIdentifier: EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER,
  icon: 'IconList',
  position: 0,
  fields: [
    {
      universalIdentifier: 'f926bdb7-6af7-4683-9a09-adbca56c29f0',
      fieldMetadataUniversalIdentifier: NAME_FIELD_UNIVERSAL_IDENTIFIER,
      position: 0,
      isVisible: true,
      size: 200,
    },
  ],
});

Puncte cheie

objectUniversalIdentifier specifică la ce obiect se aplică această vizualizare. Poate fi un obiect personalizat pe care l-ați definit sau un obiect standard Twenty.
Vizualizarea principală a listei obiectului aparține serverului: key este învechit și este ignorat, astfel încât o vizualizare din manifest nu o poate revendica niciodată. Livrați un element de navigare VIEW dacă doriți ca vizualizarea dvs. să fie la un singur clic distanță în bara laterală.
fields controlează ce coloane apar și ordinea acestora. Fiecare câmp face referire la un fieldMetadataUniversalIdentifier. Pentru a face referire la un câmp de sistem creat automat, cum ar fi createdAt, consultă Țintirea metadatelor de sistem.
Puteți declara, de asemenea, filters, filterGroups, sorts, groups și fieldGroups pentru configurații avansate.
position controlează ordonarea atunci când există mai multe vizualizări pentru același obiect.

Proprietăți opționale

Proprietate	Valori	Descriere
`type`	`ViewType.TABLE` (implicit), `ViewType.KANBAN`, `ViewType.CALENDAR`	Modul în care sunt dispuse înregistrările. (`FIELDS_WIDGET`, `TABLE_WIDGET`, `KANBAN_WIDGET` și `CALENDAR_WIDGET` există, de asemenea, dar sunt folosite intern de către widget-urile de tip page-layout.)
`visibility`	`ViewVisibility.WORKSPACE` (implicit), `ViewVisibility.UNLISTED`	Dacă vizualizarea este listată pentru întregul spațiu de lucru sau ascunsă din selectoare.
`openRecordIn`	învechit	Nu se mai aplică: locul unde se deschid înregistrările este acum o proprietate a obiectului (`openRecordIn` pe `defineObject()`), revenindu-se la preferința proprie a fiecărui membru.
`sorts`	`{ fieldMetadataUniversalIdentifier, direction: ViewSortDirection.ASC \| DESC }[]`	Ordinea implicită de sortare.
`isCompact`	`boolean`	Afișare compactă a rândurilor.
`mainGroupByFieldMetadataUniversalIdentifier` + `shouldHideEmptyGroups`	—	Gruparea înregistrărilor (de ex. coloane kanban) după un câmp.
`kanbanAggregateOperation`, `kanbanAggregateOperationFieldMetadataUniversalIdentifier`, `kanbanColumnWidth`	`AggregateOperations.*`	Agregări și dimensionare pentru coloanele kanban.
`calendarLayout`, `calendarFieldMetadataUniversalIdentifier`, `calendarEndFieldMetadataUniversalIdentifier`	`ViewCalendarLayout.DAY` / `WEEK` / `MONTH`	Vizualizări de tip calendar: layout, câmpul de dată care poziționează înregistrările și un câmp opțional pentru data de sfârșit.

Toate enum-urile de mai sus sunt exportate din twenty-sdk/define.

Filtre

O vizualizare poate include filtre aplicate în prealabil. Fiecare filtru are trei coordonate: câmpul care este filtrat, operandul (cum se compară) și valoarea (față de ce se compară). Toate cele trei trebuie să se potrivească — folosirea unui operand care nu se aplică unui tip de câmp va fi respinsă în timpul sincronizării.

import { ViewFilterOperand } from 'twenty-sdk/define';

filters: [
  {
    universalIdentifier: '...',
    fieldMetadataUniversalIdentifier: STATUS_FIELD_UNIVERSAL_IDENTIFIER,
    operand: ViewFilterOperand.IS,
    value: ['ACTIVE'],
  },
],

Operanzi acceptați pentru fiecare tip de câmp

Tipul câmpului	Operanzi acceptați
`TEXT`, `EMAILS`, `FULL_NAME`, `ADDRESS`, `LINKS`, `PHONES`, `RAW_JSON`, `FILES`, `ACTOR`, `ARRAY`	`CONTAINS`, `DOES_NOT_CONTAIN`, `IS_EMPTY`, `IS_NOT_EMPTY`
`ACTOR.source`, `ACTOR.workspaceMemberId`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`SELECT`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`MULTI_SELECT`	`CONTAINS`, `DOES_NOT_CONTAIN`, `IS_EMPTY`, `IS_NOT_EMPTY`
`RELATION`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`NUMBER`	`IS`, `IS_NOT`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS_EMPTY`, `IS_NOT_EMPTY`
`RATING`	`IS`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS_EMPTY`, `IS_NOT_EMPTY`
`CURRENCY`, `CURRENCY.amountMicros`	`GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`CURRENCY.currencyCode`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`DATE`, `DATE_TIME`	`IS`, `IS_RELATIVE`, `IS_IN_PAST`, `IS_IN_FUTURE`, `IS_TODAY`, `IS_BEFORE`, `IS_AFTER`, `IS_EMPTY`, `IS_NOT_EMPTY`
`BOOLEAN`	`IS`
`UUID`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`TS_VECTOR`	`VECTOR_SEARCH`

Tipurile de câmp cu nume similare pot folosi operanzi complet diferiți — SELECT și MULTI_SELECT fiind un caz comun.

Formă de valoare per operand

Câmpul value este întotdeauna o valoare serializabilă JSON, dar forma sa așteptată depinde de operand:

Familie de operanzi	Formă de valoare	Exemplu
`IS`, `IS_NOT` pe `SELECT`	array de chei de opțiune (șiruri de caractere)	`['ACTIVE', 'PENDING']`
`CONTAINS`, `DOES_NOT_CONTAIN` pe `MULTI_SELECT`	array de chei de opțiune (șiruri de caractere)	`['TAG_A']`
`IS`, `IS_NOT` pe `RELATION`	array de ID-uri de înregistrare (uuid-uri)	`['c5a1...']`
`CONTAINS`, `DOES_NOT_CONTAIN` pe câmpuri de tip text	șir	`'acme'`
`IS`, `IS_NOT` pe `NUMBER`	șir de caractere (valoarea)	`'5'`
`IS` pe `RATING` / `UUID`	șir de caractere (valoarea)	`'5'`
`GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`	șir de caractere (limita)	`'10'`
`IS`, `IS_BEFORE`, `IS_AFTER` pe `DATE` / `DATE_TIME`	șir în format ISO 8601	`'2025-01-01T00:00:00Z'`
`IS_EMPTY`, `IS_NOT_EMPTY`	șir gol	`''`
`IS` pe `BOOLEAN`	`'true'` sau `'false'`	`'true'`

Cum apar vizualizările în interfața utilizatorului

O vizualizare, de una singură, nu este accesibilă din bara laterală. Pentru a o face să apară acolo, asociați-o cu un element de meniu de navigare de tip VIEW care indică către universalIdentifier al vizualizării. Acesta este tiparul canonic: fiecare obiect personalizat primește o vizualizare index implicită generată automat la creare, astfel încât trebuie doar să livrezi intrarea din bara laterală care o deschide.

Prezentare generală

Aplicații

API

Autogazda

Contribuie

Puncte cheie

Proprietăți opționale

Filtre

Operanzi acceptați pentru fiecare tip de câmp

Formă de valoare per operand

Cum apar vizualizările în interfața utilizatorului

​Puncte cheie

​Proprietăți opționale

​Filtre

​Operanzi acceptați pentru fiecare tip de câmp

​Formă de valoare per operand

​Cum apar vizualizările în interfața utilizatorului

Puncte cheie

Proprietăți opționale

Filtre

Operanzi acceptați pentru fiecare tip de câmp

Formă de valoare per operand

Cum apar vizualizările în interfața utilizatorului