labels

Interfaces

ILabelsDataSourceModel

Defined in: models/labels.ts:32

A data source for 2D labels masks

Extends

• IDataSourceModel<TType>

Extended by

• ITIFFLabelsDataSourceModel
• IZarrLabelsDataSourceModel

Type Parameters

TType

TType extends string = string

Properties

path?

optional path: string

Defined in: models/base.ts:45

Local path (relative to workspace root)

Inherited from

IDataSourceModel.path

type

type: TType

Defined in: models/base.ts:39

Data source type

Inherited from

IDataSourceModel.type

url?

optional url: string

Defined in: models/base.ts:42

Remote URL (absolute or relative to TissUUmaps root)

Inherited from

IDataSourceModel.url

---

ILabelsLayerConfigModel

Defined in: models/labels.ts:36

A layer-specific display configuration for 2D labels masks

Extends

• ILayerConfigModel

Properties

flip?

optional flip: boolean

Defined in: models/base.ts:54

Horizontal reflection, applied before transformation (defaults to false)

Inherited from

ILayerConfigModel.flip

layerId

layerId: string

Defined in: models/labels.ts:38

Layer ID

Overrides

ILayerConfigModel.layerId

transform?

optional transform: Partial<SimilarityTransform>

Defined in: models/base.ts:57

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

Inherited from

ILayerConfigModel.transform

---

ILabelsModel

Defined in: models/labels.ts:9

A 2D labels mask

Extends

• IRenderedDataModel<ILabelsDataSourceModel, ILabelsLayerConfigModel>

Properties

colorMap?

optional colorMap: string | {[key: string]: Color; }

Defined in: models/labels.ts:15

Global color map ID or custom color map

dataSource

dataSource: ILabelsDataSourceModel

Defined in: models/base.ts:17

Data source

Inherited from

IRenderedDataModel.dataSource

id

id: string

Defined in: models/base.ts:11

ID

Inherited from

IRenderedDataModel.id

labelColor?

optional labelColor: Color | TableValuesColumn | TableGroupsColumn

Defined in: models/labels.ts:12

Color for all labels, or column containing label-wise colors/group names (defaults to random)

labelOpacity?

optional labelOpacity: number | TableValuesColumn | TableGroupsColumn

Defined in: models/labels.ts:24

Opacity for all labels, between 0 and 1, or column containing label-wise opacities/group names (defaults to 1)

labelVisibility?

optional labelVisibility: boolean | TableValuesColumn | TableGroupsColumn

Defined in: models/labels.ts:18

Visibility for all labels, or column containing label-wise visibilities/group names (defaults to true)

layerConfigs

layerConfigs: ILabelsLayerConfigModel[]

Defined in: models/base.ts:32

Layer configurations

Inherited from

IRenderedDataModel.layerConfigs

name

name: string

Defined in: models/base.ts:14

Name

Inherited from

IRenderedDataModel.name

opacity?

optional opacity: number

Defined in: models/base.ts:29

Opacity, between 0 and 1 (defaults to 1)

Inherited from

IRenderedDataModel.opacity

opacityMap?

optional opacityMap: string | {[key: string]: number; }

Defined in: models/labels.ts:27

Global opacity map ID or custom opacity map

visibility?

optional visibility: boolean

Defined in: models/base.ts:26

Visibility (defaults to true)

Inherited from

IRenderedDataModel.visibility

visibilityMap?

optional visibilityMap: string | {[key: string]: boolean; }

Defined in: models/labels.ts:21

Global visibility map ID or custom visibility map