Class Tree<SS>

Type parameters

SS

Hierarchy

PureComponent<TreeProps, __type>
- Tree

Index

Constructors

constructor

Properties

defaultProps

Constructors

constructor

new Tree(props: TreeProps): Tree

- Defined in components/Tree.tsx:376
Parameters
- props: TreeProps
Returns Tree

Properties

Static defaultProps

defaultProps: TreeProps

Methods

Optional UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void

Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:712
Returns void

Optional UNSAFE_componentWillReceiveProps

UNSAFE_componentWillReceiveProps(nextProps: Readonly<TreeProps>, nextContext: any): void

Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:744
Parameters
- nextProps: Readonly<TreeProps>
- nextContext: any
Returns void

Optional UNSAFE_componentWillUpdate

UNSAFE_componentWillUpdate(nextProps: Readonly<TreeProps>, nextState: Readonly<__type>, nextContext: any): void

Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:772
Parameters
- nextProps: Readonly<TreeProps>
- nextState: Readonly<__type>
- nextContext: any
Returns void

Optional componentDidCatch

componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from ComponentLifecycle.componentDidCatch
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:641
Parameters
- error: Error
- errorInfo: ErrorInfo
Returns void

Optional componentDidMount

componentDidMount(): void

Inherited from ComponentLifecycle.componentDidMount
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:620
Returns void

Optional componentDidUpdate

componentDidUpdate(prevProps: Readonly<TreeProps>, prevState: Readonly<__type>, snapshot: SS): void

Inherited from NewLifecycle.componentDidUpdate
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:683
Parameters
- prevProps: Readonly<TreeProps>
- prevState: Readonly<__type>
- Optional snapshot: SS
Returns void

Optional componentWillMount

componentWillMount(): void

Inherited from DeprecatedLifecycle.componentWillMount
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:698
Returns void

Optional componentWillReceiveProps

componentWillReceiveProps(nextProps: Readonly<TreeProps>, nextContext: any): void

Inherited from DeprecatedLifecycle.componentWillReceiveProps
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:727
Parameters
- nextProps: Readonly<TreeProps>
- nextContext: any
Returns void

Optional componentWillUnmount

componentWillUnmount(): void

Inherited from ComponentLifecycle.componentWillUnmount
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:636
Returns void

Optional componentWillUpdate

componentWillUpdate(nextProps: Readonly<TreeProps>, nextState: Readonly<__type>, nextContext: any): void

Inherited from DeprecatedLifecycle.componentWillUpdate
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:757
Parameters
- nextProps: Readonly<TreeProps>
- nextState: Readonly<__type>
- nextContext: any
Returns void

Optional getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(prevProps: Readonly<TreeProps>, prevState: Readonly<__type>): SS | null

Inherited from NewLifecycle.getSnapshotBeforeUpdate
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:677
Parameters
- prevProps: Readonly<TreeProps>
- prevState: Readonly<__type>
Returns SS | null

render

render(): Element

- Defined in components/Tree.tsx:362
Returns Element

Optional shouldComponentUpdate

shouldComponentUpdate(nextProps: Readonly<TreeProps>, nextState: Readonly<__type>, nextContext: any): boolean

Inherited from ComponentLifecycle.shouldComponentUpdate
- Defined in react-wooden-tree/node_modules/@types/react/index.d.ts:631
Parameters
- nextProps: Readonly<TreeProps>
- nextState: Readonly<__type>
- nextContext: any
Returns boolean

Static addNodes

addNodes(tree: TreeDataType, nodes: TreeDataType): TreeDataType

- Defined in components/Tree.tsx:263
Parameters
- tree: TreeDataType
- nodes: TreeDataType
Returns TreeDataType

The new tree with the added nodes.

Static convertHierarchicalTree

convertHierarchicalTree(tree: HierarchicalNodeProps[]): TreeDataType

- Defined in components/Tree.tsx:81
Parameters
- tree: HierarchicalNodeProps[]
Returns TreeDataType

The plain tree structure, consumable by redux, used in the component.

Static getAncestors

getAncestors(nodeId: string): string[]

- Defined in components/Tree.tsx:273
Parameters
- nodeId: string
Returns string[]

string[] Array of node ids - the parents of the given node.

Static getDepth

getDepth(tree: TreeDataType): number

- Defined in components/Tree.tsx:313
Parameters
- tree: TreeDataType
Returns number

The max depth of the tree.

Static getDescendants

getDescendants(tree: TreeDataType, nodeId: string): string[]

- Defined in components/Tree.tsx:294
Parameters
- tree: TreeDataType
- nodeId: string
Returns string[]

string[] Array of node ids - the descendants.

Static initHierarchicalTree

initHierarchicalTree(tree: HierarchicalNodeProps[], parentID?: string): HierarchicalNodeProps[]

- Defined in components/Tree.tsx:47
Parameters
- tree: HierarchicalNodeProps[]
- Default value parentID: string = ""
Returns HierarchicalNodeProps[]

The new filled tree.

Static initTree

initTree(tree: TreeDataType): TreeDataType

- Defined in components/Tree.tsx:116
Parameters
- tree: TreeDataType
Returns TreeDataType

The new filled tree.

Static nodeChecked

nodeChecked(node: NodeProps, value: boolean): NodeProps

- Defined in components/Tree.tsx:197
Parameters
- node: NodeProps
- value: boolean
Returns NodeProps

The changed node.

Static nodeChildren

nodeChildren(node: NodeProps, value: string[]): NodeProps

- Defined in components/Tree.tsx:241
Parameters
- node: NodeProps
- value: string[]
Returns NodeProps

The changed node.

Static nodeDisabled

nodeDisabled(node: NodeProps, value: boolean): NodeProps

- Defined in components/Tree.tsx:219
Parameters
- node: NodeProps
- value: boolean
Returns NodeProps

The changed node.

Static nodeExpanded

nodeExpanded(node: NodeProps, value: boolean): NodeProps

- Defined in components/Tree.tsx:208
Parameters
- node: NodeProps
- value: boolean
Returns NodeProps

The changed node.

Static nodeLoading

nodeLoading(node: NodeProps, value: boolean): NodeProps

- Defined in components/Tree.tsx:252
Parameters
- node: NodeProps
- value: boolean
Returns NodeProps

The changed node.

Static nodeSearch

nodeSearch(tree: TreeDataType, nodeID: string, attrName: string, searchString: string): string[]

- Defined in components/Tree.tsx:147
Parameters
- tree: TreeDataType
- nodeID: string
- attrName: string
- searchString: string
Returns string[]

string[] Array of ID's where the string is present.

Static nodeSelected

nodeSelected(node: NodeProps, value: boolean): NodeProps

- Defined in components/Tree.tsx:230
Parameters
- node: NodeProps
- value: boolean
Returns NodeProps

The changed node.

Static nodeSelector

nodeSelector(tree: TreeDataType, nodeId: string): NodeProps

- Defined in components/Tree.tsx:175
Parameters
- tree: TreeDataType
- nodeId: string
Returns NodeProps

Static nodeUpdater

nodeUpdater(tree: TreeDataType, node: NodeProps): TreeDataType

- Defined in components/Tree.tsx:186
Parameters
- tree: TreeDataType
- node: NodeProps
Returns TreeDataType

Generated using TypeDoc