Skip to main content

SidebarTabState

geovisto-mapReadme | API


geovisto-map / SidebarTabState

Class: SidebarTabState

This class manages 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

Implements

Constructors

new SidebarTabState()

new SidebarTabState(sidebarTab): SidebarTabState

It creates a sidebar tab state.

Parameters

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

Returns

SidebarTabState

Overrides

MapObjectState.constructor

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:45

Properties

checkButton

private checkButton: boolean

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:32


content

private content: null | HTMLElement

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:38


enabled

private enabled: boolean

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:26


fragments?

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

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:36


icon

private icon: string

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:30


name

private name: string

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:28


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

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:34


tool

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

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:24

Methods

deserialize()

deserialize(config): void

The function takes config and deserializes the values.

Parameters

config: ISidebarTabConfig

Returns

void

Implementation of

ISidebarTabState.deserialize

Overrides

MapObjectState.deserialize

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:76


getContent()

getContent(): null | HTMLElement

It returns the HTML content property of the sidebar tab state.

Returns

null | HTMLElement

Implementation of

ISidebarTabState.getContent

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:214


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>>[]

Implementation of

ISidebarTabState.getFragments

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:230


getIcon()

getIcon(): string

It returns the icon property of the sidebar tab state.

Returns

string

Implementation of

ISidebarTabState.getIcon

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:166


getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

ISidebarTabState.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


getName()

getName(): string

It returns the name property of the sidebar tab state.

Returns

string

Implementation of

ISidebarTabState.getName

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:150


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>>

Implementation of

ISidebarTabState.getSidebarTool

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:198


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>

Implementation of

ISidebarTabState.getTool

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:118


getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ISidebarTabState.getType

Inherited from

MapObjectState.getType

Source

model/internal/object/MapObjectState.ts:80


hasCheckButton()

hasCheckButton(): boolean

It returns the checkButton property of the sidebar tab state.

Returns

boolean

Implementation of

ISidebarTabState.hasCheckButton

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:182


initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

defaults: ISidebarTabDefaults

props: ISidebarTabProps

initProps: ISidebarTabInitProps\<ISidebarTabConfig>

Returns

void

Implementation of

ISidebarTabState.initialize

Overrides

MapObjectState.initialize

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:54


isEnabled()

isEnabled(): boolean

It returns the enabled property of the sidebar tab state.

Returns

boolean

Implementation of

ISidebarTabState.isEnabled

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:134


serialize()

serialize(defaults): ISidebarTabConfig

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

Parameters

defaults: undefined | ISidebarTabDefaults

Returns

ISidebarTabConfig

Implementation of

ISidebarTabState.serialize

Overrides

MapObjectState.serialize

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:89


setCheckButton()

setCheckButton(checkButton): void

It sets the checkButton property of the sidebar tab state.

Parameters

checkButton: boolean

Returns

void

Implementation of

ISidebarTabState.setCheckButton

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:191


setContent()

setContent(content): void

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

Parameters

content: HTMLElement

Returns

void

Implementation of

ISidebarTabState.setContent

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:223


setEnabled()

setEnabled(enabled): void

It sets the enabled property of the sidebar tab state.

Parameters

enabled: boolean

Returns

void

Implementation of

ISidebarTabState.setEnabled

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:143


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

Implementation of

ISidebarTabState.setFragments

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:239


setIcon()

setIcon(icon): void

It sets the icon property of the sidebar tab state.

Parameters

icon: string

Returns

void

Implementation of

ISidebarTabState.setIcon

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:175


setId()

setId(id): void

It sets the id property of the tool state.

Parameters

id: string

Returns

void

Implementation of

ISidebarTabState.setId

Inherited from

MapObjectState.setId

Source

model/internal/object/MapObjectState.ts:96


setName()

setName(name): void

It sets the name property of the sidebar tab state.

Parameters

name: string

Returns

void

Implementation of

ISidebarTabState.setName

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:159


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

Implementation of

ISidebarTabState.setSidebarTool

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:207


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

Implementation of

ISidebarTabState.setTool

Source

tools/sidebar/model/internal/tab/SidebarTabState.ts:127