Class WorkplaceMetadata

Метаданные рабочего места.

Hierarchy

WorkplaceCompositeMetadata
- WorkplaceMetadata

Implements

IWorkplaceMetadata

Index

Constructors

constructor

new WorkplaceMetadata(): WorkplaceMetadata
Returns WorkplaceMetadata
Overrides WorkplaceCompositeMetadata.constructor
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadata.ts:30

Properties

alias

alias: string = ''

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

emptyFoldersVisible

emptyFoldersVisible: boolean = false

Признак отображения пустых папок.

expandedIconName

expandedIconName: string = ''

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

`Readonly` formatVersion

formatVersion: 3 = 3

Версия формата JSON.

iconName

iconName: string = ''

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

isOwnedByUser

isOwnedByUser: boolean = false

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

leftSideWidth

leftSideWidth: number = 285

Ширина области рабочего места.

nodeClientVisibility

nodeClientVisibility: NodeClientVisibility = NodeClientVisibility.Always

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

orderPos

orderPos: number = 0

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

Deprecated

parentCompositionId

parentCompositionId: string = Guid.empty

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

treeVisibility

treeVisibility: boolean = true

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

version

version: number = 1

Версия метаданных рабочего места.

Accessors

compositionId

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

Returns string
Implementation of IWorkplaceMetadata.compositionId

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

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

extensions

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

Returns IDictionary<IViewExtensionMetadata>
Implementation of IWorkplaceMetadata.extensions

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

items

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

Returns IList<IWorkplaceComponentMetadata>
Implementation of IWorkplaceMetadata.items

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

nodes

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

Returns IReadonlyList<IWorkplaceFolderNodeMetadata>
Implementation of IWorkplaceMetadata.nodes
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadata.ts:58

searchQueries

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

Returns IReadonlyList<IWorkplaceSearchQueryMetadata>
Implementation of IWorkplaceMetadata.searchQueries
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadata.ts:62

typeName

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

Returns string
Implementation of IWorkplaceMetadata.typeName

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

views

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

Returns IReadonlyList<IWorkplaceDataNodeMetadata>
Implementation of IWorkplaceMetadata.views
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadata.ts:68

Methods

clone

clone(): WorkplaceMetadata
Создает новый объект, который является копией текущего экземпляра.

Returns WorkplaceMetadata
Implementation of IWorkplaceMetadata.clone
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadata.ts:124

deserializeFromStorage

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

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

isSealed

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

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

seal

seal(): WorkplaceMetadata
Returns WorkplaceMetadata
Implementation of IWorkplaceMetadata.seal

Inherited from WorkplaceCompositeMetadata.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 IWorkplaceMetadata.serializeToStorage

Inherited from WorkplaceCompositeMetadata.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 IWorkplaceMetadata.visit

Inherited from WorkplaceCompositeMetadata.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 IWorkplaceMetadata.visitAsync

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

Class WorkplaceMetadata

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkplaceMetadata

Properties

alias

emptyFoldersVisible

expandedIconName

Readonly formatVersion

iconName

isOwnedByUser

leftSideWidth

nodeClientVisibility

orderPos

Deprecated

parentCompositionId

treeVisibility

version

Accessors

compositionId

Returns string

Parameters

value: string

Returns void

extensions

Returns IDictionary<IViewExtensionMetadata>

items

Returns IList<IWorkplaceComponentMetadata>

nodes

Returns IReadonlyList<IWorkplaceFolderNodeMetadata>

searchQueries

Returns IReadonlyList<IWorkplaceSearchQueryMetadata>

typeName

Returns string

views

Returns IReadonlyList<IWorkplaceDataNodeMetadata>

Methods

clone

Returns WorkplaceMetadata

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns WorkplaceMetadata

isSealed

Returns boolean

seal

Returns WorkplaceMetadata

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

visit

Deprecated

Parameters

visitor: IWorkplaceMetadataVisitor

Returns void

visitAsync

Parameters

visitor: IWorkplaceMetadataVisitorAsync

Returns Promise<void>

`Readonly` formatVersion

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext