Options interface

Home > mind-elixir > Options

Options interface

The MindElixir options

Signature:

export interface Options<M = any> 

Properties

Property	Modifiers	Type	Description
alignment?		Alignment	(Optional)
allowUndo?		boolean	(Optional)
before?		Before	(Optional)
compact?		boolean	(Optional) Compact mode. If true, distance fields will be controlled to a small value.
contextMenu?		boolean | ContextMenuOption	(Optional)
direction?		0 | 1 | 2 | 3	(Optional)
editable?		boolean	(Optional)
el		string | HTMLElement
generateMainBranch?		(this: MindElixir<M>, params: MainLineParams) => PathString	(Optional)
generateSubBranch?		(this: MindElixir<M>, params: SubLineParams) => PathString	(Optional)
handleWheel?		true | ((e: WheelEvent) => void)	(Optional)
imageProxy?		(url: string) => string	(Optional) Image proxy function to handle image URLs, mainly used to solve CORS issues If provided, all image URLs will be processed through this function before setting to img src undefined
keypress?		boolean | KeypressOptions	(Optional)
markdown?		(markdown: string, obj: NodeObj<M> | Arrow<M> | Summary) => string	(Optional) Custom markdown parser function that takes markdown string and returns HTML string If not provided, markdown will be disabled undefined
mobileMultiSelect?		boolean	(Optional) Enable mobile multi-select mode false
mouseSelectionButton?		0 | 2	(Optional)
newTopicName?		string	(Optional)
overflowHidden?		boolean	(Optional)
pasteHandler?		(e: ClipboardEvent) => void	(Optional) Custom paste handler when there are no nodes copied; undefined
rtl?		boolean	(Optional) Right-to-left text mode, for languages written right to left (Arabic, Hebrew, Persian, Urdu). Adds an rtl class to the map container, which switches node topics, the topic editor and the labels to direction: rtl and flips the offsets that are otherwise pinned to the left. This is TEXT direction only — it does not mirror the layout. Where the main branches are placed is a separate axis, see Options.direction. false
scaleMax?		number	(Optional)
scaleMin?		number	(Optional)
scaleSensitivity?		number	(Optional)
selectionContainer?		string | HTMLElement	(Optional)
theme?		Theme<M>	(Optional)
toolBar?		boolean	(Optional)