Options
Menu

Class UpNotifier

Notifiers provide the Intrexx user with prefabricated objects and methods for displaying tooltips that have been adapted for the respective use.

Hierarchy

  • UpNotifier

Index

Accessors

Accessors

Static element

  • get element(): { close: (key: string) => boolean | Promise<{}>; error: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>; notify: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

  • Opens an error, notify or warn tooltip at right bottom.

    example
    Notifier.element.notify(htmlTarget, content, "headline");
Notifier.element.error(htmlTarget, content, "headline");
Notifier.element.close(key);

    Returns { close: (key: string) => boolean | Promise<{}>; error: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>; notify: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

    • close: (key: string) => boolean | Promise<{}>
        • (key: string): boolean | Promise<{}>

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • error: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>
        • (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>): Promise<UpTip | UpTipWin>

        • Parameters

          • htmlTarget: HTMLElement
          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional alignment: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right"
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<UpTip | UpTipWin>

    • notify: (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>
        • (htmlTarget: HTMLElement, content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, alignment?: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right", props?: Partial<IxTooltipSettings>): Promise<UpTip | UpTipWin>

        • Parameters

          • htmlTarget: HTMLElement
          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional alignment: "" | "above_center_center" | "above_center_left" | "above_center_right" | "above_left" | "above_right" | "auto" | "below_center_center" | "below_center_left" | "below_center_right" | "below_left" | "below_right" | "beside_left_bottom" | "beside_left_middle" | "beside_left_top" | "beside_right_bottom" | "beside_right_middle" | "beside_right_top" | "bottom_center" | "bottom_left" | "bottom_right" | "middle_center" | "middle_left" | "middle_right" | "top_center" | "top_left" | "top_right"
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<UpTip | UpTipWin>

Static modal

  • get modal(): { close: (key: string) => boolean | Promise<{}>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>; system: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

  • Opens a notify or system tooltip modal.

    example
    Notifier.modal.notify(content, headline);
Notifier.modal.system(content, headline);
Notifier.modal.close(key);

    Returns { close: (key: string) => boolean | Promise<{}>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>; system: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

    • close: (key: string) => boolean | Promise<{}>
        • (key: string): boolean | Promise<{}>

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<UpTip | UpTipWin>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<UpTip | UpTipWin>

    • system: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<UpTip | UpTipWin>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<UpTip | UpTipWin>

Static mouse

  • get mouse(): { close: (key: string) => boolean | Promise<{}>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

  • Opens a notify tooltip at the current mouse position.

    example
    Notifier.mouse.notify("Text", "Title", "Key", settings);
Notifier.mouse.close(key);

    Returns { close: (key: string) => boolean | Promise<{}>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin> }

    • close: (key: string) => boolean | Promise<{}>
        • (key: string): boolean | Promise<{}>

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<UpTip | UpTipWin>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<UpTip | UpTipWin>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<UpTip | UpTipWin>

Static status

  • get status(): { close: (key: string) => boolean | Promise<{}>; error: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; info: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; warn: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void> }

  • Opens an error, notify or warn tooltip at right bottom.
    Settings see IxTooltipSettings.

    example
    Notifier.status.warn("Content", "Title", "Key", settings);
Notifier.status.error("Content", "Title", "Key", settings);
Notifier.status.notify("Content", "Title", "Key", settings);
Notifier.status.info("Content", "Title", "Key", settings);

    Returns { close: (key: string) => boolean | Promise<{}>; error: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; info: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>; warn: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void> }

    • close: (key: string) => boolean | Promise<{}>
        • (key: string): boolean | Promise<{}>

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • error: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<void>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<void>

    • info: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<void>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<void>

    • notify: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<void>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<void>

    • warn: (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>) => Promise<void>
        • (content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[], title?: string | boolean, key?: string, props?: Partial<IxTooltipSettings>): Promise<void>

        • Parameters

          • Optional content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]
          • Optional title: string | boolean
          • Optional key: string
          • Optional props: Partial<IxTooltipSettings>

          Returns Promise<void>