ISidebarTool

geovisto-map • Readme | API

---

geovisto-map / ISidebarTool

Interface: ISidebarTool\<TProps, TDefaults, TState, TConfig, TInitProps>

This class provides the sidebar tool.

Author

Jiri Hynek

Extends

• IMapTool\<TProps, TDefaults, TState, TConfig, TInitProps>

Type parameters

• TProps extends ISidebarToolProps = ISidebarToolProps

• TDefaults extends ISidebarToolDefaults = ISidebarToolDefaults

• TState extends ISidebarToolState = ISidebarToolState

• TConfig extends ISidebarToolConfig = ISidebarToolConfig

• TInitProps extends IMapToolInitProps\<TConfig> = IMapToolInitProps\<TConfig>

Methods

copy()

copy(): ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

It creates a copy of the uninitialized tool.

Returns

ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

Overrides

IMapTool.copy

Source

tools/sidebar/model/types/tool/ISidebarTool.ts:29

---

create()

create(): this

It creates a tool.

Returns

this

Inherited from

IMapTool.create

Source

model/types/tool/IMapTool.ts:47

---

getAPIGetter()

getAPIGetter(): undefined | IMapToolAPIGetter\<IMapToolAPI>

It returns the tool API.

Returns

undefined | IMapToolAPIGetter\<IMapToolAPI>

Inherited from

IMapTool.getAPIGetter

Source

model/types/tool/IMapTool.ts:32

---

getDefaults()

getDefaults(): TDefaults

It returns default values of the state properties.

Returns

TDefaults

Inherited from

IMapTool.getDefaults

Source

model/types/object/IMapObject.ts:27

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Inherited from

IMapTool.getId

Source

model/types/object/IMapObject.ts:42

---

getMap()

getMap(): undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Help function which returns map which uses this tool.

Returns

undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Inherited from

IMapTool.getMap

Source

model/types/tool/IMapTool.ts:42

---

getProps()

getProps(): TProps

It returns the props given by the programmer.

Returns

TProps

Inherited from

IMapTool.getProps

Source

model/types/object/IMapObject.ts:22

---

getState()

getState(): TState

It returns the map object state.

Returns

TState

Inherited from

IMapTool.getState

Source

model/types/object/IMapObject.ts:32

---

getTabs()

getTabs(): ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>[]

Help function which returns sidebar tabs of the tool state.

Returns

ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>[]

Source

tools/sidebar/model/types/tool/ISidebarTool.ts:34

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Inherited from

IMapTool.getType

Source

model/types/object/IMapObject.ts:37

---

initialize()

initialize(initProps): this

It initializes the state of the object. It processes the serialized config and sets further objects.

This cannot be done in the object constructor since the object can be created before the Geovisto map is created.

Parameters

• initProps: TInitProps

Returns

this

Inherited from

IMapTool.initialize

Source

model/types/object/IMapObject.ts:53

---

isEnabled()

isEnabled(): boolean

Help getter which returns enabled property of state.

Returns

boolean

Inherited from

IMapTool.isEnabled

Source

model/types/tool/IMapTool.ts:52

---

isSingleton()

isSingleton(): boolean

It returns a logical value whether the tool type is singleton.

Returns

boolean

Inherited from

IMapTool.isSingleton

Source

model/types/tool/IMapTool.ts:37

---

setEnabled()

setEnabled(enabled): void

Some tools might be dynamicaly enabled/disabled. This function is called externally when the tool is enabled/disabled.

Parameters

• enabled: boolean

Returns

void

Inherited from

IMapTool.setEnabled

Source

model/types/tool/IMapTool.ts:60

---

switchEnabled()

switchEnabled(): void

Help function which switches the enabled state (enabled/disabled).

Returns

void

Inherited from

IMapTool.switchEnabled

Source

model/types/tool/IMapTool.ts:65