Interface IWorkplaceSettingsMetadata

Настройки рабочего места.

interface IWorkplaceSettingsMetadata {
    alias: string;
    compositionId: string;
    emptyFoldersVisible: boolean;
    expandedIconName: string;
    extensions: IDictionary<IViewExtensionMetadata>;
    iconName: string;
    isOwnedByUser: boolean;
    leftSideWidth: number;
    orderPos: number;
    parentCompositionId: string;
    treeVisibility: null | boolean;
    typeName: string;
    workplaceId: string;
    clone(): IWorkplaceSettingsMetadata;
    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)

IWorkplaceComponentMetadata
ICloneable<IWorkplaceSettingsMetadata>
- IWorkplaceSettingsMetadata

Implemented by

WorkplaceSettingsMetadata

Properties

alias

alias: string

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

compositionId

compositionId: string

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

emptyFoldersVisible

emptyFoldersVisible: boolean

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

expandedIconName

expandedIconName: string

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

`Readonly`extensions

extensions: IDictionary<IViewExtensionMetadata>

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

iconName

iconName: string

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

isOwnedByUser

isOwnedByUser: boolean

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

leftSideWidth

leftSideWidth: number

Размер области дерева.

orderPos

orderPos: number

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

Deprecated

parentCompositionId

parentCompositionId: string

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

treeVisibility

treeVisibility: null | boolean

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

`Readonly`typeName

typeName: string

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

workplaceId

workplaceId: string

Идентификатор рабочего места.

Methods

clone

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

Returns IWorkplaceSettingsMetadata
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 IWorkplaceComponentMetadata.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:8

isSealed

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

seal

seal(): this
Returns this
Inherited from IWorkplaceComponentMetadata.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 IWorkplaceComponentMetadata.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 IWorkplaceComponentMetadata.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 IWorkplaceComponentMetadata.visitAsync
- Defined in @tessa/platform/src/workplaces/metadata/workplaceMetadataTypes.ts:69

Interface IWorkplaceSettingsMetadata

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

alias

compositionId

emptyFoldersVisible

expandedIconName

Readonlyextensions

iconName

isOwnedByUser

leftSideWidth

orderPos

Deprecated

parentCompositionId

treeVisibility

ReadonlytypeName

workplaceId

Methods

clone

Returns IWorkplaceSettingsMetadata

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`typeName