Class WorkplaceDataNodeMetadata

Метаданные представления размещенного в рабочем месте.

Hierarchy

WorkplaceDataComponentMetadata
- WorkplaceDataNodeMetadata

Implements

IWorkplaceDataNodeMetadata

Constructors

constructor

new WorkplaceDataNodeMetadata(): WorkplaceDataNodeMetadata
Returns WorkplaceDataNodeMetadata
Overrides WorkplaceDataComponentMetadata.constructor
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:40

Properties

alias

alias: string = ''

Алиас элемента метаданных.

autoSelectFirstRowMode

autoSelectFirstRowMode: AutoSelectFirstRowMode = AutoSelectFirstRowMode.InViewDefined

Автоматический выбор первой строки при открытии представления.

caption

caption: string = ''

Заголовок объекта.

collapseGroupsMode

collapseGroupsMode: CollapseGroupsMode = CollapseGroupsMode.InViewDefined

Режим сворачивания группировок при открытии представления.

enableAutoWidth

enableAutoWidth: boolean = false

Признак автоматического расчета столбцов таблицы.

expandedIconName

expandedIconName: string = ''

Имя значка отображаемого в развернутом режиме.

expandingMode

expandingMode: ExpandingMode = ExpandingMode.Collapsed

Режим отображения объектом дочерних элементов.

iconName

iconName: string = ''

Имя значка отображаемого в обычном режиме.

isNode

isNode: boolean = false

Признак того, что представление является узлом рабочего места.

isOwnedByUser

isOwnedByUser: boolean = false

Владельцем является текущий пользователь.

multiSelect

multiSelect: ViewMultipleSelectionMode = ViewMultipleSelectionMode.Default

Признак возможности множественного выбора строк.

nodeClientVisibility

nodeClientVisibility: NodeClientVisibility = NodeClientVisibility.Always

Видимость узла для клиентского приложения.

orderPos

orderPos: number = 0

Номер позиции элемента в списке.

Deprecated

parentCompositionId

parentCompositionId: string = Guid.empty

Идентификатор родительского элемента метаданных.

rowCounterVisibility

rowCounterVisibility: RowCounterVisibility = RowCounterVisibility.InViewDefined

Режим отображения счетчика количества строк.

scopeName

scopeName: string = ''

Имя области настроек.

selectionMode

selectionMode: ViewSelectionMode = ViewSelectionMode.Row

Режим выделения элементов представления.

showMode

showMode: ShowMode = ShowMode.Always

Режим отображения элемента.

titleVisibility

titleVisibility: TitleVisibility = TitleVisibility.All

Режим отображения заголовка таблицы.

Accessors

compositionId

get compositionId(): string
Уникальный идентификатор элемента.

Returns string
Implementation of IWorkplaceDataNodeMetadata.compositionId

Inherited from WorkplaceDataComponentMetadata.compositionId
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:57
set compositionId(value: string): void
Уникальный идентификатор элемента.
Parameters
- value: string
Returns void
Implementation of IWorkplaceDataNodeMetadata.compositionId

Inherited from WorkplaceDataComponentMetadata.compositionId
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:60

dataSourceMetadata

get dataSourceMetadata(): IWorkplaceDataSourceMetadata
Метаданные представления.

Returns IWorkplaceDataSourceMetadata
Implementation of IWorkplaceDataNodeMetadata.dataSourceMetadata
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:74
set dataSourceMetadata(value: IWorkplaceDataSourceMetadata): void
Метаданные представления.
Parameters
- value: IWorkplaceDataSourceMetadata
Returns void
Implementation of IWorkplaceDataNodeMetadata.dataSourceMetadata
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:77

extensions

get extensions(): IDictionary<IViewExtensionMetadata>
Список имен типов расширений.

Returns IDictionary<IViewExtensionMetadata>
Implementation of IWorkplaceDataNodeMetadata.extensions

Inherited from WorkplaceDataComponentMetadata.extensions
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:49

items

get items(): IList<IWorkplaceComponentMetadata>
Вложенные элементы.

Returns IList<IWorkplaceComponentMetadata>
Implementation of IWorkplaceDataNodeMetadata.items

Inherited from WorkplaceDataComponentMetadata.items
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:31

layout

get layout(): null | IWorkplaceLayoutMetadata
Макет.

Returns null | IWorkplaceLayoutMetadata
Implementation of IWorkplaceDataNodeMetadata.layout

Inherited from WorkplaceDataComponentMetadata.layout
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataComponentMetadata.ts:57

nodes

get nodes(): IReadonlyList<IWorkplaceFolderNodeMetadata>
Список метаданных привязанных к узлу папок.

Returns IReadonlyList<IWorkplaceFolderNodeMetadata>
Implementation of IWorkplaceDataNodeMetadata.nodes

Inherited from WorkplaceDataComponentMetadata.nodes
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataComponentMetadata.ts:69

parameters

get parameters(): ViewRequestParameter[]
Список параметров.

Returns ViewRequestParameter[]
Implementation of IWorkplaceDataNodeMetadata.parameters
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:62
set parameters(value: ViewRequestParameter[]): void
Список параметров.
Parameters
- value: ViewRequestParameter[]
Returns void
Implementation of IWorkplaceDataNodeMetadata.parameters
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:65

parametersByState

get parametersByState(): IDictionary<ViewRequestParameter[]>
Список параметров по состоянию.

Returns IDictionary<ViewRequestParameter[]>
Implementation of IWorkplaceDataNodeMetadata.parametersByState
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:69

references

get references(): IWorkplaceViewReferenceMetadata[]
Коллекция настроек ссылок представления для узла рабочего места.

Returns IWorkplaceViewReferenceMetadata[]
Implementation of IWorkplaceDataNodeMetadata.references
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:93
set references(value: IWorkplaceViewReferenceMetadata[]): void
Коллекция настроек ссылок представления для узла рабочего места.
Parameters
- value: IWorkplaceViewReferenceMetadata[]
Returns void
Implementation of IWorkplaceDataNodeMetadata.references
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:96

searchQueries

get searchQueries(): IReadonlyList<IWorkplaceSearchQueryMetadata>
Список метаданных привязанных к узлу метаданных поисковых запросов.

Returns IReadonlyList<IWorkplaceSearchQueryMetadata>
Implementation of IWorkplaceDataNodeMetadata.searchQueries

Inherited from WorkplaceDataComponentMetadata.searchQueries
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataComponentMetadata.ts:73

subsetsSettings

get subsetsSettings(): IReadonlyList<IWorkplaceViewSubsetMetadata>
Список настроек отображения подмножеств.

Returns IReadonlyList<IWorkplaceViewSubsetMetadata>
Implementation of IWorkplaceDataNodeMetadata.subsetsSettings

Inherited from WorkplaceDataComponentMetadata.subsetsSettings
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataComponentMetadata.ts:63

typeName

get typeName(): string
Имя типа на серверной стороне.

Returns string
Implementation of IWorkplaceDataNodeMetadata.typeName

Inherited from WorkplaceDataComponentMetadata.typeName
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:68

views

get views(): IReadonlyList<IWorkplaceDataNodeMetadata>
Список метаданных представлений привязанных к рабочему месту.

Returns IReadonlyList<IWorkplaceDataNodeMetadata>
Implementation of IWorkplaceDataNodeMetadata.views

Inherited from WorkplaceDataComponentMetadata.views
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataComponentMetadata.ts:79

Methods

clone

clone(): WorkplaceDataNodeMetadata
Returns WorkplaceDataNodeMetadata
- Defined in @tessa/platform/src/workplaces/metadata/workplaceDataNodeMetadata.ts:196

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): WorkplaceDataNodeMetadata
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns WorkplaceDataNodeMetadata
Implementation of IWorkplaceDataNodeMetadata.deserializeFromStorage

Inherited from WorkplaceDataComponentMetadata.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

isSealed

isSealed(): boolean
Returns boolean
Implementation of IWorkplaceDataNodeMetadata.isSealed

Inherited from WorkplaceDataComponentMetadata.isSealed
- Defined in @tessa/core/src/serialization/storageSerializable.ts:102

seal

seal(): WorkplaceDataNodeMetadata
Returns WorkplaceDataNodeMetadata
Implementation of IWorkplaceDataNodeMetadata.seal

Inherited from WorkplaceDataComponentMetadata.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Implementation of IWorkplaceDataNodeMetadata.serializeToStorage

Inherited from WorkplaceDataComponentMetadata.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

visit

visit(visitor: IWorkplaceMetadataVisitor): void
Deprecated
use visitAsync
Parameters
- visitor: IWorkplaceMetadataVisitor
Returns void
Implementation of IWorkplaceDataNodeMetadata.visit

Inherited from WorkplaceDataComponentMetadata.visit
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:67

visitAsync

visitAsync(visitor: IWorkplaceMetadataVisitorAsync): Promise<void>
Выполняет проход по дереву рабочих мест.
Parameters
- visitor: IWorkplaceMetadataVisitorAsync
  
  Объект, выполняющий операции над узлами.
Returns Promise<void>
Implementation of IWorkplaceDataNodeMetadata.visitAsync

Inherited from WorkplaceDataComponentMetadata.visitAsync
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:42

Class WorkplaceDataNodeMetadata

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkplaceDataNodeMetadata

Properties

alias

autoSelectFirstRowMode

caption

collapseGroupsMode

enableAutoWidth

expandedIconName

expandingMode

iconName

isNode

isOwnedByUser

multiSelect

nodeClientVisibility

orderPos

Deprecated

parentCompositionId

rowCounterVisibility

scopeName

selectionMode

showMode

titleVisibility

Accessors

compositionId

Returns string

Parameters

value: string

Returns void

dataSourceMetadata

Returns IWorkplaceDataSourceMetadata

Parameters

value: IWorkplaceDataSourceMetadata

Returns void

extensions

Returns IDictionary<IViewExtensionMetadata>

items

Returns IList<IWorkplaceComponentMetadata>

layout

Returns null | IWorkplaceLayoutMetadata

nodes

Returns IReadonlyList<IWorkplaceFolderNodeMetadata>

parameters

Returns ViewRequestParameter[]

Parameters

value: ViewRequestParameter[]

Returns void

parametersByState

Returns IDictionary<ViewRequestParameter[]>

references

Returns IWorkplaceViewReferenceMetadata[]

Parameters

value: IWorkplaceViewReferenceMetadata[]

Returns void

searchQueries

Returns IReadonlyList<IWorkplaceSearchQueryMetadata>

subsetsSettings

Returns IReadonlyList<IWorkplaceViewSubsetMetadata>

typeName

Returns string

views

Returns IReadonlyList<IWorkplaceDataNodeMetadata>

Methods

clone

Returns WorkplaceDataNodeMetadata

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns WorkplaceDataNodeMetadata

isSealed

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext