SidebarFragment

geovisto-map • Readme | API

---

geovisto-map / SidebarFragment

Class: SidebarFragment\<T>

This class provides tab fragment for a sidebar tab.

This class is intended to be extended.

Author

Jiri Hynek

Extends

• MapObject

Type parameters

• T extends IMapTool & IMapFormControl

Implements

• ISidebarFragment

Constructors

new SidebarFragment()

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

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

Parameters

• props?: ISidebarFragmentProps

Returns

SidebarFragment\<T>

Overrides

MapObject.constructor

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:29

Methods

createDefaults()

protected createDefaults(): ISidebarFragmentDefaults

It creates new defaults of the sidebar fragment.

Returns

ISidebarFragmentDefaults

Overrides

MapObject.createDefaults

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:50

---

createState()

protected createState(): ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>

It creates the sidebar fragment state.

Returns

ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>

Overrides

MapObject.createState

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:64

---

getContent()

getContent(): HTMLDivElement

It returns the HTML content of the sidebar fragment.

Returns

HTMLDivElement

Implementation of

ISidebarFragment.getContent

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:87

---

getDefaults()

getDefaults(): ISidebarFragmentDefaults

It returns default values of the sidebar fragment.

Returns

ISidebarFragmentDefaults

Implementation of

ISidebarFragment.getDefaults

Overrides

MapObject.getDefaults

Source

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

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Implementation of

ISidebarFragment.getId

Inherited from

MapObject.getId

Source

model/internal/object/MapObject.ts:93

---

getProps()

getProps(): ISidebarFragmentProps

It returns the props given by the programmer.

Returns

ISidebarFragmentProps

Implementation of

ISidebarFragment.getProps

Overrides

MapObject.getProps

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:36

---

getState()

getState(): ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>

It returns the sidebar fragment state.

Returns

ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>

Implementation of

ISidebarFragment.getState

Overrides

MapObject.getState

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:57

---

getTool()

getTool(): T

Help function which returns the tool.

Returns

T

Source

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

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Implementation of

ISidebarFragment.getType

Inherited from

MapObject.getType

Source

model/internal/object/MapObject.ts:86

---

initialize()

initialize(initProps): this

Overrides the super method.

Parameters

• initProps: ISidebarFragmentInitProps\<ISidebarFragmentConfig, T>

Returns

this

Implementation of

ISidebarFragment.initialize

Overrides

MapObject.initialize

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:80

---

postCreate()

postCreate(): this

This function is called after the sidebar tab is rendered in sidebar.

Returns

this

Implementation of

ISidebarFragment.postCreate

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:94

---

setFragmentContentChecked()

setFragmentContentChecked(checked): void

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

Parameters

• checked: boolean

Returns

void

Implementation of

ISidebarFragment.setFragmentContentChecked

Source

tools/sidebar/model/internal/fragment/SidebarFragment.ts:103

---

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