Interface IWorkplaceMetadata

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

interface IWorkplaceMetadata {
    alias: string;
    compositionId: string;
    emptyFoldersVisible: boolean;
    expandedIconName: string;
    extensions: IDictionary<IViewExtensionMetadata>;
    formatVersion: number;
    iconName: string;
    isOwnedByUser: boolean;
    items: IList<IWorkplaceComponentMetadata>;
    leftSideWidth: number;
    nodes: IReadonlyList<IWorkplaceFolderNodeMetadata>;
    orderPos: number;
    parentCompositionId: string;
    searchQueries: IReadonlyList<IWorkplaceSearchQueryMetadata>;
    treeVisibility: boolean;
    typeName: string;
    version: number;
    views: IReadonlyList<IWorkplaceDataNodeMetadata>;
    clone(): IWorkplaceMetadata;
    deserializeFromStorage(
        storage: IStorage,
        context?: StorageSerializableContext,
    ): this;
    isSealed(): boolean;
    seal(): this;
    serializeToStorage(
        storage?: IStorage,
        context?: StorageSerializableContext,
    ): IStorage;
    visit(visitor: IWorkplaceMetadataVisitor): void;
    visitAsync(visitor: IWorkplaceMetadataVisitorAsync): Promise<void>;
}

Hierarchy (View Summary)

IWorkplaceCompositeMetadata
ICloneable<IWorkplaceMetadata>
- IWorkplaceMetadata

Implemented by

WorkplaceMetadata

Properties

alias

alias: string

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

compositionId

compositionId: string

Уникальный идентификатор элемента.

emptyFoldersVisible

emptyFoldersVisible: boolean

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

expandedIconName

expandedIconName: string

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

`Readonly`extensions

extensions: IDictionary<IViewExtensionMetadata>

Список имен типов расширений.

`Readonly`formatVersion

formatVersion: number

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

iconName

iconName: string

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

isOwnedByUser

isOwnedByUser: boolean

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

`Readonly`items

items: IList<IWorkplaceComponentMetadata>

Вложенные элементы.

leftSideWidth

leftSideWidth: number

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

`Readonly`nodes

nodes: IReadonlyList<IWorkplaceFolderNodeMetadata>

Список метаданных привязанных к узлу папок.

orderPos

orderPos: number

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

Deprecated

parentCompositionId

parentCompositionId: string

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

`Readonly`searchQueries

searchQueries: IReadonlyList<IWorkplaceSearchQueryMetadata>

Список метаданных привязанных к узлу метаданных поисковых запросов.

treeVisibility

treeVisibility: boolean

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

`Readonly`typeName

typeName: string

Имя типа на серверной стороне.

version

version: number

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

`Readonly`views

views: IReadonlyList<IWorkplaceDataNodeMetadata>

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

Methods

clone

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

Returns IWorkplaceMetadata
Inherited from ICloneable.clone
- Defined in @tessa/core/src/common/cloneable.ts:10

deserializeFromStorage

deserializeFromStorage(
storage: IStorage,
context?: StorageSerializableContext,
): this
Parameters
- storage: IStorage
- Optionalcontext: StorageSerializableContext
Returns this
Inherited from IWorkplaceCompositeMetadata.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:8

isSealed

isSealed(): boolean
Returns boolean
Inherited from IWorkplaceCompositeMetadata.isSealed
- Defined in @tessa/core/src/common/sealable.ts:5

seal

seal(): this
Returns this
Inherited from IWorkplaceCompositeMetadata.seal
- Defined in @tessa/core/src/common/sealable.ts:4

serializeToStorage

serializeToStorage(
storage?: IStorage,
context?: StorageSerializableContext,
): IStorage
Parameters
- Optionalstorage: IStorage
- Optionalcontext: StorageSerializableContext
Returns IStorage
Inherited from IWorkplaceCompositeMetadata.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:7

visit

visit(visitor: IWorkplaceMetadataVisitor): void
Parameters
- visitor: IWorkplaceMetadataVisitor
Returns void
Deprecated
use visitAsync
Inherited from IWorkplaceCompositeMetadata.visit
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadataTypes.ts:71

visitAsync

visitAsync(visitor: IWorkplaceMetadataVisitorAsync): Promise<void>
Выполняет проход по дереву рабочих мест.
Parameters
- visitor: IWorkplaceMetadataVisitorAsync
  Объект, выполняющий операции над узлами.
Returns Promise<void>
Inherited from IWorkplaceCompositeMetadata.visitAsync
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadataTypes.ts:69

Interface IWorkplaceMetadata

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

alias

compositionId

emptyFoldersVisible

expandedIconName

Readonlyextensions

ReadonlyformatVersion

iconName

isOwnedByUser

Readonlyitems

leftSideWidth

Readonlynodes

orderPos

Deprecated

parentCompositionId

ReadonlysearchQueries

treeVisibility

ReadonlytypeName

version

Readonlyviews

Methods

clone

Returns IWorkplaceMetadata

deserializeFromStorage

Parameters

Returns this

isSealed

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

visit

Parameters

Returns void

Deprecated

visitAsync

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`extensions

`Readonly`formatVersion

`Readonly`items

`Readonly`nodes

`Readonly`searchQueries

`Readonly`typeName

`Readonly`views