@fabwcie/free-drawing / @types/drawer / DrawerOptions
Type Alias: DrawerOptions
DrawerOptions =
object
Defined in: packages/free-drawing/src/@types/drawer.ts:15
Options of new Drawer($el, options), all optional (merged with defaults), see defaultOptions
Properties
autoSave
autoSave:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:71
Drawing saved on each change, else with "Save now" (default true, user preference)
collaboration
collaboration:
boolean|string|CollaborationOptions
Defined in: packages/free-drawing/src/@types/drawer.ts:41
Real time collaboration with socket.io server: false (default), true (same origin), server url or options
commandPalette
commandPalette:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:55
Command palette in menu and with Ctrl / Cmd + K: search and run tools and commands (default true)
edges
edges:
Edges
Defined in: packages/free-drawing/src/@types/drawer.ts:35
Corners of rectangles: 'sharp' (default), 'round' (radius following rectangle size) or radius (px)
fillColor
fillColor:
ColorLike
Defined in: packages/free-drawing/src/@types/drawer.ts:33
Background color of new rectangles and ellipses, 'transparent' for none (default)
height
height:
number
Defined in: packages/free-drawing/src/@types/drawer.ts:23
Height of drawer (px, default window height)
id
id:
string
Defined in: packages/free-drawing/src/@types/drawer.ts:17
Id of drawer, unique for each drawer of a page: prefix of links to drawings (#<id>=...)
keepTool
keepTool:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:73
Drawing tool kept after drawing a shape, else selection tool activated, nothing selected (user preference)
language
language:
Language|"auto"
Defined in: packages/free-drawing/src/@types/drawer.ts:59
Language of interface: 'auto' (browser one, default), 'en', 'fr', 'es' or 'de', the one chosen in menu is saved
layersPanel
layersPanel:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:63
Layers panel listing shapes (select, rename, reorder, lock, hide, delete), button in header (default true)
localStorageKey
localStorageKey:
string
Defined in: packages/free-drawing/src/@types/drawer.ts:75
Key of the drawing in localStorage and prefix of other saved data (tool, preferences...), unique for each drawer
opacity
opacity:
number
Defined in: packages/free-drawing/src/@types/drawer.ts:37
Opacity of new shapes, from 0 to 1 (default 1)
positionWidget
positionWidget:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:51
Show view position (x / y) with a button back to origin, not to get lost when moving (default true)
readOnly
readOnly:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:67
Drawing can't be modified by user (only pan, zoom, view options, export), API methods still modify it (default false)
saveButton
saveButton:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:65
Button in header saving the drawing while auto save is off, a dot shows unsaved changes (default true)
scaling
scaling:
number
Defined in: packages/free-drawing/src/@types/drawer.ts:69
Zoom factor of one wheel step (default 1.11)
selectionMenu
selectionMenu:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:53
Show a menu next to selected shapes: duplicate, rotate, bring forward, send backward, lock, delete (default true)
storage
storage:
DrawerStorage|null
Defined in: packages/free-drawing/src/@types/drawer.ts:79
Storage of drawing instead of localStorage (e.g. server of the app), see DrawerStorage
strokeColor
strokeColor:
ColorLike
Defined in: packages/free-drawing/src/@types/drawer.ts:31
Stroke color of new shapes (default '#000')
strokeDash?
optionalstrokeDash?:number[]
Defined in: packages/free-drawing/src/@types/drawer.ts:29
Deprecated
use strokeStyle (a dash array gives 'dashed')
strokeStyle
strokeStyle:
StrokeStyle
Defined in: packages/free-drawing/src/@types/drawer.ts:27
Stroke style of lines, arrows, rectangles and ellipses (default 'solid'), dashes and dots follow stroke width
strokeWidth
strokeWidth:
number
Defined in: packages/free-drawing/src/@types/drawer.ts:25
Stroke width of new shapes (px, default 5)
textStyle
textStyle:
TextStyle
Defined in: packages/free-drawing/src/@types/drawer.ts:39
Style of new texts (font, size, style, decoration, alignment)
theme
theme:
Theme
Defined in: packages/free-drawing/src/@types/drawer.ts:57
Theme: 'light' (default), 'dark' or 'system' (device one), the one chosen in menu is saved and used instead
tool
tool:
AvailableTools
Defined in: packages/free-drawing/src/@types/drawer.ts:19
Tool activated on init (default 'brush'), the last one used is restored with a drawing saved in localStorage
translations
translations:
CustomTranslations
Defined in: packages/free-drawing/src/@types/drawer.ts:61
Texts replacing default ones, by language (e.g. { fr: { 'menu.open': 'Ouvrir un dessin' } })
user
user:
DrawerUser|null
Defined in: packages/free-drawing/src/@types/drawer.ts:77
User of the app (e.g. logged in): id and name used in collaboration sessions instead of ones kept in browser
widgetGroups
widgetGroups:
WidgetGroupOptions[]
Defined in: packages/free-drawing/src/@types/drawer.ts:45
Groups of toolbar widgets, e.g. [{ widgets: ['line', 'square', 'circle', 'arrow'], title: 'Shapes' }]
widgets
widgets:
WidgetsOptions
Defined in: packages/free-drawing/src/@types/drawer.ts:43
Widgets of toolbar: list (e.g. ['brush', 'eraser']) or object with widget options (e.g. { brush: {} })
width
width:
number
Defined in: packages/free-drawing/src/@types/drawer.ts:21
Width of drawer (px, default window width)
zoom
zoom:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:47
Zoom with Ctrl + mouse wheel (or trackpad pinch) around pointer (default true)
zoomWidget
zoomWidget:
boolean
Defined in: packages/free-drawing/src/@types/drawer.ts:49
Zoom buttons and level in footer (default true)