|
@@ -11,7 +11,7 @@ The [Entity-relationship model](https://en.wikipedia.org/wiki/Entity%E2%80%93rel
|
|
|
events="entity-clicked:name"
|
|
events="entity-clicked:name"
|
|
|
/>}}
|
|
/>}}
|
|
|
|
|
|
|
|
-### Import
|
|
|
|
|
|
|
+## Import
|
|
|
|
|
|
|
|
Please refer [here](/developer/components/#using-ui-components-in-your-project) for importing the component in your own project. Also [er-diagram-demo](https://github.com/cloudera/hue/tree/master/tools/examples/components/er-diagram-demo) app have working examples.
|
|
Please refer [here](/developer/components/#using-ui-components-in-your-project) for importing the component in your own project. Also [er-diagram-demo](https://github.com/cloudera/hue/tree/master/tools/examples/components/er-diagram-demo) app have working examples.
|
|
|
|
|
|
|
@@ -19,18 +19,18 @@ Once imported `er-diagram` can be used like a native HTML tag.
|
|
|
|
|
|
|
|
<er-diagram id="erd-element-id"/>
|
|
<er-diagram id="erd-element-id"/>
|
|
|
|
|
|
|
|
-### Attributes
|
|
|
|
|
|
|
+## Attributes
|
|
|
|
|
|
|
|
- entities: Array <[IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)> - An array of entity objects. Each entity will be a box in the UI.
|
|
- entities: Array <[IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)> - An array of entity objects. Each entity will be a box in the UI.
|
|
|
- relations: Array <[IRelation](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L26)> - An array of relation objects. Each relation will connect two of the above entities.
|
|
- relations: Array <[IRelation](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L26)> - An array of relation objects. Each relation will connect two of the above entities.
|
|
|
|
|
|
|
|
Please refer the [interfaces](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts) for an idea on the structure of these objects.
|
|
Please refer the [interfaces](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts) for an idea on the structure of these objects.
|
|
|
|
|
|
|
|
-### Events
|
|
|
|
|
|
|
+## Events
|
|
|
|
|
|
|
|
- entity-clicked: Function([IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)) - Will be triggered when an entity is clicked.
|
|
- entity-clicked: Function([IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)) - Will be triggered when an entity is clicked.
|
|
|
|
|
|
|
|
-#### Resource Files
|
|
|
|
|
|
|
+### Resource Files
|
|
|
|
|
|
|
|
- Hue
|
|
- Hue
|
|
|
- **Web Component:** gethue/web/er-diagram.js
|
|
- **Web Component:** gethue/web/er-diagram.js
|