ISidebarToolState

geovisto-map • Readme | API

---

geovisto-map / ISidebarToolState

Interface: ISidebarToolState\<TProps, TDefaults, TConfig>

This interface declares sidebar tool model.

Author

Jiri Hynek

Extends

• IMapToolState\<TProps, TDefaults, TConfig>

Type parameters

• TProps extends ISidebarToolProps = ISidebarToolProps

• TDefaults extends ISidebarToolDefaults = ISidebarToolDefaults

• TConfig extends ISidebarToolConfig = ISidebarToolConfig

Methods

addTab()

addTab(tab): void

It sets the tabs property of the tool state.

Parameters

• tab: ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>

Returns

void

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:54

---

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: TConfig

Returns

void

Inherited from

IMapToolState.deserialize

Source

model/types/object/IMapObjectState.ts:32

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Inherited from

IMapToolState.getIcon

Source

model/types/tool/IMapToolState.ts:61

---

getId()

getId(): string

It returns the id property of the map object state.

Returns

string

Inherited from

IMapToolState.getId

Source

model/types/object/IMapObjectState.ts:49

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Inherited from

IMapToolState.getLabel

Source

model/types/tool/IMapToolState.ts:49

---

getMap()

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

It returns the map property of the tool state.

Returns

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

Inherited from

IMapToolState.getMap

Source

model/types/tool/IMapToolState.ts:44

---

getSidebar()

getSidebar(): any

It returns the sidebar.

Returns

any

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:35

---

getTabs()

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

It returns the tabs controls.

Returns

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

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:47

---

getTabsConfigs()

getTabsConfigs(): undefined | ISidebarTabConfig[]

It returns the tabs configs.

Returns

undefined | ISidebarTabConfig[]

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:30

---

getType()

getType(): string

It returns the type property of the map object state.

Returns

string

Inherited from

IMapToolState.getType

Source

model/types/object/IMapObjectState.ts:44

---

initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

• defaults: TDefaults

• props: TProps

• initProps: IMapToolInitProps\<TConfig>

Returns

void

Inherited from

IMapToolState.initialize

Source

model/types/tool/IMapToolState.ts:27

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Inherited from

IMapToolState.isEnabled

Source

model/types/tool/IMapToolState.ts:32

---

removeTab()

removeTab(tab): void

It removes tab from the list of tabs.

Parameters

• tab: ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>

Returns

void

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:61

---

serialize()

serialize(defaults): TConfig

The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

• defaults: undefined | TDefaults

Returns

TConfig

Inherited from

IMapToolState.serialize

Source

model/types/object/IMapObjectState.ts:39

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Inherited from

IMapToolState.setEnabled

Source

model/types/tool/IMapToolState.ts:39

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Inherited from

IMapToolState.setIcon

Source

model/types/tool/IMapToolState.ts:68

---

setId()

setId(id): void

It sets the id property of the map object state. It can be set only once.

Parameters

• id: string

Returns

void

Inherited from

IMapToolState.setId

Source

model/types/object/IMapObjectState.ts:57

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Inherited from

IMapToolState.setLabel

Source

model/types/tool/IMapToolState.ts:56

---

setSidebar()

setSidebar(sidebar): void

It sets sidebar.

Parameters

• sidebar: Sidebar

Returns

void

Source

tools/sidebar/model/types/tool/ISidebarToolState.ts:42