Table of contents

Public interface

TLInstance

State that is particular to a single browser tab

Signature
interface TLInstance extends BaseRecord<'instance', TLInstanceId> {}
References

BaseRecord, TLInstanceId

Source

packages/tlschema/src/records/TLInstance.ts


Properties

brush

Public propertysignature

Signature
brush: BoxModel | null
References

BoxModel


chatMessage

Public propertysignature

Signature
chatMessage: string

currentPageId

Public propertysignature

Signature
currentPageId: TLPageId
References

TLPageId


cursor

Public propertysignature

Signature
cursor: TLCursor
References

TLCursor


devicePixelRatio

Public propertysignature

Signature
devicePixelRatio: number

duplicateProps

Public propertysignature

Signature
duplicateProps: {
  offset: {
    x: number
    y: number
  }
  shapeIds: TLShapeId[]
} | null
References

TLShapeId


exportBackground

Public propertysignature

Signature
exportBackground: boolean

followingUserId

Public propertysignature

Signature
followingUserId: null | string

highlightedUserIds

Public propertysignature

Signature
highlightedUserIds: string[]

insets

Public propertysignature

Signature
insets: boolean[]

isChangingStyle

Public propertysignature

Signature
isChangingStyle: boolean

isChatting

Public propertysignature

Signature
isChatting: boolean

isCoarsePointer

Public propertysignature

This is whether the primary input mechanism includes a pointing device of limited accuracy, such as a finger on a touchscreen. See: https://developer.mozilla.org/en-US/docs/Web/CSS/@media/pointer

Signature
isCoarsePointer: boolean

isDebugMode

Public propertysignature

Signature
isDebugMode: boolean

isFocused

Public propertysignature

Signature
isFocused: boolean

isFocusMode

Public propertysignature

Signature
isFocusMode: boolean

isGridMode

Public propertysignature

Signature
isGridMode: boolean

isHoveringCanvas

Public propertysignature

Will be null if the pointer doesn't support hovering (e.g. touch), but true or false otherwise

Signature
isHoveringCanvas: boolean | null

isPenMode

Public propertysignature

Signature
isPenMode: boolean

isReadonly

Public propertysignature

Signature
isReadonly: boolean

isToolLocked

Public propertysignature

Signature
isToolLocked: boolean

meta

Public propertysignature

Signature
meta: JsonObject

opacityForNextShape

Public propertysignature

Signature
opacityForNextShape: TLOpacityType
References

TLOpacityType


openMenus

Public propertysignature

Signature
openMenus: string[]

screenBounds

Public propertysignature

Signature
screenBounds: BoxModel
References

BoxModel


scribbles

Public propertysignature

Signature
scribbles: TLScribble[]
References

TLScribble


stylesForNextShape

Public propertysignature

Signature
stylesForNextShape: Record<string, unknown>

zoomBrush

Public propertysignature

Signature
zoomBrush: BoxModel | null
References

BoxModel


TLINSTANCE_IDTLInstanceId