ControlPanel | Data Inspector Library API Reference

Feedback

Last UpdatedMay 7, 2025
7 minute read

A UI element to serve as a container for other widgets.

Hierarchy

WidgetAbstract<ControlPanelProps, ControlPanelState>
- ControlPanel

Index

Constructors

constructor

new ControlPanel(props: ControlPanelProps, container: HTMLElement, state?: ControlPanelState, autoRender?: boolean, eventListeners?: {}): ControlPanel

Inherited from WidgetAbstract.constructor
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:151
inheritdoc

Parameters
- props: ControlPanelProps
- container: HTMLElement
- state: ControlPanelState = ...
- autoRender: boolean = true
- Optional eventListeners: {}
  - [key: string]: (event: THREE.Event) => void
    - - (event: THREE.Event): void
      - Parameters
        
        event: THREE.Event
        
        Returns void
Returns ControlPanel

Properties

container

container: HTMLElement

dataControlSectionName

dataControlSectionName: string = "DATA"

The name of the widget section that contains data controls (such as SdiiControls or RibControls).

Protected m_boundLocaleChanged

m_boundLocaleChanged: undefined | (() => void)

Protected m_element

m_element: undefined | HTMLElement

The HTML element rendered by a widget.

Protected m_listenerHandlers

m_listenerHandlers: { event: string; handler: EventListenerOrEventListenerObject; id: string }[] = ...

An array of created listener handlers that have to be removed by the componentDidUnmount method.

Protected m_storageKey

m_storageKey: string = "control-panel"

A key that is used to store some properties in the session storage. It can be configured over ControlPanelProps.storageKey. Properties that are stored:

[[ControlPanelProps.displayMode]]

Readonly props

props: ControlPanelProps

Readonly Static EVENT_AFTER_MOUNT

EVENT_AFTER_MOUNT: "aftermount" = "aftermount"

This event is fired when a component is mounted.

Readonly Static EVENT_AFTER_UPDATE

EVENT_AFTER_UPDATE: "afterupdate" = "afterupdate"

This event is fired when a component is updated.

Readonly Static EVENT_BEFORE_DESTROY

EVENT_BEFORE_DESTROY: "beforedestroy" = "beforedestroy"

This event is fired on children when they are replaced.

Accessors

elementCurrentWidth

get elementCurrentWidth(): number

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:507
Returns current value of ControlPanel's width in pixels.

Returns number

minWidth

get minWidth(): number

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:498
Returns minimal allowed value for ControlPanel's width in pixels.

Returns number

resizeHandle

get resizeHandle(): undefined | HorizontalResizeHandle

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:378
Returns an instance of the resize handler widget.

Returns undefined | HorizontalResizeHandle

state

get state(): StateType

- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:113
The current state of a widget.

Returns StateType

storageKey

get storageKey(): string

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:297
Returns a key that is used to store some properties in SessionStorage. Used by the toolbar button to remember the user's choice.

Returns string

Methods

addScrollListener

addScrollListener(ds: string, newListener: () => void): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:184
Adds scroll listener for ControlPanel.

Parameters
- ds: string
- newListener: () => void
  - - (): void
    - Returns void
Returns void

addSection

addSection(sectionOptions: ControlPanelSectionProps & CollapsibleWidgetState, position?: number): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:388
Adds a widget section to the control panel.

Parameters
- sectionOptions: ControlPanelSectionProps & CollapsibleWidgetState
  
  The widget section options.
- Optional position: number
  
  A position of the widget section.
Returns void

Protected bubbleEvent

bubbleEvent(event: Event): void

Inherited from WidgetAbstract.bubbleEvent
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:331
Bubbles up an event.

Parameters
- event: Event
  
  An event.
Returns void

componentDidMount

componentDidMount(): void

Overrides WidgetAbstract.componentDidMount
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:282
inheritdoc

Returns void

Protected componentDidUnmount

componentDidUnmount(): void

Overrides WidgetAbstract.componentDidUnmount
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:464
inheritdoc

Returns void

Protected componentDidUpdate

componentDidUpdate(): void

Overrides WidgetAbstract.componentDidUpdate
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:455
inheritdoc

Returns void

Protected createElement

createElement<K>(tagName: K, elementAttributes?: any, className?: string): HTMLElementTagNameMap[K]

Inherited from WidgetAbstract.createElement
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:291
Creates an HTML element and initializes it with provided properties.

Type parameters
- K: "object" | "select" | "input" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"
Parameters
- tagName: K
  
  The tag name of a new element.
- Optional elementAttributes: any
  
  An object that contains new element properties.
- Optional className: string
  
  The CSS class name.
Returns HTMLElementTagNameMap[K]

An HTML element.

Protected createElementId

createElementId(): string

Inherited from WidgetAbstract.createElementId
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:258
Returns a unique identifier used for those DOM elements that don't have a defined id property, but which is required to remove event listeners.

Returns string

getElement

getElement(): HTMLElement

Inherited from WidgetAbstract.getElement
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:154
Returns the HTML element rendered by a widget.

Returns HTMLElement

handleSectionsVisibility

handleSectionsVisibility(activeMode: VisibilityModes): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:422
Updates visibility of added sections.

Parameters
- activeMode: VisibilityModes
  
  The active mode.
Returns void

hide

hide(): void

Overrides WidgetAbstract.hide
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:326
inheritdoc

Returns void

Protected localeChangedHandler

localeChangedHandler(): void

Inherited from WidgetAbstract.localeChangedHandler
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:338
Handler of locale changed event.

Returns void

mountComponent

mountComponent(): void

Inherited from WidgetAbstract.mountComponent
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:177
Mounts a component to the DOM.

Returns void

pluginEditorHideHandler

pluginEditorHideHandler(): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:448
Sets width of ControlPanel to stored value.

Returns void

pluginEditorShowHandler

pluginEditorShowHandler(): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:439
Sets width of ControlPanel to stored value.

Returns void

removeScrollListener

removeScrollListener(ds: string): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:195
Removes scroll listener for ControlPanel.

Parameters
- ds: string
Returns void

render

render(): HTMLElement

Overrides WidgetAbstract.render
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:207
inheritdoc

Returns HTMLElement

Protected resetElement

resetElement(): void

Inherited from WidgetAbstract.resetElement
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:233
Resets the HTML element to create it from scratch and not to update the existing one.

Returns void

resetWidth

resetWidth(): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:370
Resets width and minWidth of the widget element to default values specified in the CSS.

Returns void

setState

setState(state: ControlPanelState): void

Inherited from WidgetAbstract.setState
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:163
Sets a new state for a component.

Parameters
- state: ControlPanelState
Returns void

setWidth

setWidth(width: number, minWidth?: number): void

- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:353
Updates width and minimum width of the control panel element.

Parameters
- width: number
  
  New width for the control panel element.
- Optional minWidth: number
  
  New minimum width for the control panel element.
Returns void

show

show(): void

Overrides WidgetAbstract.show
- Defined in @here/interactive-mapview-ui/lib/ControlPanel.ts:302
inheritdoc

Returns void

Protected unmountComponent

unmountComponent(): void

Inherited from WidgetAbstract.unmountComponent
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:239
Unmounts a component.

Returns void

updateComponent

updateComponent(): void

Inherited from WidgetAbstract.updateComponent
- Defined in @here/interactive-mapview-ui/lib/core/WidgetAbstract.ts:197
Updates a component.

Returns void

Was this article helpful?

Yes No

Data Inspector Library - API Reference

Filters

Product category

Technology

Doc type

Version

Product lifecycle

Data Inspector Library - API Reference: ControlPanel | Data Inspector Library API Reference

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: ControlPanelProps

container: HTMLElement

state: ControlPanelState = ...

autoRender: boolean = true

Optional eventListeners: {}

[key: string]: (event: THREE.Event) => void

Parameters

event: THREE.Event

Returns void

Returns ControlPanel

Properties

container

dataControlSectionName

Protected m_boundLocaleChanged

Protected m_element

Protected m_listenerHandlers

Protected m_storageKey

Readonly props

Readonly Static EVENT_AFTER_MOUNT

Readonly Static EVENT_AFTER_UPDATE

Readonly Static EVENT_BEFORE_DESTROY

Accessors

elementCurrentWidth

Returns number

minWidth

Returns number

resizeHandle

Returns undefined | HorizontalResizeHandle

state

Returns StateType

storageKey

Returns string

Methods

addScrollListener

Parameters

ds: string

newListener: () => void

Returns void

Returns void

addSection

Parameters

sectionOptions: ControlPanelSectionProps & CollapsibleWidgetState

Optional position: number

Returns void

Protected bubbleEvent

Parameters

event: Event

Returns void

componentDidMount

Returns void

Protected componentDidUnmount

Returns void

Protected componentDidUpdate

Returns void

Protected createElement

Type parameters

Parameters

tagName: K

Optional elementAttributes: any

Optional className: string

Returns HTMLElementTagNameMap[K]

Protected createElementId

Returns string