Skip to main content

ISidebarTabState

geovisto-mapReadme | API


geovisto-map / ISidebarTabState

Interface: ISidebarTabState\<TProps, TDefaults, TConfig>

This interface declares the state of the sidebar tab. It wraps the state since the sidebar tab can work with state objects which needs to be explicitly serialized.

Author

Jiri Hynek

Extends

Type parameters

TProps extends ISidebarTabProps = ISidebarTabProps

TDefaults extends ISidebarTabDefaults = ISidebarTabDefaults

TConfig extends ISidebarTabConfig = ISidebarTabConfig

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

config: TConfig

Returns

void

Inherited from

IMapObjectState.deserialize

Source

model/types/object/IMapObjectState.ts:32


getContent()

getContent(): null | HTMLElement

It returns the tabPane property of the sidebar tab state.

Returns

null | HTMLElement

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:100


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/ISidebarTabState.ts:112


getIcon()

getIcon(): string

It returns the icon property of the sidebar tab state.

Returns

string

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:64


getId()

getId(): string

It returns the id property of the map object state.

Returns

string

Inherited from

IMapObjectState.getId

Source

model/types/object/IMapObjectState.ts:49


getName()

getName(): string

It returns the name property of the sidebar tab state.

Returns

string

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:52


getSidebarTool()

getSidebarTool(): ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

It returns the sidebar property of the sidebar tab state.

Returns

ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:88


getTool()

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

It returns the tool property of the sidebar tab state.

Returns

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

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:28


getType()

getType(): string

It returns the type property of the map object state.

Returns

string

Inherited from

IMapObjectState.getType

Source

model/types/object/IMapObjectState.ts:44


hasCheckButton()

hasCheckButton(): boolean

It returns the checkButton property of the sidebar tab state.

Returns

boolean

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:76


initialize()

initialize(defaults, props, initProps): void

It resets the state to the initial state.

Parameters

defaults: TDefaults

props: TProps

initProps: IMapObjectInitProps\<TConfig>

Returns

void

Inherited from

IMapObjectState.initialize

Source

model/types/object/IMapObjectState.ts:25


isEnabled()

isEnabled(): boolean

It returns the enabled property of the sidebar tab state.

Returns

boolean

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:40


serialize()

serialize(defaults): TConfig

The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

defaults: undefined | TDefaults

Returns

TConfig

Inherited from

IMapObjectState.serialize

Source

model/types/object/IMapObjectState.ts:39


setCheckButton()

setCheckButton(checkButton): void

It sets the checkButton property of the sidebar tab state.

Parameters

checkButton: boolean

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:83


setContent()

setContent(content): void

It sets the tabPane property of the sidebar tab state.

Parameters

content: HTMLElement

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:107


setEnabled()

setEnabled(enabled): void

It sets the enabled property of the sidebar tab state.

Parameters

enabled: boolean

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:47


setFragments()

setFragments(fragments): void

It sets the fragments property of the sidebar tab state.

Parameters

fragments: ISidebarFragment\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentState\<ISidebarFragmentProps, ISidebarFragmentDefaults, ISidebarFragmentConfig>, ISidebarFragmentConfig, ISidebarFragmentInitProps\<ISidebarFragmentConfig>>[]

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:119


setIcon()

setIcon(icon): void

It sets the icon property of the sidebar tab state.

Parameters

icon: string

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:71


setId()

setId(id): void

It sets the id property of the map object state. It can be set only once.

Parameters

id: string

Returns

void

Inherited from

IMapObjectState.setId

Source

model/types/object/IMapObjectState.ts:57


setName()

setName(name): void

It sets the name property of the sidebar tab state.

Parameters

name: string

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:59


setSidebarTool()

setSidebarTool(sidebar): void

It sets the sidebar property of the sidebar tab state.

Parameters

sidebar: ISidebarTool\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolState\<ISidebarToolProps, ISidebarToolDefaults, ISidebarToolConfig>, ISidebarToolConfig, IMapToolInitProps\<ISidebarToolConfig>>

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:95


setTool()

setTool(tool): void

It sets the tool property of the sidebar tab state.

Parameters

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

Returns

void

Source

tools/sidebar/model/types/tab/ISidebarTabState.ts:35