aboutsummaryrefslogtreecommitdiffstats
path: root/vaadin-grid/vaadin-grid-doc.html
diff options
context:
space:
mode:
Diffstat (limited to 'vaadin-grid/vaadin-grid-doc.html')
-rw-r--r--vaadin-grid/vaadin-grid-doc.html49
1 files changed, 46 insertions, 3 deletions
diff --git a/vaadin-grid/vaadin-grid-doc.html b/vaadin-grid/vaadin-grid-doc.html
index c7f8ab2..2201e97 100644
--- a/vaadin-grid/vaadin-grid-doc.html
+++ b/vaadin-grid/vaadin-grid-doc.html
@@ -74,7 +74,38 @@
* @param {Cell} cell - Reference to the cell being rendered.
* @type {function}
*/
- renderer: function(cell) {}
+ renderer: function(cell) {},
+ /**
+ * Set whether it is possible for the user to hide this column or not.
+ *
+ * Attribute: `hidable`
+ *
+ * @property {boolean} hidable
+ * @type {boolean}
+ * @default false
+ */
+ hidable: false,
+ /**
+ * Hides or shows the column. By default columns are visible before
+ * explicitly hiding them.
+ *
+ * Attribute: `hidden`
+ *
+ * @property {boolean} hidden
+ * @type {boolean}
+ * @default false
+ */
+ hidden: false,
+ /**
+ * Sets the hiding toggle's caption for this column. Shown in the toggle
+ * for this column in the grid's sidebar when the column is hidable.
+ *
+ * Attribute: `hiding-toggle-text`
+ *
+ * @property {String} hidingToggleText
+ * @type {String}
+ */
+ hidingToggleText: String
}
});
</script>
@@ -132,7 +163,19 @@ Object for accessing and controlling data source used in the grid.
*
* @type {Function}
*/
- clearCache: Function
+ clearCache: Function,
+
+ /**
+ * Invokes the callback with row data of the provided row index as the
+ * parameter. If the row is not cached, it's fetched from the data source
+ * first.
+ *
+ * @method getItem
+ * @param {number} rowIndex - Index of the row.
+ * @param {Function} callback - Gets arguments (err, item) where item is the desired data item.
+ * @param {boolean} onlyCached - Only fetch cached rows (don't fall back to data source request).
+ */
+ getItem: Function
}
});
</script>
@@ -345,7 +388,7 @@ Object referencing to a row and it's data.
*/
data: Object,
/**
- * Reference to the &lt;v-grid> element
+ * Reference to the &lt;vaadin-grid> element
*
* @property {HTMLElement} grid
* @type {HTMLElement}