SidebarTab

geovisto-map • Readme | API

---

geovisto-map / SidebarTab

Class: SidebarTab\<T>

This class provides controls for a sidebar tab. It contains enable button which enables the sidebar and tool.

This class is intended to be extended.

Author

Jiri Hynek

Extends

• MapObject

Type parameters

• T extends IMapTool & IMapFormControl

Implements

• ISidebarTab

Constructors

new SidebarTab()

new SidebarTab\<T>(props?): SidebarTab\<T>

It creates abstract sidebar tab with respect to the given props.

Parameters

• props?: ISidebarTabProps

Returns

SidebarTab\<T>

Overrides

MapObject.constructor

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:50

Methods

create()

create(): this

Creates sidebar tab.

Returns

this

Implementation of

ISidebarTab.create

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:168

---

createDefaults()

protected createDefaults(): ISidebarTabDefaults

It creates new defaults of the sidebar tab.

Returns

ISidebarTabDefaults

Overrides

MapObject.createDefaults

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:71

---

createState()

protected createState(): ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>

It creates the sidebar tab state.

Returns

ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>

Overrides

MapObject.createState

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:85

---

createTabContent()

protected createTabContent(tabContent): void

Parameters

• tabContent: Element

Returns

void

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:243

---

getDefaults()

getDefaults(): ISidebarTabDefaults

It returns default values of the sidebar tab.

Returns

ISidebarTabDefaults

Implementation of

ISidebarTab.getDefaults

Overrides

MapObject.getDefaults

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:64

---

getFragments()

getFragments(): undefined | ISidebarFragment\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>, ISidebarFragmentConfig, ISidebarFragmentInitProps\<ISidebarFragmentConfig>>[]

Help function which returns sidebar fragmnets.

Returns

undefined | ISidebarFragment\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>, ISidebarFragmentConfig, ISidebarFragmentInitProps\<ISidebarFragmentConfig>>[]

Implementation of

ISidebarTab.getFragments

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:99

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Implementation of

ISidebarTab.getId

Inherited from

MapObject.getId

Source

model/internal/object/MapObject.ts:93

---

getProps()

getProps(): ISidebarTabProps

It returns the props given by the programmer.

Returns

ISidebarTabProps

Implementation of

ISidebarTab.getProps

Overrides

MapObject.getProps

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:57

---

getState()

getState(): ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>

It returns the sidebar tab state.

Returns

ISidebarTabState\<ISidebarTabProps, ISidebarTabDefaults, ISidebarTabConfig>

Implementation of

ISidebarTab.getState

Overrides

MapObject.getState

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:78

---

getTabStructure()

protected getTabStructure(): PanelOptions

It returns the sidebar tab structure defined with respect to the leaflet-sidebar-v2 plug-in.

See: https://github.com/noerw/leaflet-sidebar-v2

Returns

PanelOptions

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:186

---

getTool()

getTool(): T

Help function which returns the tool.

Returns

T

Implementation of

ISidebarTab.getTool

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:92

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Implementation of

ISidebarTab.getType

Inherited from

MapObject.getType

Source

model/internal/object/MapObject.ts:86

---

initialize()

initialize(initProps): this

It initializes the sidebar tab.

Parameters

• initProps: ISidebarTabInitProps

Returns

this

Implementation of

ISidebarTab.initialize

Overrides

MapObject.initialize

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:108

---

initializeFragments()

protected initializeFragments(config?): void

The function takes config and deserializes the tab fragments.

Parameters

• config?: ISidebarTabConfig

Returns

void

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:121

---

postCreate()

protected postCreate(): void

It creates the remaining parts of the sidebar tab after the sidebar tab is rendered.

Returns

void

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:200

---

redraw()

redraw(): void

It redraws the content of the sidebar tab.

Returns

void

Implementation of

ISidebarTab.redraw

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:265

---

setChecked()

setChecked(checked): void

Functions changes layer state to enabled/disabled.

Parameters

• checked: boolean

Returns

void

Implementation of

ISidebarTab.setChecked

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:289

---

setProps()

protected setProps(props): void

It updates the props.

Parameters

• props: IMapObjectProps

Returns

void

Inherited from

MapObject.setProps

Source

model/internal/object/MapObject.ts:38

---

setTabContentChecked()

setTabContentChecked(checked): void

Changes the state of the tool which is controled by this sidebar tab.

This function can be extended if needed.

Parameters

• checked: boolean

Returns

void

Source

tools/sidebar/model/internal/tab/SidebarTab.ts:332