[Commits] r2519 - core/trunk/geoext/lib/GeoExt/widgets

[commits at geoext.org]

Author: ahocevar
Date: 2010-12-08 17:49:51 +0100 (Wed, 08 Dec 2010)
New Revision: 2519

Modified:
   core/trunk/geoext/lib/GeoExt/widgets/LegendPanel.js
Log:
Improved API docs: explained how to exclude layers from the LegendPanel.


Modified: core/trunk/geoext/lib/GeoExt/widgets/LegendPanel.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/LegendPanel.js	2010-12-08 15:53:52 UTC (rev 2518)
+++ core/trunk/geoext/lib/GeoExt/widgets/LegendPanel.js	2010-12-08 16:49:51 UTC (rev 2519)
@@ -23,6 +23,12 @@
  *
  *  A panel showing legends of all layers in a layer store.
  *  Depending on the layer type, a legend renderer will be chosen.
+ *
+ *  The LegendPanel will include legends for all the layers in the
+ *  ``layerStore`` it is configured with, unless the layer is configured with
+ *  ``displayInLayerSwitcher: false``, or a layer record has a
+ *  ``hideInLegend`` field with a value of false. Additional filtering can be
+ *  done by configuring a ``filter`` on the LegendPanel.
  */
 GeoExt.LegendPanel = Ext.extend(Ext.Panel, {