Skip to main content

SidebarTabDefaults

geovisto-map • Readme | API

geovisto-map / SidebarTabDefaults

Class: SidebarTabDefaults

This class provide functions which return the default state values.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new SidebarTabDefaults()​

new SidebarTabDefaults(): SidebarTabDefaults

Returns​

SidebarTabDefaults

Inherited from​

MapObjectDefaults.constructor

Properties​

idString?​

protected optional idString: string

Inherited from​

MapObjectDefaults.idString

Source​

model/internal/object/MapObjectDefaults.ts:13

id​

static protected id: number

Inherited from​

MapObjectDefaults.id

Source​

model/internal/object/MapObjectDefaults.ts:12

Methods​

generateId()​

protected generateId(): string

It returns identifier which is used when no identifier is specified.

Returns​

string

Inherited from​

MapObjectDefaults.generateId

Source​

model/internal/object/MapObjectDefaults.ts:54

getConfig()​

getConfig(): ISidebarTabConfig

It returns the default config.

Returns​

ISidebarTabConfig

Implementation of​

ISidebarTabDefaults.getConfig

Overrides​

MapObjectDefaults.getConfig

Source​

tools/sidebar/model/internal/tab/SidebarTabDefaults.ts:18

getIcon()​

getIcon(): string

It returns the icon of the sidebar tab.

Returns​

string

Implementation of​

ISidebarTabDefaults.getIcon

Source​

tools/sidebar/model/internal/tab/SidebarTabDefaults.ts:49

getId()​

getId(): string

It returns identifier which is used when no identifier is specified.

Returns​

string

Implementation of​

ISidebarTabDefaults.getId

Inherited from​

MapObjectDefaults.getId

Source​

model/internal/object/MapObjectDefaults.ts:44

getName()​

getName(): string

It returns name of the sidebar tab.

Returns​

string

Implementation of​

ISidebarTabDefaults.getName

Source​

tools/sidebar/model/internal/tab/SidebarTabDefaults.ts:42

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

ISidebarTabDefaults.getProps

Inherited from​

MapObjectDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getType()​

getType(): string

It returns a unique type string of the sidebar tab.

Returns​

string

Implementation of​

ISidebarTabDefaults.getType

Overrides​

MapObjectDefaults.getType

Source​

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

hasCheckButton()​

hasCheckButton(): boolean

It returns a logical value whether the sidebar tab contains a check button used to enable/disable the tool.

Returns​

boolean

Implementation of​

ISidebarTabDefaults.hasCheckButton

Source​

tools/sidebar/model/internal/tab/SidebarTabDefaults.ts:56

isEnabled()​

isEnabled(): boolean

It returns the default value whether the sidebar tab is enabled.

Returns​

boolean

Implementation of​

ISidebarTabDefaults.isEnabled

Source​

tools/sidebar/model/internal/tab/SidebarTabDefaults.ts:35