Skip to main content

ISidebarTab

geovisto-map • Readme | API

geovisto-map / ISidebarTab

Interface: ISidebarTab\<TProps, TDefaults, TState, TConfig, TInitProps>

This interface declares functions for the sidebar tab. It contains enable button which enables the sidebar and tool.

Author​

Jiri Hynek

Extends​

  • IMapObject\<TProps, TDefaults, TState, TConfig, TInitProps>

Type parameters​

• TProps extends ISidebarTabProps = ISidebarTabProps

• TDefaults extends ISidebarTabDefaults = ISidebarTabDefaults

• TState extends ISidebarTabState = ISidebarTabState

• TConfig extends ISidebarTabConfig = ISidebarTabConfig

• TInitProps extends ISidebarTabInitProps\<TConfig> = ISidebarTabInitProps\<TConfig>

Methods​

create()​

create(): this

It creates the sidebar tab

Returns​

this

Source​

tools/sidebar/model/types/tab/ISidebarTab.ts:46

getDefaults()​

getDefaults(): TDefaults

It returns default values of the state properties.

Returns​

TDefaults

Inherited from​

IMapObject.getDefaults

Source​

model/types/object/IMapObject.ts:27

getFragments()​

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

It returns the fragments property of the sidebar tab state.

Returns​

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

Source​

tools/sidebar/model/types/tab/ISidebarTab.ts:41

getId()​

getId(): string

Help function which returns the id of the object.

Returns​

string

Inherited from​

IMapObject.getId

Source​

model/types/object/IMapObject.ts:42

getProps()​

getProps(): TProps

It returns the props given by the programmer.

Returns​

TProps

Inherited from​

IMapObject.getProps

Source​

model/types/object/IMapObject.ts:22

getState()​

getState(): TState

It returns the map object state.

Returns​

TState

Inherited from​

IMapObject.getState

Source​

model/types/object/IMapObject.ts:32

getTool()​

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

Help function which returns the tool from the state.

Returns​

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

Source​

tools/sidebar/model/types/tab/ISidebarTab.ts:29

getType()​

getType(): string

Help function which returns the type of the object.

Returns​

string

Inherited from​

IMapObject.getType

Source​

model/types/object/IMapObject.ts:37

initialize()​

initialize(initProps): this

It initializes the state of the object. It processes the serialized config and sets further objects.

This cannot be done in the object constructor since the object can be created before the Geovisto map is created.

Parameters​

• initProps: TInitProps

Returns​

this

Inherited from​

IMapObject.initialize

Source​

model/types/object/IMapObject.ts:53

redraw()​

redraw(): void

It redraws the content of the sidebar tab.

Returns​

void

Source​

tools/sidebar/model/types/tab/ISidebarTab.ts:51

setChecked()​

setChecked(checked): void

Functions changes layer state to enabled/disabled.

Parameters​

• checked: boolean

Returns​

void

Source​

tools/sidebar/model/types/tab/ISidebarTab.ts:36