[76] | 1 | |
---|
| 2 | .. currentmodule:: GeoExt |
---|
| 3 | |
---|
| 4 | :class:`GeoExt.FeatureRenderer` |
---|
| 5 | ================================================================================ |
---|
| 6 | |
---|
| 7 | |
---|
| 8 | .. cssclass:: meta |
---|
| 9 | |
---|
| 10 | |
---|
| 11 | Extends |
---|
| 12 | * `Ext.BoxComponent <http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent>`_ |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | xtype |
---|
| 18 | ``gx_renderer`` |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | |
---|
| 22 | |
---|
| 23 | .. class:: FeatureRenderer(config) |
---|
| 24 | |
---|
| 25 | Create a box component for rendering a vector feature. |
---|
| 26 | |
---|
| 27 | |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | Config Options |
---|
| 32 | -------------- |
---|
| 33 | |
---|
| 34 | Configuration properties in addition to |
---|
| 35 | those listed for `Ext.BoxComponent <http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent>`_. |
---|
| 36 | |
---|
| 37 | |
---|
| 38 | .. describe:: feature |
---|
| 39 | |
---|
| 40 | ``OpenLayers.Feature.Vector`` |
---|
| 41 | Optional vector to be drawn. If not provided, and if ``symbolizers`` |
---|
| 42 | is configured with an array of plain symbolizer objects, ``symbolType`` |
---|
| 43 | should be configured. |
---|
| 44 | |
---|
| 45 | .. describe:: symbolizers |
---|
| 46 | |
---|
| 47 | ``Array(Object)`` |
---|
| 48 | An array of ``OpenLayers.Symbolizer`` instances or plain symbolizer |
---|
| 49 | objects (in painters order) for rendering a feature. If no |
---|
| 50 | symbolizers are provided, the OpenLayers default will be used. If a |
---|
| 51 | symbolizer is an instance of ``OpenLayers.Symbolizer``, its type will |
---|
| 52 | override the symbolType for rendering. |
---|
| 53 | |
---|
| 54 | .. describe:: symbolType |
---|
| 55 | |
---|
| 56 | ``String`` |
---|
| 57 | One of ``"Point"``, ``"Line"``, or ``"Polygon"``. Only pertinent if |
---|
| 58 | OpenLayers.Symbolizer objects are not used. If ``feature`` |
---|
| 59 | is provided, it will be preferred. The default is "Polygon". |
---|
| 60 | |
---|
| 61 | |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | |
---|
| 65 | |
---|
| 66 | Public Methods |
---|
| 67 | -------------- |
---|
| 68 | |
---|
| 69 | Public methods in addition to those |
---|
| 70 | listed for `Ext.BoxComponent <http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent>`_. |
---|
| 71 | |
---|
| 72 | |
---|
| 73 | .. method:: FeatureRenderer.setFeature |
---|
| 74 | |
---|
| 75 | :arg feature: ``OpenLayers.Feature.Vector`` The feature to be rendered. |
---|
| 76 | If none is provided, one will be created based on ``symbolType``. |
---|
| 77 | :arg options: ``Object`` |
---|
| 78 | |
---|
| 79 | Update the feature and redraw. |
---|
| 80 | |
---|
| 81 | Valid options: |
---|
| 82 | |
---|
| 83 | * draw - ``Boolean`` Draw the feature after setting it. Default is ``true``. |
---|
| 84 | |
---|
| 85 | .. method:: FeatureRenderer.setSymbolizers |
---|
| 86 | |
---|
| 87 | :arg symbolizers: ``Array(Object)`` An array of symbolizers |
---|
| 88 | :arg options: ``Object`` |
---|
| 89 | |
---|
| 90 | Update the symbolizers used to render the feature. |
---|
| 91 | |
---|
| 92 | Valid options: |
---|
| 93 | |
---|
| 94 | * draw - ``Boolean`` Draw the feature after setting it. Default is ``true``. |
---|
| 95 | |
---|
| 96 | .. method:: FeatureRenderer.setSymbolType |
---|
| 97 | |
---|
| 98 | :arg type: ``String`` One of the ``symbolType`` strings. |
---|
| 99 | :arg options: ``Object`` |
---|
| 100 | |
---|
| 101 | Create a new feature based on the geometry type and render it. |
---|
| 102 | |
---|
| 103 | Valid options: |
---|
| 104 | |
---|
| 105 | * draw - ``Boolean`` Draw the feature after setting it. Default is ``true``. |
---|
| 106 | |
---|
| 107 | .. method:: FeatureRenderer.update |
---|
| 108 | |
---|
| 109 | :arg options: ``Object`` Object with properties to be updated. |
---|
| 110 | |
---|
| 111 | Update the ``symbolType`` or ``feature`` and ``symbolizer`` and redraw |
---|
| 112 | the feature. |
---|
| 113 | |
---|
| 114 | Valid options: |
---|
| 115 | |
---|
| 116 | * feature - ``OpenLayers.Feature.Vector`` The new or updated feature. |
---|
| 117 | If provided, the feature gets precedence over ``symbolType``. |
---|
| 118 | * symbolType - ``String`` One of the allowed ``symbolType`` values. |
---|
| 119 | * symbolizers - ``Array(Object)`` An array of symbolizer objects. |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | Events |
---|
| 125 | ------ |
---|
| 126 | |
---|
| 127 | Events in addition to those |
---|
| 128 | listed for `Ext.BoxComponent <http://dev.sencha.com/deploy/dev/docs/?class=Ext.BoxComponent>`_. |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | .. describe:: click |
---|
| 132 | |
---|
| 133 | Fires when the feature is clicked on. |
---|
| 134 | |
---|
| 135 | Listener arguments: |
---|
| 136 | |
---|
| 137 | * renderer - :class:`GeoExt.FeatureRenderer` This feature renderer. |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|