Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UI

Hierarchy

Index

Properties

Methods

Properties

container

container: HTMLElement

The HTML Element that contains the view.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly height

height: number

The height of the UI container.

Read more...

initialized

initialized: boolean

padding

padding: any

Defines the padding for the UI from the top, left, right, and bottom sides of the container or View.

Read more...

view

view: MapView | SceneView

The view associated with the UI components.

Read more...

Readonly width

width: number

The width of the UI container.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T

  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): UI

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns UI

add

  • Adds one or more HTML component(s) or widgets to the UI.

    Read more...

    Parameters

    Returns void

destroy

  • destroy(): void

  • Returns void

empty

  • empty(position?: "manual" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "bottom-leading" | "bottom-trailing" | "top-leading" | "top-trailing"): void

  • Removes all components from a given position.

    Read more...

    Parameters

    • Optional position: "manual" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "bottom-leading" | "bottom-trailing" | "top-leading" | "top-trailing"

    Returns void

find

  • find(id: string): HTMLElement | Widget

  • Find a component by widget or DOM ID.

    Read more...

    Parameters

    • id: string

    Returns HTMLElement | Widget

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

move

  • Moves one or more UI component(s) to the specified position.

    Read more...

    Parameters

    Returns void

Protected notifyChange

  • notifyChange(propertyName: string): void

  • Parameters

    • propertyName: string

    Returns void

remove

  • remove(component: string | any[] | HTMLElement | Widget): void

  • Removes one or more HTML component(s) or widgets from the UI.

    Read more...

    Parameters

    • component: string | any[] | HTMLElement | Widget

    Returns void

set

  • set<T>(propertyName: string, value: T): UI
  • set(props: HashMap<any>): UI

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns UI

  • Parameters

    Returns UI

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc