Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

autoCollapse

autoCollapse: boolean

Automatically collapses the expand widget instance when the view's viewpoint updates.

Read more...

closeOnEsc

closeOnEsc: boolean | Function

When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.

Read more...

collapseIconClass

collapseIconClass: string

Icon font used to style the Expand button.

Read more...

collapseTooltip

collapseTooltip: string

Tooltip to display to indicate Expand widget can be collapsed.

Read more...

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

content

content: string | Node | Widget

The content to display within the expanded Expand widget.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

expandIconClass

expandIconClass: string

Icon font used to style the Expand button.

Read more...

expandTooltip

expandTooltip: string

Tooltip to display to indicate Expand widget can be expanded.

Read more...

expanded

expanded: boolean

Indicates whether the widget is currently expanded or not.

Read more...

group

group: string

This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded.

Read more...

iconNumber

iconNumber: number

A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.

Read more...

id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

initialized

initialized: boolean

label

label: string

The widget's label.

Read more...

mode

mode: "auto" | "floating" | "drawer"

The mode in which the widget displays.

Read more...

view

A reference to the MapView or SceneView.

Read more...

viewModel

viewModel: ExpandViewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

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): Expand
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Expand

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

collapse

  • collapse(): void
  • Collapse the widget.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

expand

  • expand(): void
  • Expand the widget.

    Read more...

    Returns void

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Expand

  • Parameters

    Returns Expand

toggle

  • toggle(): void
  • Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded.

    Read more...

    Returns void

watch

  • Parameters

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

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc