TimelineToolMapForm

geovisto-map • Readme | API

---

geovisto-map / TimelineToolMapForm

Class: TimelineToolMapForm

This class provides controls for management of Timeline map form inputs.

Author

Krystof Rykala

Extends

• MapLayerToolForm\<ITimelineTool>

Implements

• IMapForm

Constructors

new TimelineToolMapForm()

new TimelineToolMapForm(layerTool): TimelineToolMapForm

Parameters

• layerTool: ITimelineTool\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolState\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolConfig, ITimelineToolDimensionsConfig, object>, ITimelineToolConfig, IMapToolInitProps\<ITimelineToolConfig>>

Returns

TimelineToolMapForm

Inherited from

MapLayerToolForm.constructor

Source

model/internal/form/MapLayerToolForm.ts:22

Properties

htmlContent

private htmlContent: HTMLDivElement

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:12

---

inputs?

private optional inputs: object

chartAggregationFn

chartAggregationFn: IMapFormInput

chartEnabled

chartEnabled: IMapFormInput

chartValuePath

chartValuePath: IMapFormInput

granularity

granularity: IMapFormInput

realTimeEnabled

realTimeEnabled: IMapFormInput

stepTimeLength

stepTimeLength: IMapFormInput

timePath

timePath: IMapFormInput

transitionDuration

transitionDuration: IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:15

---

submitButton

private submitButton: HTMLButtonElement

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:13

Methods

getAutocompleteInput()

protected getAutocompleteInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal autocomplete input for the any map domain dimension.

Parameters

• dimension: IMapDomainDimension\<IMapDomain>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getAutocompleteInput

Source

model/internal/form/MapLayerToolForm.ts:43

---

getCheckboxInput()

protected getCheckboxInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal checkbox input for the any map boolean dimension.

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getCheckboxInput

Source

model/internal/form/MapLayerToolForm.ts:78

---

getColorInput()

protected getColorInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal color input for the any map string dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getColorInput

Source

model/internal/form/MapLayerToolForm.ts:96

---

getContent()

getContent(): HTMLDivElement

It returns a HTML div element conatining the form.

Returns

HTMLDivElement

Implementation of

IMapForm.getContent

Overrides

MapLayerToolForm.getContent

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:53

---

getInputChartAggregationFn()

private getInputChartAggregationFn(dimension): IMapFormInput

Parameters

• dimension: IMapDomainDimension\<IMapAggregationFunction>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:143

---

getInputChartEnabled()

private getInputChartEnabled(dimension): IMapFormInput

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:132

---

getInputChartValuePath()

private getInputChartValuePath(dimension): IMapFormInput

Parameters

• dimension: IMapDomainDimension\<IMapDataDomain>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:139

---

getInputGranularity()

private getInputGranularity(dimension): IMapFormInput

Parameters

• dimension: IMapDomainDimension\<ITimeGranularity>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:128

---

getInputRealTimeEnabled()

private getInputRealTimeEnabled(dimension): IMapFormInput

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:122

---

getInputStepTimeLength()

private getInputStepTimeLength(dimension): IMapFormInput

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:113

---

getInputTimePath()

private getInputTimePath(dimension): IMapFormInput

Parameters

• dimension: IMapDomainDimension\<IMapDataDomain>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:109

---

getInputTransitionDuration()

private getInputTransitionDuration(dimension): IMapFormInput

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

Returns

IMapFormInput

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:117

---

getMapObject()

protected getMapObject(): ITimelineTool\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolState\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolConfig, ITimelineToolDimensionsConfig, object>, ITimelineToolConfig, IMapToolInitProps\<ITimelineToolConfig>>

Returns

ITimelineTool\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolState\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolConfig, ITimelineToolDimensionsConfig, object>, ITimelineToolConfig, IMapToolInitProps\<ITimelineToolConfig>>

Inherited from

MapLayerToolForm.getMapObject

Source

model/internal/form/MapObjectForm.ts:16

---

getNumberInput()

protected getNumberInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal number input for the any map number dimension.

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getNumberInput

Source

model/internal/form/MapLayerToolForm.ts:133

---

getSliderInput()

protected getSliderInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal slider input for the any map range integer dimension.

Parameters

• dimension: IMapTypeDimension\<number, IIntegerRangeManager>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getSliderInput

Source

model/internal/form/MapLayerToolForm.ts:113

---

getTextInput()

protected getTextInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal text input for the any map domain dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getTextInput

Source

model/internal/form/MapLayerToolForm.ts:61

---

onSubmit()

private onSubmit(): void

Returns

void

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:105

---

setInputValues()

setInputValues(dimensions): void

It updates selected input values according to the given dimensions.

Parameters

• dimensions

• dimensions.chartAggregationFn: IMapDomainDimension\<IMapAggregationFunction>

• dimensions.chartEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.chartValuePath: IMapDomainDimension\<IMapDataDomain>

• dimensions.granularity: IMapDomainDimension\<ITimeGranularity>

• dimensions.realTimeEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.stepTimeLength: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.story: IMapTypeDimension\<string, ITypeManager\<string>>

• dimensions.storyEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.timePath: IMapDomainDimension\<IMapDataDomain>

• dimensions.transitionDuration: IMapTypeDimension\<number, ITypeManager\<number>>

Returns

void

Overrides

MapLayerToolForm.setInputValues

Source

tools/timeline/model/internal/form/TimelineToolMapForm.ts:31