Powered by Zoomin Software. For more details please contactZoomin

Data Inspector Library - API Reference

Filters

Clear All Filters
Product category
Technology
Doc type
Version
Product lifecycle
Clear All Filters
This publication

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

Share
Share to emailCopy article URL
Feedback
Print
Table of Contents
HomeData Inspector Library - API Reference...Modules@here/interactive-mapview-uiInfoPanel | Data Inspector Library API ReferenceCurrent page
Table of Contents

InfoPanel | Data Inspector Library API Reference

Share
Share to emailCopy article URL
Feedback
Print

InfoPanel is a class to render a panel with full information about the selected feature.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • inheritdoc

    Parameters

    • props: InfoPanelProps
    • container: HTMLElement
    • state: InfoWidgetState = ...
    • autoRender: boolean = true
    • Optional eventListeners: {}
      • [key: string]: (event: THREE.Event) => void
          • (event: THREE.Event): void

          • Parameters

            • event: THREE.Event

            Returns void

    Returns InfoPanel

Properties

container

container: HTMLElement

Readonly element

element: HTMLElement

An HTML element rendered by the widget.

Protected m_boundHide

m_boundHide: () => void = ...

Hides the info widget by updating its visibility in InfoWidgetState. This function is bound to an instance of the widget and can be used in event listeners.

Type declaration

    • (): void

    • Hides the info widget by updating its visibility in InfoWidgetState.

      Returns void

Protected m_boundLocaleChanged

m_boundLocaleChanged: undefined | (() => void)

Protected m_element

m_element: undefined | HTMLElement

The HTML element rendered by a widget.

Protected m_infoElement

m_infoElement: HTMLUListElement

An HTML element to contain a list of information items.

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.

Readonly props

props: InfoPanelProps

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

state

  • get state(): StateType

  • The current state of a widget.

    Returns StateType

Methods

Protected bubbleEvent

  • bubbleEvent(event: Event): void

  • Bubbles up an event.

    Parameters

    • event: Event

      An event.

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUnmount

  • componentDidUnmount(): void

Protected componentDidUpdate

  • componentDidUpdate(): void

  • Called after a component is updated. Must only be called once.

    Returns void

Protected createElement

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

  • 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

  • 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

destroy

  • destroy(): void

  • Destroys the info widget and removes all associated event listeners.

    Returns void

getElement

  • getElement(): HTMLElement

  • Returns the HTML element rendered by a widget.

    Returns HTMLElement

getInfoContent

Protected getPropertiesTable

  • getPropertiesTable(content: {}, props: string[]): HTMLTableSectionElement

  • Generates an HTML <tbody> element with properties from object.

    Parameters

    • content: {}

      Content object.

      • [key: string]: any
    • props: string[]

      Properties to enlist in table.

    Returns HTMLTableSectionElement

hide

  • hide(): void

  • Hides the info widget by updating its visibility in InfoWidgetState.

    Returns void

Protected localeChangedHandler

  • localeChangedHandler(): void

  • Handler of locale changed event.

    Returns void

mountComponent

  • mountComponent(): void

  • Mounts a component to the DOM.

    Returns void

render

  • render(): HTMLElement
  • inheritdoc

    Returns HTMLElement

Protected resetElement

  • resetElement(): void

  • Resets the HTML element to create it from scratch and not to update the existing one.

    Returns void

Protected sanitizeHTML

  • sanitizeHTML(value: string): string

  • Sanitizes an input HTML string by omitting potentially malicious tags and attributes.

    Parameters

    • value: string

      Source HTML.

    Returns string

    Sanitized HTML.

setState

  • Sets a new state for a component.

    Parameters

    Returns void

show

  • show(): void

  • Shows a widget. It basically adds a class "hidden" to the root element.

    Returns void

Protected unmountComponent

  • unmountComponent(): void

  • Unmounts a component.

    Returns void

updateComponent

  • updateComponent(): void

  • Updates a component.

    Returns void

updateContent

  • Updates the info widget content and position according to data from an intersection event.

    Parameters

    • event: InteractiveIntersectionEvent

      The intersection event.

    • position: Vector2

      Coordinates to place info widget.

    • Optional content: (string | InfoWidgetContent)[]

      Custom content to be shown in the widget. If omitted, content will be retrieved from the event.

    Returns void

Protected updateInfoElement

  • updateInfoElement(): HTMLUListElement

  • Updates an HTML element with the information from the current state. If InfoWidgetState.content contains a string with HTML, it is sanitized to have only whitelisted tags and exclude potentially malicious attributes.

    Returns HTMLUListElement

    An HTML element with information.

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Interface
  • Interface with type parameter
  • Enumeration
In This Article
Was this article helpful?
YesNo
TitleResults for “How to create a CRG?”Also Available inAlert