Class Markmap

Index

Constructors

Properties

ensureView g options state styleNode svg zoom

Methods

centerNode destroy ensureVisible findElement fit getStyleContent handleClick handlePan handleZoom renderData rescale setData setHighlight setOptions toggleNode transition updateStyle create

Constructors

constructor

new Markmap(
svg: string | SVGElement | ID3SVGElement,
opts?: Partial<IMarkmapOptions>,
): Markmap
Parameters
- svg: string | SVGElement | ID3SVGElement
- Optionalopts: Partial<IMarkmapOptions>
Returns Markmap
- Defined in markmap-view/src/view.ts:72

Properties

ensureView

ensureView: (node: INode, padding?: Partial<IPadding>) => Promise<void> = ...

Type declaration

- (node: INode, padding?: Partial<IPadding>): Promise<void>
- Pan the content to make the provided node visible in the viewport.
  Parameters
  - node: INode
  - Optionalpadding: Partial<IPadding>
  Returns Promise<void>

Deprecated

Use ensureVisible instead

g

g: Selection<SVGGElement, INode, HTMLElement, INode>

options

options: {
    autoFit: boolean;
    color: (node: INode) => string;
    duration: number;
    embedGlobalCSS: boolean;
    fitRatio: number;
    id?: string;
    initialExpandLevel: number;
    lineWidth: (node: INode) => number;
    maxInitialScale: number;
    maxWidth: number;
    nodeMinHeight: number;
    paddingX: number;
    pan: boolean;
    scrollForPan: boolean;
    spacingHorizontal: number;
    spacingVertical: number;
    style?: (id: string) => string;
    toggleRecursively: boolean;
    zoom: boolean;
} = ...

state

state: IMarkmapState

styleNode

styleNode: Selection<HTMLStyleElement, INode, HTMLElement, INode>

svg

svg: ID3SVGElement

zoom

zoom: ZoomBehavior<SVGElement, INode>

Methods

centerNode

centerNode(node: INode, padding?: Partial<IPadding>): Promise<void>
Parameters
- node: INode
- Optionalpadding: Partial<IPadding>
Returns Promise<void>
- Defined in markmap-view/src/view.ts:704

destroy

destroy(): void
Returns void
- Defined in markmap-view/src/view.ts:758

ensureVisible

ensureVisible(node: INode, padding?: Partial<IPadding>): Promise<void>
Pan the content to make the provided node visible in the viewport.
Parameters
- node: INode
- Optionalpadding: Partial<IPadding>
Returns Promise<void>
- Defined in markmap-view/src/view.ts:666

findElement

findElement(node: INode): undefined | { data: INode; g: SVGGElement }
Parameters
- node: INode
Returns undefined | { data: INode; g: SVGGElement }
- Defined in markmap-view/src/view.ts:643

fit

fit(maxScale?: number): Promise<void>
Fit the content to the viewport.
Parameters
- maxScale: number = ...
Returns Promise<void>
- Defined in markmap-view/src/view.ts:618

getStyleContent

getStyleContent(): string
Returns string
- Defined in markmap-view/src/view.ts:109

handleClick

handleClick(e: MouseEvent, d: INode): void
Parameters
- e: MouseEvent
- d: INode
Returns void
- Defined in markmap-view/src/view.ts:162

handlePan

handlePan(e: WheelEvent): void
Parameters
- e: WheelEvent
Returns void
- Defined in markmap-view/src/view.ts:132

handleZoom

handleZoom(e: any): void
Parameters
- e: any
Returns void
- Defined in markmap-view/src/view.ts:127

renderData

renderData(originData?: INode): Promise<void>
Parameters
- OptionaloriginData: INode
Returns Promise<void>
- Defined in markmap-view/src/view.ts:317

rescale

rescale(scale: number): Promise<void>
Scale content with it pinned at the center of the viewport.
Parameters
- scale: number
Returns Promise<void>
- Defined in markmap-view/src/view.ts:739

setData

setData(data?: null | IPureNode, opts?: Partial<IMarkmapOptions>): Promise<void>
Parameters
- Optionaldata: null | IPureNode
- Optionalopts: Partial<IMarkmapOptions>
Returns Promise<void>
- Defined in markmap-view/src/view.ts:290

setHighlight

setHighlight(node?: null | INode): Promise<void>
Parameters
- Optionalnode: null | INode
Returns Promise<void>
- Defined in markmap-view/src/view.ts:298

setOptions

setOptions(opts?: Partial<IMarkmapOptions>): void
Parameters
- Optionalopts: Partial<IMarkmapOptions>
Returns void
- Defined in markmap-view/src/view.ts:273

toggleNode

toggleNode(data: INode, recursive?: boolean): Promise<void>
Parameters
- data: INode
- recursive: boolean = false
Returns Promise<void>
- Defined in markmap-view/src/view.ts:142

transition

transition<T extends BaseType, U, P extends BaseType, Q>(
sel: Selection<T, U, P, Q>,
): Transition<T, U, P, Q>
Type Parameters
- T extends BaseType
- U
- P extends BaseType
- Q
Parameters
- sel: Selection<T, U, P, Q>
Returns Transition<T, U, P, Q>
- Defined in markmap-view/src/view.ts:608

updateStyle

updateStyle(): void
Returns void
- Defined in markmap-view/src/view.ts:118

`Static`create

create(
    svg: string | SVGElement | ID3SVGElement,
    opts?: Partial<IMarkmapOptions>,
    data?: null | IPureNode,
): Markmap
Parameters
- svg: string | SVGElement | ID3SVGElement
- Optionalopts: Partial<IMarkmapOptions>
- data: null | IPureNode = null
Returns Markmap
- Defined in markmap-view/src/view.ts:766

Class Markmap

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Markmap

Properties

ensureView

Type declaration

Parameters

Returns Promise<void>

Deprecated

g

options

state

styleNode

svg

zoom

Methods

centerNode

Parameters

Returns Promise<void>

destroy

Returns void

ensureVisible

Parameters

Returns Promise<void>

findElement

Parameters

Returns undefined | { data: INode; g: SVGGElement }

fit

Parameters

Returns Promise<void>

getStyleContent

Returns string

handleClick

Parameters

Returns void

handlePan

Parameters

Returns void

handleZoom

Parameters

Returns void

renderData

Parameters

Returns Promise<void>

rescale

Parameters

Returns Promise<void>

setData

Parameters

Returns Promise<void>

setHighlight

Parameters

Returns Promise<void>

setOptions

Parameters

Returns void

toggleNode

Parameters

Returns Promise<void>

transition

Type Parameters

Parameters

Returns Transition<T, U, P, Q>

updateStyle

Returns void

Staticcreate

Parameters

Returns Markmap

Settings

On This Page

`Static`create