Skip to content

Main Navigation Get started API Changelog Demo

Appearance

Sidebar Navigation

API

@types/drawer

Type Aliases

CollaborationOptions

ColorLike

CssColorNames

DrawerOptions

DrawerStorage

DrawerUser

DrawingShape

Edges

HEX

OptionsChange

Preferences

RGB

RGBA

ShapeOrder

StrokeStyle

TextStyle

Theme

@types/modal

Interfaces

ModalOptions

Type Aliases

ConfirmModalOptions

@types/toast

Enumerations

Types

Type Aliases

AvailableTypes

@types/toolbar

Enumerations

Tools

Type Aliases

AvailableTools

BrushWidgetOptions

WidgetGroupOptions

WidgetName

WidgetOptions

WidgetsOptions

components

Collaboration

Collaboration

Classes

Collaboration

Type Aliases

CollaborationMember

CollaborationOptions

CollaborationSocket

DrawingChange

RemotePointer

CollaborationModal

CollaborationModal

Classes

CollaborationModal

ColorPicker

ColorPicker

Classes

ColorPicker

Type Aliases

ColorPickerOptions

CommandPalette

CommandPalette

Classes

CommandPalette

Type Aliases

Command

ContextMenu

ContextMenu

Classes

ContextMenu

Dropdown

Dropdown

Classes

Dropdown

ExportModal

ExportModal

Classes

ExportModal

LayersPanel

LayersPanel

Classes

LayersPanel

Modal

ConfirmModal

Classes

ConfirmModal

constants

Variables

confirmModalDefaultOpts

defaultOptionsModal

Modal

Classes

Modal

PreferencesModal

PreferencesModal

Classes

PreferencesModal

SelectionMenu

SelectionMenu

Classes

SelectionMenu

Toast

Toast

Classes

Toast

toolbar

constants

Variables

toolbarCSSPrefix

Toolbar

Classes

Toolbar

widgets

Arrow

Arrow

BaseWidget

Classes

Type Aliases

Brush

Brush

Circle

Circle

Cloud

Cloud

Diamond

Diamond

Eraser

Eraser

Trail

Frame

Frame

FreehandWidget

Classes

Type Aliases

GroupWidget

Classes

Type Aliases

Variables

Functions

Heart

Heart

Highlighter

Highlighter

Laser

Laser

Line

Line

Pan

Pan

PathShapeWidget

Classes

Functions

Select

Select

ShapeWidget

Classes

Functions

Square

Square

Text

Text

Triangle

Triangle

tools

Help

Help

Classes

Type Aliases

Overlay

BaseOverlay

Classes

Type Aliases

BrushOverlay

BrushOverlay

HighlighterOverlay

HighlighterOverlay

SelectOverlay

SelectOverlay

ShapeOverlay

ShapeOverlay

TextOverlay

TextOverlay

Position

Position

Classes

SaveButton

SaveButton

Classes

Settings

Settings

Classes

UndoRedo

History

Classes

Type Aliases

Functions

UndoRedo

Classes

Zoom

Zoom

Classes

constants

Variables

crosshairCursor

dataAttributes

defaultOptions

deprecatedEvents

drawerEvents

edgesShapes

fillShapes

grabbingCursor

grabCursor

gridSize

historyLimit

pathShapes

shapeLabels

shapeName

strokeStyleShapes

widgetNames

zoomLimits

Drawer

Classes

Drawer

Type Aliases

ExportImageOptions

DrawerLayout

Classes

DrawerLayout

Type Aliases

LayoutItemOptions

LayoutRegion

i18n

de

Variables

de

en

Type Aliases

TranslationKey

Translations

Variables

en

es

Variables

es

fr

Variables

fr

I18n

Classes

I18n

Type Aliases

CustomTranslations

Language

Translate

TranslationParams

Variables

languages

Functions

getLanguage

utils

binding

Type Aliases

Anchor

BoundEnd

Variables

anchorAttrs

anchors

bindingAttrs

bindingMargin

Functions

findBindingTarget

getAnchorAt

getAnchorPoints

getBoundEnds

getOutlinePoint

getShapeCenter

unbindMoved

updateBindings

color

Functions

normalizeColor

toFill

toHexColor

dom

Functions

arrowNavigation

createButton

createSwitch

disableElement

enableElement

setLabel

setPressed

uniqueId

drawingFile

Type Aliases

DrawingFile

Variables

drawingFileExtension

Functions

decodeLinkData

encodeLinkData

parseDrawingFile

pickFile

saveFile

export

Type Aliases

Box

ImageFormat

ImageOptions

Functions

canvasToBlob

createPdf

getExportBox

renderCanvas

renderSvg

toDarkColor

frame

Classes

Frame

Variables

frameParts

Functions

createFrame

findFrameAt

getDrawingShape

getFrameContent

getFrameOfTitle

getFrameShapes

getFrameTitle

isFrame

isShapesContainer

moveShapeTo

setFrameLabel

setFrameSize

withFrameShapes

functions

Functions

createId

deepMerge

isObject

isTruthy

stringToNode

hit

Functions

getLockedNode

getShapes

isDrawnAt

isDrawnAtLocked

isInsideNode

isInsideOutline

isTouchedBy

rectContains

rectTouches

setupHit

HotKey

Classes

HotKey

MicroEvent

Classes

default

Type Aliases

TCallback

order

Functions

applyOrder

reorderShapes

perf

Type Aliases

ThrottledFunction

Functions

debounce

measureTime

throttle

stroke

Functions

getCornerRadius

getDash

getEdges

getStrokeStyle

text

Functions

fitTextWidth

getContentWidth

getTexts

widgets

Functions

getWidgetGroups

getWidgetNames

getWidgetOptions

On this page

@fabwcie/free-drawing / utils/hit

utils/hit

Functions

getLockedNode
getShapes
isDrawnAt
isDrawnAtLocked
isInsideNode
isInsideOutline
isTouchedBy
rectContains
rectTouches
setupHit

Pager

Previous pagestringToNode

Next pagegetLockedNode

Released under the MIT License.

Copyright © 2023-present Fabien Winkler