Skip to main content

types

Enumerations​

Marker​

Defined in: models/types.ts:4

A marker shape (see marker atlas)

Enumeration Members​

Arrow​

Arrow: 13

Defined in: models/types.ts:18

Clobber​

Clobber: 5

Defined in: models/types.ts:10

Cross​

Cross: 0

Defined in: models/types.ts:5

Diamond​

Diamond: 1

Defined in: models/types.ts:6

Disc​

Disc: 6

Defined in: models/types.ts:11

Gaussian​

Gaussian: 14

Defined in: models/types.ts:19

HBar​

HBar: 7

Defined in: models/types.ts:12

Ring​

Ring: 11

Defined in: models/types.ts:16

Square​

Square: 2

Defined in: models/types.ts:7

Star​

Star: 4

Defined in: models/types.ts:9

TailedArrow​

TailedArrow: 9

Defined in: models/types.ts:14

TriangleDown​

TriangleDown: 10

Defined in: models/types.ts:15

TriangleUp​

TriangleUp: 3

Defined in: models/types.ts:8

VBar​

VBar: 8

Defined in: models/types.ts:13

X​

X: 12

Defined in: models/types.ts:17

Type Aliases​

Color​

Color = object

Defined in: models/types.ts:27

A color in RGB format

Properties​

b​

b: number

Defined in: models/types.ts:35

Blue component, between 0 and 255

g​

g: number

Defined in: models/types.ts:32

Green component, between 0 and 255

r​

r: number

Defined in: models/types.ts:29

Red component, between 0 and 255

DrawOptions​

DrawOptions = object

Defined in: models/types.ts:94

WebGL draw options

Properties​

pointSizeFactor​

pointSizeFactor: number

Defined in: models/types.ts:96

Point size factor (defaults to 1.0)

SimilarityTransform​

SimilarityTransform = object

Defined in: models/types.ts:79

Similarity transform

Properties​

rotation​

rotation: number

Defined in: models/types.ts:84

Rotation around origin, in degrees

scale​

scale: number

Defined in: models/types.ts:81

Scale factor

translation​

translation: object

Defined in: models/types.ts:87

Translation, applied after scaling and rotation

x​

x: number

y​

y: number

TableGroupsColumn​

TableGroupsColumn = object

Defined in: models/types.ts:63

Link to a table column that holds groups

Properties​

groupsCol​

groupsCol: string

Defined in: models/types.ts:68

Groups column

tableId​

tableId: string

Defined in: models/types.ts:65

Table ID

TableValuesColumn​

TableValuesColumn = object

Defined in: models/types.ts:47

Link to a table column that holds values

Properties​

tableId​

tableId: string

Defined in: models/types.ts:49

Table ID

valuesCol​

valuesCol: string

Defined in: models/types.ts:52

Values column

ViewerOptions​

ViewerOptions = Exclude<OpenSeadragon.Options, "element">

Defined in: models/types.ts:91

OpenSeadragon viewer options

Functions​

isColor()​

isColor(x): x is Color

Defined in: models/types.ts:38

Parameters​

x​

unknown

Returns​

x is Color

isMarker()​

isMarker(x): x is Marker

Defined in: models/types.ts:22

Parameters​

x​

unknown

Returns​

x is Marker

isTableGroupsColumn()​

isTableGroupsColumn(x): x is TableGroupsColumn

Defined in: models/types.ts:71

Parameters​

x​

unknown

Returns​

x is TableGroupsColumn

isTableValuesColumn()​

isTableValuesColumn(x): x is TableValuesColumn

Defined in: models/types.ts:55

Parameters​

x​

unknown

Returns​

x is TableValuesColumn