Browse Source

Update layers jsdoc

pull/4427/head
Artur Arseniev 4 years ago
parent
commit
f54c64c749
  1. 6
      docs/api/layer_manager.md
  2. 2
      src/navigator/index.ts

6
docs/api/layer_manager.md

@ -44,7 +44,7 @@ const layers = editor.Layers;
## setRoot
Update root layer with another component.
Update the root layer with another component.
### Parameters
@ -171,7 +171,7 @@ const layerData = layers.getLayerData(component);
console.log(layerData);
```
Returns **LayerData** Object containing layer data
Returns **[Object][15]** Object containing the layer data.
[1]: #setroot
@ -200,3 +200,5 @@ Returns **LayerData** Object containing layer data
[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

2
src/navigator/index.ts

@ -235,7 +235,7 @@ export default class LayerManager extends Module<typeof defaults> {
/**
* Get layer data from a component.
* @param {[Component]} component Component from which you want to read layer data.
* @returns {LayerData} Object containing layer data
* @returns {Object} Object containing the layer data.
* @example
* const component = editor.getSelected();
* const layerData = layers.getLayerData(component);

Loading…
Cancel
Save