Merge pull request #4729 from joeskeen/master

docs(expandable): add documentation for row.isExpanded

Author: PaulL1

src/features/expandable/js/expandable.js

@@ -97,6 +97,12 @@
  *
  * @description Public Api for expandable feature
  */
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:GridRow
+ * 
+ * @description Additional properties added to GridRow when using the expandable module
+ */
  /**
  * @ngdoc object
  * @name ui.grid.expandable.api:GridOptions
@@ -191,6 +197,20 @@
  toggleRowExpansion: function (grid, row) {
  // trigger the "before change" event. Can change row height dynamically this way.
  grid.api.expandable.raise.rowExpandedBeforeStateChanged(row);
+ /**
+ * @ngdoc object
+ * @name isExpanded
+ * @propertyOf ui.grid.expandable.api:GridRow
+ * @description Whether or not the row is currently expanded.
+ * @example
+ * <pre>
+ * $scope.api.expandable.on.rowExpandedStateChanged($scope, function (row) {
+ * if (row.isExpanded) {
+ * //...
+ * }
+ * });
+ * </pre>
+ */
  row.isExpanded = !row.isExpanded;
  if (angular.isUndefined(row.expandedRowHeight)){
  row.expandedRowHeight = grid.options.expandableRowHeight;