Class FamilyTreeBase

Options Methods Interfaces

Hierarchy

FamilyTreeBase
- FamilyTree

Index

Constructors

constructor

Properties

icon

Methods Event Listeners

Methods Other

Constructors

constructor

new FamilyTreeBase(): FamilyTreeBase

Returns FamilyTreeBase

Properties

Static icon

icon: { add: any; addUser: any; close: any; csv: any; details: any; edit: any; excel: any; ft: any; happy: any; link: any; pdf: any; png: any; remove: any; sad: any; share: any; svg: any; user: any; xml: any }

Type declaration

add:function
- add(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
addUser:function
- addUser(w: string | number, h: string | number, c: string | number, x?: string | number, y?: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  - Optional x: string | number
  - Optional y: string | number
  Returns string
close:function
- close(w: string | number, h: string | number, c: string | number, x?: string | number, y?: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  - Optional x: string | number
  - Optional y: string | number
  Returns string
csv:function
- csv(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
details:function
- details(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
edit:function
- edit(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
excel:function
- excel(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
ft:function
- ft(w: string | number, h: string | number, c: string | number, x?: string | number, y?: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  - Optional x: string | number
  - Optional y: string | number
  Returns string
happy:function
- happy(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
link:function
- link(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
pdf:function
- pdf(w: string | number, h: string | number, c: string): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string
  Returns string
png:function
- png(w: string | number, h: string | number, c: string): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string
  Returns string
remove:function
- remove(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
sad:function
- sad(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
share:function
- share(w: string | number, h: string | number, c: string | number, x?: string | number, y?: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  - Optional x: string | number
  - Optional y: string | number
  Returns string
svg:function
- svg(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string
user:function
- user(w: string | number, h: string | number, c: string | number, x?: string | number, y?: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  - Optional x: string | number
  - Optional y: string | number
  Returns string
xml:function
- xml(w: string | number, h: string | number, c: string | number): string
- Parameters
  - w: string | number
  - h: string | number
  - c: string | number
  Returns string

Event Listeners Methods

on

on(type: "init" | "node-tree-menu-show" | "field" | "update" | "renderbuttons" | "label" | "render-link" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "import" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "ready" | "ripple" | "node-initialized" | "node-layout", listener: (sender: FamilyTree, args?: any, args1?: any, args2?: any) => boolean | void): FamilyTree

The on() method of the OrgChart class sets up a function that will be called whenever the specified event is delivered to the target. *

Parameters
- type: "init" | "node-tree-menu-show" | "field" | "update" | "renderbuttons" | "label" | "render-link" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "import" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "ready" | "ripple" | "node-initialized" | "node-layout"
  
  A case-sensitive string representing the event type to listen for.
- listener: (sender: FamilyTree, args?: any, args1?: any, args2?: any) => boolean | void
  
  The object that receives a notification when an event of the specified type occurs. This must be a JavaScript function.
  - - (sender: FamilyTree, args?: any, args1?: any, args2?: any): boolean | void
    - Parameters
      - sender: FamilyTree
      - Optional args: any
      - Optional args1: any
      - Optional args2: any
      Returns boolean | void
Returns FamilyTree

onNodeTreeMenuShow

onNodeTreeMenuShow(listener: (args: { node: object; nodes: object[] }) => void): FamilyTree

Occurs when node tree menu button is clicked. Use this event to modify the nodes in the tree menu.
```
var family = new FamilyTree('#tree', {});
family.onNodeTreeMenuShow((args) => {  
});
```
Parameters
- listener: (args: { node: object; nodes: object[] }) => void
  - - (args: { node: object; nodes: object[] }): void
    - Parameters
      - args: { node: object; nodes: object[] }
        node: object
        nodes: object[]
      Returns void
Returns FamilyTree

onUpdateNode

onUpdateNode(listener: (args: { addNodesData: object[]; removeNodeId: string | number; updateNodesData: object[] }) => void): FamilyTree

Occurs when the node data has been updated, removed or added.
```
var family = new FamilyTree('#tree', {});
family.onUpdateNode((args) => {
//return false; to cancel the operation
});
```
Parameters
- listener: (args: { addNodesData: object[]; removeNodeId: string | number; updateNodesData: object[] }) => void
  - - (args: { addNodesData: object[]; removeNodeId: string | number; updateNodesData: object[] }): void
    - Parameters
      - args: { addNodesData: object[]; removeNodeId: string | number; updateNodesData: object[] }
        addNodesData: object[]
        removeNodeId: string | number
        updateNodesData: object[]
      Returns void
Returns FamilyTree

Other Methods

addChildAndPartnerNodes

addChildAndPartnerNodes(id: string | number, childData: object, partnerData: object, callback?: () => void, fireEvent?: boolean): void

Adds child and partner

Parameters
- id: string | number
  
  id of the existing partner node
- childData: object
  
  child data
- partnerData: object
  
  partner data
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

addChildNode

addChildNode(data: object, callback?: () => void, fireEvent?: boolean): void

Adds child

Parameters
- data: object
  
  child node data
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

addParentNode

addParentNode(childId: string | number, type: "mid" | "fid", data: object, callback?: () => void, fireEvent?: boolean): void

Adds parrent

Parameters
- childId: string | number
  
  node child id
- type: "mid" | "fid"
  
  mother or father
- data: object
  
  new added parent data
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

addPartnerAndParentNodes

addPartnerAndParentNodes(id: string | number, childIds: (string | number)[], partnerData: object, callback?: () => void, fireEvent?: boolean): void

Parameters
- id: string | number
  
  id of the existing partner node
- childIds: (string | number)[]
  
  ids of the child nodes
- partnerData: object
  
  partner data
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

addPartnerNode

addPartnerNode(data: object, callback?: () => void, fireEvent?: boolean): void

Adds partner node

data.pids partner id should be an existing id

Parameters
- data: object
  
  new added partner data
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

hideTreeMenu

hideTreeMenu(redraw: boolean, callback?: () => void): void

Hides the tree menu

Parameters
- redraw: boolean
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
Returns void

removeListener

removeListener(type: "init" | "node-tree-menu-show" | "field" | "update" | "renderbuttons" | "label" | "render-link" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "import" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "ready" | "ripple" | "node-initialized" | "node-layout" | "removed", listener?: () => void): boolean

Removes an event listener previously registered. The event listener to be removed is identified using a combination of the event type and the event listener function itself. Returns true if success and false if fail.

Parameters
- type: "init" | "node-tree-menu-show" | "field" | "update" | "renderbuttons" | "label" | "render-link" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "import" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "ready" | "ripple" | "node-initialized" | "node-layout" | "removed"
  
  A string which specifies the type of event for which to remove an event listener
- Optional listener: () => void
  
  The event listener function of the event handler to remove from the event target
  - - (): void
    - Returns void
Returns boolean

removeNode

removeNode(id: string | number, callback?: () => void, fireEvent?: boolean): void

Removes node if the node can be removed

Parameters
- id: string | number
  
  node id to be removed
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
- Optional fireEvent: boolean
  
  indicates if the update event will be called or not See doc...
Returns void

showTreeMenu

showTreeMenu(id: string | number, callback?: () => void): void

Shows tree menu

Parameters
- id: string | number
  
  node id
- Optional callback: () => void
  
  called at the end of the animation
  - - (): void
    - Returns void
Returns void

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods Event Listeners

Methods Other

Constructors

constructor

Returns FamilyTreeBase

Properties

Static icon

Type declaration

add:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

addUser:function

Parameters

w: string | number

h: string | number

c: string | number

Optional x: string | number

Optional y: string | number

Returns string

close:function

Parameters

w: string | number

h: string | number

c: string | number

Optional x: string | number

Optional y: string | number

Returns string

csv:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

details:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

edit:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

excel:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

ft:function

Parameters

w: string | number

h: string | number

c: string | number

Optional x: string | number

Optional y: string | number

Returns string

happy:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

link:function

Parameters

w: string | number

h: string | number

c: string | number

Returns string

pdf:function

Parameters