SidebarFragmentState

geovisto-map • Readme | API

---

geovisto-map / SidebarFragmentState

Class: SidebarFragmentState

This class manages the state of the sidebar fragment. It wraps the state since the sidebar fragment can work with state objects which needs to be explicitly serialized.

Author

Jiri Hynek

Extends

• MapObjectState

Implements

• ISidebarFragmentState

Constructors

new SidebarFragmentState()

new SidebarFragmentState(sidebarFragment): SidebarFragmentState

It creates a sidebar fragment state.

Parameters

• sidebarFragment: ISidebarFragment\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>, ISidebarFragmentConfig, ISidebarFragmentInitProps\<ISidebarFragmentConfig>>

Returns

SidebarFragmentState

Overrides

MapObjectState.constructor

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:34

Properties

content

private content: null | HTMLElement

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:27

---

enabled

private enabled: boolean

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:21

---

sidebarTab

private sidebarTab: ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:25

---

tool

private tool: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:23

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: ISidebarFragmentConfig

Returns

void

Implementation of

ISidebarFragmentState.deserialize

Overrides

MapObjectState.deserialize

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:61

---

getContent()

getContent(): null | HTMLElement

It returns the content property of the sidebar fragment state.

Returns

null | HTMLElement

Implementation of

ISidebarFragmentState.getContent

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:131

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

ISidebarFragmentState.getId

Inherited from

MapObjectState.getId

Source

model/internal/object/MapObjectState.ts:87

---

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

MapObjectState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getSidebarTab()

getSidebarTab(): ISidebarTab\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>, ISidebarTabConfig, ISidebarTabInitProps\<ISidebarTabConfig>>

It returns the sidebar tab property of the sidebar fragment control state.

Returns

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

Implementation of

ISidebarFragmentState.getSidebarTab

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:115

---

getTool()

getTool(): IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

It returns the tool property of the sidebar tab fragment state.

Returns

IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Implementation of

ISidebarFragmentState.getTool

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:83

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ISidebarFragmentState.getType

Inherited from

MapObjectState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

• defaults: ISidebarFragmentDefaults

• props: ISidebarFragmentProps

• initProps: ISidebarFragmentInitProps\<ISidebarFragmentConfig>

Returns

void

Implementation of

ISidebarFragmentState.initialize

Overrides

MapObjectState.initialize

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:43

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the sidebar fragment state.

Returns

boolean

Implementation of

ISidebarFragmentState.isEnabled

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:99

---

serialize()

serialize(defaults): ISidebarFragmentConfig

The method serializes the sidebar tab fragment configuration. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

• defaults: undefined | ISidebarFragmentDefaults

Returns

ISidebarFragmentConfig

Implementation of

ISidebarFragmentState.serialize

Overrides

MapObjectState.serialize

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:71

---

setContent()

setContent(content): void

It sets the content property of the sidebar tab control state.

Parameters

• content: HTMLElement

Returns

void

Implementation of

ISidebarFragmentState.setContent

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:140

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of the sidebar fragment state.

Parameters

• enabled: boolean

Returns

void

Implementation of

ISidebarFragmentState.setEnabled

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:108

---

setId()

setId(id): void

It sets the id property of the tool state.

Parameters

• id: string

Returns

void

Implementation of

ISidebarFragmentState.setId

Inherited from

MapObjectState.setId

Source

model/internal/object/MapObjectState.ts:96

---

setSidebarTab()

setSidebarTab(sidebarTab): void

It sets the sidebar tab property of the sidebar fragment state.

Parameters

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

Returns

void

Implementation of

ISidebarFragmentState.setSidebarTab

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:124

---

setTool()

protected setTool(tool): void

It sets the tool property of the sidebar tab fragment state.

Parameters

• tool: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Returns

void

Source

tools/sidebar/model/internal/fragment/SidebarFragmentState.ts:92