base

Interfaces

IDataModel

Defined in: models/base.ts:8

Base interface for all data models

Extends

• IModel

Extended by

• IRenderedDataModel
• ITableModel

Type Parameters

TDataSourceModel

TDataSourceModel extends IDataSourceModel

Properties

dataSource

dataSource: TDataSourceModel

Defined in: models/base.ts:17

Data source

id

id: string

Defined in: models/base.ts:11

ID

name

name: string

Defined in: models/base.ts:14

Name

---

IDataSourceModel

Defined in: models/base.ts:36

Base interface for all data source models

Extends

• IModel

Extended by

• IImageDataSourceModel
• ILabelsDataSourceModel
• IPointsDataSourceModel
• IShapesDataSourceModel
• ITableDataSourceModel

Type Parameters

TType

TType extends string = string

Properties

path?

optional path: string

Defined in: models/base.ts:45

Local path (relative to workspace root)

type

type: TType

Defined in: models/base.ts:39

Data source type

url?

optional url: string

Defined in: models/base.ts:42

Remote URL (absolute or relative to TissUUmaps root)

---

ILayerConfigModel

Defined in: models/base.ts:49

Base interface for all layer configuration models

Extends

• IModel

Extended by

• IImageLayerConfigModel
• ILabelsLayerConfigModel
• IPointsLayerConfigModel
• IShapesLayerConfigModel

Properties

flip?

optional flip: boolean

Defined in: models/base.ts:54

Horizontal reflection, applied before transformation (defaults to false)

layerId

layerId: string | TableValuesColumn

Defined in: models/base.ts:51

Layer ID for all items, or column containing item-wise layer IDs

transform?

optional transform: Partial<SimilarityTransform>

Defined in: models/base.ts:57

Transformation from data/object space to layer space (defaults to identity transform)

---

IModel

Defined in: models/base.ts:5

Base interface for all models

Extended by

• IDataModel
• IDataSourceModel
• ILayerConfigModel
• ILayerModel
• IProjectModel

---

IRenderedDataModel

Defined in: models/base.ts:21

Base interface for all rendered data models

Extends

• IDataModel<TDataSourceModel>

Extended by

• IImageModel
• ILabelsModel
• IPointsModel
• IShapesModel

Type Parameters

TDataSourceModel

TDataSourceModel extends IDataSourceModel

TLayerConfigModel

TLayerConfigModel extends ILayerConfigModel

Properties

dataSource

dataSource: TDataSourceModel

Defined in: models/base.ts:17

Data source

Inherited from

IDataModel.dataSource

id

id: string

Defined in: models/base.ts:11

ID

Inherited from

IDataModel.id

layerConfigs

layerConfigs: TLayerConfigModel[]

Defined in: models/base.ts:32

Layer configurations

name

name: string

Defined in: models/base.ts:14

Name

Inherited from

IDataModel.name

opacity?

optional opacity: number

Defined in: models/base.ts:29

Opacity, between 0 and 1 (defaults to 1)

visibility?

optional visibility: boolean

Defined in: models/base.ts:26

Visibility (defaults to true)