source:
trunk/workshop-routing-foss4g/web/GeoExt/docs/_sources/lib/GeoExt/data/FeatureStore.txt
@
81
Revision 76, 2.4 KB checked in by djay, 12 years ago (diff) | |
---|---|
|
Line | |
---|---|
1 | |
2 | .. currentmodule:: GeoExt.data |
3 | |
4 | :class:`GeoExt.data.FeatureStore` |
5 | ================================================================================ |
6 | |
7 | |
8 | .. cssclass:: meta |
9 | |
10 | |
11 | Extends |
12 | * `Ext.data.Store <http://dev.sencha.com/deploy/dev/docs/?class=Ext.data.Store>`_ |
13 | |
14 | |
15 | |
16 | |
17 | |
18 | |
19 | |
20 | .. class:: FeatureStore |
21 | |
22 | A store containing :class:`GeoExt.data.FeatureRecord` entries that |
23 | optionally synchronizes with an ``OpenLayers.Layer.Vector``. |
24 | |
25 | |
26 | |
27 | Example Use |
28 | ----------- |
29 | |
30 | Sample code to create a store with features from a vector layer: |
31 | |
32 | .. code-block:: javascript |
33 | |
34 | var store = new GeoExt.data.FeatureStore({ |
35 | layer: myLayer, |
36 | features: myFeatures |
37 | }); |
38 | |
39 | |
40 | |
41 | |
42 | Config Options |
43 | -------------- |
44 | |
45 | Configuration properties in addition to |
46 | those listed for `Ext.data.Store <http://dev.sencha.com/deploy/dev/docs/?class=Ext.data.Store>`_. |
47 | |
48 | |
49 | .. describe:: featureFilter |
50 | |
51 | ``OpenLayers.Filter`` This filter is evaluated before a feature |
52 | record is added to the store. |
53 | |
54 | .. describe:: features |
55 | |
56 | ``Array(OpenLayers.Feature.Vector)`` Features that will be added to the |
57 | store (and the layer if provided). |
58 | |
59 | .. describe:: initDir |
60 | |
61 | ``Number`` Bitfields specifying the direction to use for the |
62 | initial sync between the layer and the store, if set to 0 then no |
63 | initial sync is done. Default is |
64 | ``GeoExt.data.FeatureStore.LAYER_TO_STORE|GeoExt.data.FeatureStore.STORE_TO_LAYER``. |
65 | |
66 | .. describe:: layer |
67 | |
68 | ``OpenLayers.Layer.Vector`` Layer to synchronize the store with. |
69 | |
70 | .. describe:: reader |
71 | |
72 | ``Ext.data.DataReader`` The reader used to produce records from objects |
73 | features. Default is :class:`GeoExt.data.FeatureReader`. |
74 | |
75 | |
76 | |
77 | |
78 | |
79 | |
80 | Public Methods |
81 | -------------- |
82 | |
83 | Public methods in addition to those |
84 | listed for `Ext.data.Store <http://dev.sencha.com/deploy/dev/docs/?class=Ext.data.Store>`_. |
85 | |
86 | |
87 | .. method:: FeatureStore.bind |
88 | |
89 | :param layer: ``OpenLayers.Layer`` Layer that the store should be |
90 | synchronized with. |
91 | |
92 | Bind this store to a layer instance, once bound the store |
93 | is synchronized with the layer and vice-versa. |
94 | |
95 | .. method:: FeatureStore.getRecordFromFeature |
96 | |
97 | :arg feature: ``OpenLayers.Vector.Feature`` |
98 | :returns: :class:`GeoExt.data.FeatureRecord` The record corresponding |
99 | to the given feature. Returns null if no record matches. |
100 | |
101 | Get the record corresponding to a feature. |
102 | |
103 | .. method:: FeatureStore.unbind |
104 | |
105 | Unbind this store from the layer it is currently bound. |
106 | |
107 | |
108 | |
109 | |
110 |
Note: See TracBrowser
for help on using the repository browser.