[docs/models][s]: add list of types to Field documentation.
This commit is contained in:
@@ -16,10 +16,9 @@ Records. Additionally, there is a a Field object for describing the columns of
|
|||||||
a Dataset, a Query object for describing queries, and a Facet object for
|
a Dataset, a Query object for describing queries, and a Facet object for
|
||||||
holding summary information about a Field (or multiple Fields).
|
holding summary information about a Field (or multiple Fields).
|
||||||
|
|
||||||
# Models
|
|
||||||
|
|
||||||
All the models are Backbone models, that is they extend Backbone.Model. Note,
|
All the models are Backbone models, that is they extend Backbone.Model. Note,
|
||||||
however that they do not 'sync' (load/save) like normal Backbone models.
|
however, that they do not 'sync' (load/save) like normal Backbone models.
|
||||||
|
|
||||||
|
|
||||||
<h2 id="dataset">Dataset</h2>
|
<h2 id="dataset">Dataset</h2>
|
||||||
|
|
||||||
@@ -92,8 +91,7 @@ var field = new Field({
|
|||||||
label: 'My Field Name',
|
label: 'My Field Name',
|
||||||
|
|
||||||
// (optional: defaults to string) the type of the data in this field.
|
// (optional: defaults to string) the type of the data in this field.
|
||||||
// Should be a string as per type names defined by ElasticSearch - see
|
// For list of type names see below
|
||||||
// Types list on <http://www.elasticsearch.org/guide/reference/mapping/>
|
|
||||||
type: 'string',
|
type: 'string',
|
||||||
|
|
||||||
// (optional - defaults to null) used to indicate how the data should be
|
// (optional - defaults to null) used to indicate how the data should be
|
||||||
@@ -105,6 +103,21 @@ var field = new Field({
|
|||||||
is_derived: false
|
is_derived: false
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
|
#### Types
|
||||||
|
|
||||||
|
Types are based on the [type set of elasticsearch][types-1] with a few minor additions and modifications:
|
||||||
|
|
||||||
|
[types-1]: http://www.elasticsearch.org/guide/reference/mapping/
|
||||||
|
|
||||||
|
* string
|
||||||
|
* integer (long)
|
||||||
|
* float (double)
|
||||||
|
* boolean
|
||||||
|
* geo_point
|
||||||
|
* geojson
|
||||||
|
* array
|
||||||
|
* object
|
||||||
|
|
||||||
#### Rendering, types and formats
|
#### Rendering, types and formats
|
||||||
|
|
||||||
One can customize the rendering of fields in the user interface and elsewhere
|
One can customize the rendering of fields in the user interface and elsewhere
|
||||||
|
|||||||
Reference in New Issue
Block a user