Options
All
  • Public
  • Public/Protected
  • All
Menu

The Component Context provides access to the component's inputs, the page's time range, to the LoggingDataClient and ResourceDataClient and to other application data.

Hierarchy

  • ComponentContext

Index

Properties

appData

appData: AppData

Application data.

destroyed

destroyed: boolean

inputMap

inputMap: Map<string, any>

inputs

inputs: {}

Type declaration

  • [key: string]: any

mode

mode: "edit" | "view"

ontimerangechange

ontimerangechange: null | ((newTimeRange: LoggingDataTimeRange) => any)

onvpnclientstatuschange

onvpnclientstatuschange: null | ((newStatus: null | IxClientStatus) => any)

timeRange

timeRangeIsAdjustable

timeRangeIsAdjustable: boolean

vpnClientStatus

vpnClientStatus: null | IxClientStatus

Methods

createLoggingDataClient

createResourceDataClient

createTooltip

  • Attaches a tooltip on the target element.

    experimental

    Parameters

    • target: HTMLElement

      the target element

    • options: TooltipOptions

      configures the tooltip message and other (optional) properties

    Returns Tooltip

    returns the tooltip instance

destroy

  • destroy(): void
  • Returns void

getApiUrl

  • getApiUrl(rel: string, params?: {}): string
  • Parameters

    • rel: string
    • Optional params: {}
      • [param: string]: string

    Returns string

navigateByUrl

  • navigateByUrl(url: string): void
  • Parameters

    • url: string

    Returns void

saveAsFile

  • saveAsFile(data: string | Blob, fileName: string): void
  • Save a file.

    Parameters

    • data: string | Blob

      the file data to save

    • fileName: string

      the name of the file

    Returns void

setTimeRange

showVpnStatusDetails

  • showVpnStatusDetails(agentId: string): void
  • Parameters

    • agentId: string

    Returns void

testVpnAccess

  • testVpnAccess(agentId: string): boolean
  • Tests whether the currently logged in user has VPN access to the Agent with the given {@code agentId}.

    Parameters

    • agentId: string

      the Agent ID

    Returns boolean

    true if the user has access, false otherwise

toggleVpn

  • toggleVpn(agentId: string): void
  • Parameters

    • agentId: string

    Returns void

translate

  • translate(key: string | string[], interpolateParams?: Object): any
  • Parameters

    • key: string | string[]
    • Optional interpolateParams: Object

    Returns any

Generated using TypeDoc