Documentation Namespace: Map

Namespace: Map

Map~ Map

Source:

app/util/Map.js, line 17

Methods

<static> create(entities, dimensions)

Create a new map

Parameters:

Name	Type	Description
`entities`	Array
`dimensions`	any

Source:

app/util/Map.js, line 29

<static> create(entities, dimensions)

Create a new map

Parameters:

Name	Type	Description
`entities`	Array
`dimensions`	any

Source:

app/util/Map.js, line 29

<static> discreteSamples( [n=]) → {Array.<any>}

Get n discrete samples from array

Parameters:

Name	Type	Argument	Description
`n=`	number	<optional>	Number of samples to pick. Default = 1

Source:

app/util/Map.js, line 106

Returns:

Type: Array.<any>

<static> discreteSamples( [n=]) → {Array.<any>}

Get n discrete samples from array

Parameters:

Name	Type	Argument	Description
`n=`	number	<optional>	Number of samples to pick. Default = 1

Source:

app/util/Map.js, line 106

Returns:

Type: Array.<any>

<static> getByID(id) → {Entity}

Get Entity with ID

Parameters:

Name	Type	Description
`id`	string	ID of `Entity`

Source:

app/util/Map.js, line 121

Returns:

Type: Entity

<static> getByID(id) → {Entity}

Get Entity with ID

Parameters:

Name	Type	Description
`id`	string	ID of `Entity`

Source:

app/util/Map.js, line 121

Returns:

Type: Entity

<static> insert(entity)

Parameters:

Name	Type	Description
`entity`	Object

Source:

app/util/Map.js, line 51

<static> insert(entity)

Parameters:

Name	Type	Description
`entity`	Object

Source:

app/util/Map.js, line 51

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Name	Type	Description
`entity`	Object	Entity
`count`	number	Number of neighbors
`maxDistance`	any	Range to check within

Source:

app/util/Map.js, line 74

Returns:

Type: Array.Neighbors

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Name	Type	Description
`entity`	Object	Entity
`count`	number	Number of neighbors
`maxDistance`	any	Range to check within

Source:

app/util/Map.js, line 74

Returns:

Type: Array.Neighbors

Namespace: Map

Map~ Map

Source:

app/util/Map.js, line 17

Methods

<static> create(entities, dimensions)

Create a new map

Parameters:

Name	Type	Description
`entities`	Array
`dimensions`	any

Source:

app/util/Map.js, line 29

<static> create(entities, dimensions)

Create a new map

Parameters:

Name	Type	Description
`entities`	Array
`dimensions`	any

Source:

app/util/Map.js, line 29

<static> discreteSamples( [n=]) → {Array.<any>}

Get n discrete samples from array

Parameters:

Name	Type	Argument	Description
`n=`	number	<optional>	Number of samples to pick. Default = 1

Source:

app/util/Map.js, line 106

Returns:

Type: Array.<any>

<static> discreteSamples( [n=]) → {Array.<any>}

Get n discrete samples from array

Parameters:

Name	Type	Argument	Description
`n=`	number	<optional>	Number of samples to pick. Default = 1

Source:

app/util/Map.js, line 106

Returns:

Type: Array.<any>

<static> getByID(id) → {Entity}

Get Entity with ID

Parameters:

Name	Type	Description
`id`	string	ID of `Entity`

Source:

app/util/Map.js, line 121

Returns:

Type: Entity

<static> getByID(id) → {Entity}

Get Entity with ID

Parameters:

Name	Type	Description
`id`	string	ID of `Entity`

Source:

app/util/Map.js, line 121

Returns:

Type: Entity

<static> insert(entity)

Parameters:

Name	Type	Description
`entity`	Object

Source:

app/util/Map.js, line 51

<static> insert(entity)

Parameters:

Name	Type	Description
`entity`	Object

Source:

app/util/Map.js, line 51

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Name	Type	Description
`entity`	Object	Entity
`count`	number	Number of neighbors
`maxDistance`	any	Range to check within

Source:

app/util/Map.js, line 74

Returns:

Type: Array.Neighbors

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Name	Type	Description
`entity`	Object	Entity
`count`	number	Number of neighbors
`maxDistance`	any	Range to check within

Source:

app/util/Map.js, line 74

Returns:

Type: Array.Neighbors

Namespace: Map

Methods

<static> create(entities, dimensions)

Parameters:

<static> create(entities, dimensions)

Parameters:

<static> discreteSamples( [n=]) → {Array.<any>}

Parameters:

Returns:

<static> discreteSamples( [n=]) → {Array.<any>}

Parameters:

Returns:

<static> getByID(id) → {Entity}

Parameters:

Returns:

<static> getByID(id) → {Entity}

Parameters:

Returns:

<static> insert(entity)

Parameters:

<static> insert(entity)

Parameters:

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Returns:

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Returns:

Namespace: Map

Methods

<static> create(entities, dimensions)

Parameters:

<static> create(entities, dimensions)

Parameters:

<static> discreteSamples( [n=]) → {Array.<any>}

Parameters:

Returns:

<static> discreteSamples( [n=]) → {Array.<any>}

Parameters:

Returns:

<static> getByID(id) → {Entity}

Parameters:

Returns:

<static> getByID(id) → {Entity}

Parameters:

Returns:

<static> insert(entity)

Parameters:

<static> insert(entity)

Parameters:

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Returns:

<static> nearest(entity, count, maxDistance) → {Array.Neighbors}

Parameters:

Returns:

Search results