diff --git a/LICENSE b/LICENSE index 6c9a441..3981b27 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,6 @@ MIT License +Copyright (c) 2020 Mahyar Madad Copyright (c) 2020 Xuebin Dong Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 321be88..9177a1c 100644 --- a/README.md +++ b/README.md @@ -1,139 +1,19 @@ - - -# [jQuery Version](https://github.com/dabeng/OrgChart) -# [ES6 Version](http://github.com/dabeng/OrgChart.js) -# [Web Components Version](http://github.com/dabeng/OrgChart-Webcomponents) -# [Vue.js Version](https://github.com/dabeng/vue-orgchart) -# [Angular Version -- the most space-saving solution](https://github.com/dabeng/ng-orgchart) - -## Features -- expand/collapse nodes -- Allows user to change orgchart structure by drag/drop nodes -- Allows user to edit orgchart -- Supports exporting chart as a picture or pdf document -- Supports pan and zoom -- Allows user to customize the internal structure for every node - -## Props -
| Name | -Type | -Default | -Description | -
|---|---|---|---|
| chartClass | -string | -- | A css class to apply to the chart DOM node. | -
| containerClass | -string | -- | Add an optional extra class name to .orgchart-container It could end up looking like class="orgchart-container xxx yyy". | -
| collapsible | -boolean | -true | -Allows expanding/collapsing the nodes. | -
| datasource | -object | -- | datasource usded to build out structure of orgchart. | -
| draggable | -boolean | -false | -Allows dragging/dropping the nodes to the hierarchy of chart. | -
| multipleSelect | -boolean | -false | -If true, user can select multiple nodes by mouse clicking. | -
| NodeTemplate | -elementType | -- | A Component that provides the node content Markup. This is a useful prop when you want to use your own styles and markup to create a custom orgchart node. | -
| onClickChart | -function | -- | A callback fired when the orgchart is clicking. | -
| onClickNode | -function | -- | A callback fired when the node is clicking. | -
| pan | -boolean | -false | -If true, the chart can be panned. | -
| pan | -boolean | -false | -If true, the chart can be zoomed. | -
| zoominLimit | -number | -7 | -User can zoom the chart at different scales(0.5~7). | -
| zoomoutLimit | -number | -0.5 | -User can zoom the chart at different scales(0.5~7). | -
| Name | -Description | -
|---|---|
| expandAllNodes | -User can use this method to expand all the nodes. Sample code: orgchartRef.current.expandAllNodes() | -
| expandAllNodes | -User can use this method to export orgchart to png org pdf file. Sample code: orgchartRef.current.exportTo(filename, fileextension) | -