Documentation

Class: Point

.fields.geo. Point

new Point(name, type, schema, value, $endpoint, service, $states, relationName)

Apy GeoPoint Field (GeoJSON)

Parameters:
Name Type Description
name string

Field name
type string

Field type
schema Object

Field schema
value Object

Field value
$endpoint string

Field endpoint
service Object

Reference to Service instance
$states Object

Field inner state holder instance
relationName string

(optional) Field relation name

Extends

Methods

<static> cleanedData()

Return an cleaned Object instance representing a Point

Throws:

when validation fails

Type
apy.errors.Error
Returns:

cleaned GeoPoint data

Type
Object

<static> cloneValue(value)

Wrap the given value to clone into its own GeoPoint instance.

Parameters:
Name Type Description
value *

An Object instance representing a Point
Returns:

A GeoPoint instance

Type
apy.helpers.GeoPoint

<static> hasUpdated()

Indicate whether the Point is updated or not

Returns:

is field updated?

Type
boolean

<static> setValue(value)

Set a given value to attributes $value & $memo respectively, using cloneValue method

Parameters:
Name Type Description
value *

An Object instance representing a Point
Returns:

this

Type
apy.components.fields.geo.Point

<static> toString()

Return an Point representation as a String

Returns:

Geo Point Field string representation

Type
string

<static> validate()

FIXME: disabled for now as it may not be necessary to validate, TBC