Skip to main content

SidebarToolState

geovisto-map • Readme | API

geovisto-map / SidebarToolState

Class: SidebarToolState

This class provide sidebar tool model.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new SidebarToolState()​

new SidebarToolState(tool): SidebarToolState

It creates a tool state.

Parameters​

• tool: ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

Returns​

SidebarToolState

Overrides​

MapToolState.constructor

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:37

Properties​

private sidebar: any

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:32

tabs​

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

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:30

tabsConfigs?​

private optional tabsConfigs: ISidebarTabConfig[]

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:28

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

Implementation of​

ISidebarToolState.addTab

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:125

deserialize()​

deserialize(config): void

The metod takes config and deserializes the values.

Parameters​

• config: ISidebarToolConfig

Returns​

void

Implementation of​

ISidebarToolState.deserialize

Overrides​

MapToolState.deserialize

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:65

getIcon()​

getIcon(): string

It returns the icon property of the tool state.

Returns​

string

Implementation of​

ISidebarToolState.getIcon

Inherited from​

MapToolState.getIcon

Source​

model/internal/tool/MapToolState.ts:120

getId()​

getId(): string

It returns the id property of the tool state.

Returns​

string

Implementation of​

ISidebarToolState.getId

Inherited from​

MapToolState.getId

Source​

model/internal/object/MapObjectState.ts:87

getLabel()​

getLabel(): string

It returns the label property of the tool state.

Returns​

string

Implementation of​

ISidebarToolState.getLabel

Inherited from​

MapToolState.getLabel

Source​

model/internal/tool/MapToolState.ts:104

getMap()​

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

It returns the map property of the tool state.

Returns​

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

Implementation of​

ISidebarToolState.getMap

Inherited from​

MapToolState.getMap

Source​

model/internal/tool/MapToolState.ts:136

getMapObject()​

protected getMapObject(): IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

It makes the map object visible to extended classes.

Returns​

IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

Inherited from​

MapToolState.getMapObject

Source​

model/internal/object/MapObjectState.ts:39

getSidebar()​

getSidebar(): any

It returns the sidebar.

Returns​

any

Implementation of​

ISidebarToolState.getSidebar

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:100

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>>[]

Implementation of​

ISidebarToolState.getTabs

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:116

getTabsConfigs()​

getTabsConfigs(): undefined | ISidebarTabConfig[]

It returns the tabs configs.

Returns​

undefined | ISidebarTabConfig[]

Implementation of​

ISidebarToolState.getTabsConfigs

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:93

getType()​

getType(): string

It returns the type property of the tool state.

Returns​

string

Implementation of​

ISidebarToolState.getType

Inherited from​

MapToolState.getType

Source​

model/internal/object/MapObjectState.ts:80

initialize()​

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters​

• defaults: ISidebarToolDefaults

• props: ISidebarToolProps

• initProps: IMapToolInitProps\<ISidebarToolConfig>

Returns​

void

Implementation of​

ISidebarToolState.initialize

Overrides​

MapToolState.initialize

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:53

isEnabled()​

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns​

boolean

Implementation of​

ISidebarToolState.isEnabled

Inherited from​

MapToolState.isEnabled

Source​

model/internal/tool/MapToolState.ts:88

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

Implementation of​

ISidebarToolState.removeTab

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:134

serialize()​

serialize(defaults): ISidebarToolConfig

The method serializes the tool configuration. Optionally, defaults can be set if property is undefined.

Parameters​

• defaults: undefined | SidebarToolDefaults

Returns​

ISidebarToolConfig

Implementation of​

ISidebarToolState.serialize

Overrides​

MapToolState.serialize

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:77

setEnabled()​

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters​

• enabled: boolean

Returns​

void

Implementation of​

ISidebarToolState.setEnabled

Inherited from​

MapToolState.setEnabled

Source​

model/internal/tool/MapToolState.ts:97

setIcon()​

setIcon(icon): void

It sets the icon property of the tool state.

Parameters​

• icon: string

Returns​

void

Implementation of​

ISidebarToolState.setIcon

Inherited from​

MapToolState.setIcon

Source​

model/internal/tool/MapToolState.ts:129

setId()​

setId(id): void

It sets the id property of the tool state.

Parameters​

• id: string

Returns​

void

Implementation of​

ISidebarToolState.setId

Inherited from​

MapToolState.setId

Source​

model/internal/object/MapObjectState.ts:96

setLabel()​

setLabel(label): void

It sets the label property of the tool state.

Parameters​

• label: string

Returns​

void

Implementation of​

ISidebarToolState.setLabel

Inherited from​

MapToolState.setLabel

Source​

model/internal/tool/MapToolState.ts:113

setMap()​

protected setMap(map): void

It sets the map property of the tool state.

Parameters​

• map: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns​

void

Inherited from​

MapToolState.setMap

Source​

model/internal/tool/MapToolState.ts:145

setSidebar()​

setSidebar(sidebar): void

It sets sidebar.

Parameters​

• sidebar: Sidebar

Returns​

void

Implementation of​

ISidebarToolState.setSidebar

Source​

tools/sidebar/model/internal/tool/SidebarToolState.ts:109