Mapspace API Reference

Class: Table

Mapspace.control. Table

A control that shows a table. Currently is for visualization and not edition of the data. The table is usually associated to a layer.

new Table( [options])

Parameters:
Name Type Argument Description
options Mapspace.control.TableOptions <optional>

Control options.
Source:
mapspace/controls/table.js
Fires:
  • Mapspace.control.event:TableSelectionEvent
  • ol.Object.Event#event:change:enabled

Extends

Members

classNames :string|undefined

The class names to add to the default ones that the control will create.

Inherited From:
Overrides:
Source:
mapspace/controls/control.js

controldefs :Array.<Mapspace.ControlDefinition>

Array of control definitions this control contains.

Inherited From:
Source:
mapspace/controls/control.js

<nullable> element :Element

This is the HTML element where the control is drawn. Do not modify this property directly. Use only in the constructor.

Inherited From:
Source:
mapspace/controls/control.js

globalizationKey :string|undefined

This is the string that identifies in Mapspace.strings this control for globalization purposes.

Inherited From:
Source:
mapspace/controls/control.js

<nullable> target :Element

This is the HTML element where the control is appended. Do not modify this property directly. Use constructor or setTarget to set this value.

Inherited From:
Source:
mapspace/controls/control.js

Methods

addControlDefinition(controldef)

Adds a control definition to the control. By default the control in the control definition is changed its target to the element of this control. Override this behaviour in inherited classes to change the target to another one.

Parameters:
Name Type Description
controldef *

Control definition.
Inherited From:
Source:
mapspace/controls/control.js

addControlDefinitions(controldefs)

Adds an array of control definitions to the control. Controls in the control definition array shouldn't have a target set.

Parameters:
Name Type Description
controldefs Array.<Mapspace.control.ControlDefinition>

Array of control definitions to add.
Inherited From:
Source:
mapspace/controls/control.js

clearControl()

Clears all the HTML elements under the control element and clear listeners.

Source:
mapspace/controls/table.js

containsControlDefinition(controldef)

Checks if a control definition is already added.

Parameters:
Name Type Description
controldef Mapspace.ControlDefinition

Control definition to check.
Inherited From:
Source:
mapspace/controls/control.js
Returns:

True if it is added.

Type
boolean

fade(fadeIn)

Fades this control in or out. This method ignores the fadeOut property of the control. You must care to check if this control can be faded or not checking that value and also if this control lies inside an active viewer.

Parameters:
Name Type Description
fadeIn boolean

If the control must fade in, otherwise it will fade out.
Inherited From:
Source:
mapspace/controls/control.js

getControlDefinitions()

Return the array of control definitions this control has inside.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
Array.<Mapspace.ControlDefinition>

getEnabled()

Return whether the control is currently enabled. When a control is not enabled can be clicked, cannot be dragged, but none of those interactions produce any event.

Inherited From:
Source:
mapspace/controls/control.js
Returns:

true if the control is enabled, false otherwise.

Type
boolean

getFadeInEnabled()

Returns if the control can be faded in. By default is true.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
boolean

getFadeOutMode()

Returns the mode this control can be faded when it is in an active viewer. This value can be changed through the fadeOut option in the creation of the control. By default it is 'NEVER'. This default value can be overrided in derived classes.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
Mapspace.control.FadeOutMode

getNumPages()

Get number of pages.

Source:
mapspace/controls/table.js
Returns:
Type
number

getPageIndex()

Get page index.

Source:
mapspace/controls/table.js
Returns:
Type
number

getTableLength()

Get total number of rows that are set to be shown in the table.

Source:
mapspace/controls/table.js
Returns:
Type
number

getTableSettings()

Gets the table settings.

Source:
mapspace/controls/table.js
Returns:
Type
Mapspace.control.TableColumnsSettings

getTableSize()

Gets table size.

Source:
mapspace/controls/table.js
Returns:
Type
number

getTranslation(id)

Returns the translation for a given property ID. The Mapspace.strings object contains pairs of key and values. Each key follows the pattern: globalizationKey#propertyID.

Parameters:
Name Type Description
id string

The property ID.
Inherited From:
Source:
mapspace/controls/control.js
Returns:

The translation or undefined if not found.

Type
string | undefined

getVisibleFeatures()

Gets the features that are currently visible in the table.

Source:
mapspace/controls/table.js
Returns:
Type
Array.<ol.Feature>

hasClassName(className)

Returns if the control has a class name

Parameters:
Name Type Description
className string

The class name.
Inherited From:
Source:
mapspace/controls/control.js

isTool()

Returns true if this control is a tool. A tool is a control that contains one or several options in a list (for example a Mapspace.control.ViewerTools) that are linked to a viewer and only one of them can be active at a time. Tools are usually related to interactions in a way that only one interaction can be active at a time in a viewer.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
boolean

setEnabled(enabled)

Sets the control to enabled or not. When a control is not enabled can be clicked, cannot be dragged, but none of those interactions produce any event.

Parameters:
Name Type Description
enabled boolean

Enabled.
Inherited From:
Source:
mapspace/controls/control.js

setFadeInEnabled(enabled)

Sets if the control can be faded in. By default is true.

Parameters:
Name Type Description
enabled boolean
Inherited From:
Source:
mapspace/controls/control.js

setPageIndex(pageIndex)

Sets the page index.

Parameters:
Name Type Description
pageIndex number

Page index.
Source:
mapspace/controls/table.js
Returns:

Returns true if the page index changed.

Type
boolean

setTableSettings(settings)

Sets the table settings.

Parameters:
Name Type Description
settings Array.<Mapspace.control.TableColumnsSettings>

Settings.
Source:
mapspace/controls/table.js

setTableSize(tableSize)

Sets table size. Use -1 to show all rows in table.

Parameters:
Name Type Description
tableSize number

Table size, number of visible rows.
Source:
mapspace/controls/table.js
Returns:

Return true if the table size, or other value has changed.

Type
boolean

setTarget(target)

This function is used to set a target element for the control.

Parameters:
Name Type Description
target Element | string | Mapspace.Viewer

Target.
Inherited From:
Source:
mapspace/controls/control.js

<abstract> unselectTool()

If this control is a tool the unselects the tool.

Inherited From:
Source:
mapspace/controls/control.js

updateAttributes()

Uses the current layer to update attribute information.

Source:
mapspace/controls/table.js

updateControl(element)

Updates the control.

Parameters:
Name Type Description
element HTMLElement

The element of the control.
Source:
mapspace/controls/table.js

updateFeatures()

Updates the array of features that can be viewed in this table.

Source:
mapspace/controls/table.js

updateFilteredFeatures()

Uses current layer filter to update the filtered features.

Source:
mapspace/controls/table.js

<abstract> updateLanguage()

Updates the control for the current language in the Mapspace.Globalization singleton.

Inherited From:
Source:
mapspace/controls/control.js

updateListBox(scroll)

Updates the content in the listbox.

Parameters:
Name Type Argument Description
scroll boolean <nullable>

If reuse current scroll or not. By default is false.
Source:
mapspace/controls/table.js

updateSelectedFeatures(selected)

Updates if features are selected or not.

Parameters:
Name Type Description
selected Array.<ol.Feature>

Features selected.
Source:
mapspace/controls/table.js

updateValues()

Uses current layer to update values.

Source:
mapspace/controls/table.js