Module
IndexedShape
IndexedShape ( type, id )
Defines a shape that already exists in an index/type.
|
Method Summary
Returns | Name | Description |
---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | id(id) | Sets the document id of the indexed shape. |
Object | index(idx) | Sets the index which the shape is indexed under. Defaults to "shapes". |
Object | shapeFieldName(field) | Sets the field name containing the indexed shape. Defaults to "shape". |
String | toJSON() | Retrieves the internal script object. This is typically used by
internal API functions so use with caution. |
Object | type(t) | Sets the type which the shape is indexed under. |
Method Detail
id
Object id ( id )
Sets the document id of the indexed shape.
|
index
Object index ( idx )
Sets the index which the shape is indexed under.
Defaults to "shapes".
|
shapeFieldName
Object shapeFieldName ( field )
Sets the field name containing the indexed shape.
Defaults to "shape".
|
toJSON
String toJSON ( )
Retrieves the internal script object. This is typically used by
internal API functions so use with caution.
|
type
Object type ( t )
Sets the type which the shape is indexed under.
|