Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AddStatusArgs

Index

Constructors

constructor

  • new AddStatusArgs(text: string, imageProperties?: ImageProperties, userClosedCallback?: function, id?: string, timeoutMS?: number, showBusyIcon?: boolean): AddStatusArgs
  • Initializes a new instance of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.commandArgs.AddStatusArgs} class.

    Parameters

    • text: string

      The message text to display.

    • Optional imageProperties: ImageProperties

      The URI or class of the image icon to show beside the text and the alt text.

    • Optional userClosedCallback: function

      A callback function to invoke when the status message is dismissed by the user.

        • (): void
        • Returns void

    • Optional id: string

      The ID of the status message. You can use this ID later on for the "PulseStatus" command and the "RemoveStatus" command. If you do not supply a value, an ID will be created and assigned to id property so that you can use it later on.

    • Optional timeoutMS: number

      The timeout in milliseconds after which time the status message will go away. A value of 0 or less than 0 means never time out.

    • Optional showBusyIcon: boolean

      If set to true, then a busy icon will be used - likely an animation to shown activity.

    Returns AddStatusArgs

Properties

Optional closeTitle

closeTitle: string

The title to display on the close button.

Optional id

id: string

The ID of the status message. You can use this ID later on for the "PulseStatus" command and the "RemoveStatus" command. If you do not supply a value, an ID will be created and assigned to id property so that you can use it later on.

type

String

Optional imageProperties

imageProperties: ImageProperties

The uri and/or class of the status image, and the mandatory alt text

type

ImageProperties

Optional regionName

regionName: string

Optional region where status messages are to be shown. If specified, the status messages will be created and activated in this region.

Optional showBusyIcon

showBusyIcon: boolean

If set to true, then a busy icon will be used - likely an animation to shown activity.

type

Boolean

Optional statusClass

statusClass: string

The css class name to apply to the status message.

type

String

text

text: string

The message text to display.

type

String

Optional timeoutMS

timeoutMS: number

The timeout in milliseconds after which time the status message will go away. A value of 0 or less than 0 means never time out.

type

Number

Optional userClosedCallback

userClosedCallback: function

A callback function to invoke when the status message is dismissed by the user.

type

Function

Type declaration

    • (): void
    • Returns void