Представления

Представление — это сохранённая конфигурация того, как отображаются записи объекта: какие поля появляются, их порядок, видимость, а также применённые фильтры и группы. Используйте defineView() для поставки преднастроенных представлений вместе с вашим приложением. Каждый объект автоматически получает свое основное представление списка (таблицу “All …”, которую открывает пункт навигации OBJECT), подготавливаемое сервером — включая объекты, создаваемые вашим приложением, с одним столбцом для каждого поля, объявленного вашим приложением. Представления, которые вы определяете с помощью defineView(), всегда являются дополнительными представлениями поверх этого представления по умолчанию.

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,
    },
  ],
});

Основные моменты

objectUniversalIdentifier указывает, к какому объекту применяется это представление. Это может быть пользовательский объект, который вы определили, или стандартный объект Twenty.
Основное представление списка объекта принадлежит серверу: key устарел и игнорируется, поэтому представление из манифеста никогда не сможет на него претендовать. Добавьте элемент навигации VIEW, если вы хотите, чтобы до вашего представления можно было добраться в один клик из боковой панели.
fields управляет тем, какие столбцы отображаются и в каком порядке. Каждое поле ссылается на fieldMetadataUniversalIdentifier. Чтобы сослаться на автоматически созданное системное поле, такое как createdAt, см. раздел Targeting System Metadata.
Также вы можете определить filters, filterGroups, sorts, groups и fieldGroups для более продвинутых конфигураций.
position управляет порядком, когда для одного и того же объекта существует несколько представлений.

Необязательные свойства

Свойство	Значения	Описание
`type`	`ViewType.TABLE` (по умолчанию), `ViewType.LIST`, `ViewType.KANBAN`, `ViewType.CALENDAR`	Как записи располагаются на экране. (`FIELDS_WIDGET`, `TABLE_WIDGET`, `KANBAN_WIDGET`, `LIST_WIDGET` и `CALENDAR_WIDGET` также существуют, но используются внутри виджетов макета страницы.)
`visibility`	`ViewVisibility.WORKSPACE` (по умолчанию), `ViewVisibility.UNLISTED`	Отображается ли представление для всего рабочего пространства или скрыто из элементов выбора.
`openRecordIn`	устаревшие	Больше не используется: место открытия записей теперь является свойством объекта (`openRecordIn` в `defineObject()`); при отсутствии значения используется предпочтение каждого пользователя.
`sorts`	`{ fieldMetadataUniversalIdentifier, direction: ViewSortDirection.ASC \| DESC }[]`	Порядок сортировки по умолчанию.
`isCompact`	`boolean`	Компактное отображение строк.
`mainGroupByFieldMetadataUniversalIdentifier` + `shouldHideEmptyGroups`	—	Группировать записи (например, столбцы канбана) по полю.
`kanbanAggregateOperation`, `kanbanAggregateOperationFieldMetadataUniversalIdentifier`, `kanbanColumnWidth`	`AggregateOperations.*`	Агрегирование и ширина столбцов канбана.
`calendarLayout`, `calendarFieldMetadataUniversalIdentifier`, `calendarEndFieldMetadataUniversalIdentifier`	`ViewCalendarLayout.DAY` / `WEEK` / `MONTH`	Календарные представления: макет, поле даты, по которому размещаются записи, и необязательное поле даты окончания.

Все перечисления выше экспортируются из twenty-sdk/define.

Фильтры

Представление может поставляться с заранее примененными фильтрами. У каждого фильтра есть три координаты: поле, по которому выполняется фильтрация, операнд (как сравнивать) и значение (с чем сравнивать). Все три должны совпадать — использование операнда, который не подходит для типа поля, будет отклонено во время синхронизации.

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

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

Поддерживаемые операнды по типу поля

Тип поля	Поддерживаемые операнды
`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`

Типы полей с похожими названиями могут использовать совершенно разные операнды — типичный пример: SELECT и MULTI_SELECT.

Форма значения для каждого операнда

Поле value всегда содержит значение, сериализуемое в JSON, но ожидаемая форма зависит от операнда:

Семейство операндов	Форма значения	Пример
`IS`, `IS_NOT` для `SELECT`	массив ключей опций (строки)	`['ACTIVE', 'PENDING']`
`CONTAINS`, `DOES_NOT_CONTAIN` для `MULTI_SELECT`	массив ключей опций (строки)	`['TAG_A']`
`IS`, `IS_NOT` для `RELATION`	массив идентификаторов записей (uuid)	`['c5a1...']`
`CONTAINS`, `DOES_NOT_CONTAIN` для текстовых полей	строка	`'acme'`
`IS`, `IS_NOT` для `NUMBER`	строка (значение)	`'5'`
`IS` для `RATING` / `UUID`	строка (значение)	`'5'`
`GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`	строка (граница)	`'10'`
`IS`, `IS_BEFORE`, `IS_AFTER` для `DATE` / `DATE_TIME`	строка в формате ISO 8601	`'2025-01-01T00:00:00Z'`
`IS_EMPTY`, `IS_NOT_EMPTY`	пустая строка	`''`
`IS` для `BOOLEAN`	`'true'` или `'false'`	`'true'`

Как представления отображаются в интерфейсе

Само по себе представление недоступно из боковой панели. Чтобы оно появилось там, свяжите его с пунктом навигационного меню типа VIEW, который указывает на universalIdentifier представления. Это канонический шаблон: для каждого настраиваемого объекта при создании автоматически генерируется индексное представление по умолчанию, поэтому вам нужно только добавить элемент боковой панели, который его открывает.

Обзор

Приложения

API

Самостоятельный хостинг

Внести вклад

Основные моменты

Необязательные свойства

Фильтры

Поддерживаемые операнды по типу поля

Форма значения для каждого операнда

Как представления отображаются в интерфейсе

​Основные моменты

​Необязательные свойства

​Фильтры

​Поддерживаемые операнды по типу поля

​Форма значения для каждого операнда

​Как представления отображаются в интерфейсе

Основные моменты

Необязательные свойства

Фильтры

Поддерживаемые операнды по типу поля

Форма значения для каждого операнда

Как представления отображаются в интерфейсе