TLInstance
Table of contents
- Properties
- brush
- canMoveCamera
- chatMessage
- currentPageId
- cursor
- devicePixelRatio
- exportBackground
- followingUserId
- highlightedUserIds
- insets
- isChangingStyle
- isChatting
- isCoarsePointer
- isDebugMode
- isFocused
- isFocusMode
- isGridMode
- isHoveringCanvas
- isPenMode
- isReadonly
- isToolLocked
- meta
- opacityForNextShape
- openMenus
- screenBounds
- scribbles
- stylesForNextShape
- zoomBrush
Public interface
TLInstance
State that is particular to a single browser tab
interface TLInstance extends BaseRecord<'instance', TLInstanceId> {}
packages/tlschema/src/records/TLInstance.ts
Properties
brush
Public propertysignature
brush: BoxModel | null
canMoveCamera
Public propertysignature
canMoveCamera: boolean
chatMessage
Public propertysignature
chatMessage: string
currentPageId
Public propertysignature
currentPageId: TLPageId
cursor
Public propertysignature
cursor: TLCursor
devicePixelRatio
Public propertysignature
devicePixelRatio: number
exportBackground
Public propertysignature
exportBackground: boolean
followingUserId
Public propertysignature
followingUserId: null | string
highlightedUserIds
Public propertysignature
highlightedUserIds: string[]
insets
Public propertysignature
insets: boolean[]
isChangingStyle
Public propertysignature
isChangingStyle: boolean
isChatting
Public propertysignature
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
isCoarsePointer: boolean
isDebugMode
Public propertysignature
isDebugMode: boolean
isFocused
Public propertysignature
isFocused: boolean
isFocusMode
Public propertysignature
isFocusMode: boolean
isGridMode
Public propertysignature
isGridMode: boolean
isHoveringCanvas
Public propertysignature
Will be null if the pointer doesn't support hovering (e.g. touch), but true or false otherwise
isHoveringCanvas: boolean | null
isPenMode
Public propertysignature
isPenMode: boolean
isReadonly
Public propertysignature
isReadonly: boolean
isToolLocked
Public propertysignature
isToolLocked: boolean
meta
Public propertysignature
meta: JsonObject
opacityForNextShape
Public propertysignature
opacityForNextShape: TLOpacityType
openMenus
Public propertysignature
openMenus: string[]
screenBounds
Public propertysignature
screenBounds: BoxModel
scribbles
Public propertysignature
scribbles: TLScribble[]
stylesForNextShape
Public propertysignature
stylesForNextShape: Record<string, unknown>
zoomBrush
Public propertysignature
zoomBrush: BoxModel | null