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

Accessors

element modal mouse status

Accessors

Static element

  • get element(): {
        close: ((key) => boolean | Promise<{}>);
        error: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>);
        notify: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>);
    }

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

    Returns {
        close: ((key) => boolean | Promise<{}>);
        error: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>);
        notify: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>);
    }

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

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • error: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>)
        • (htmlTarget, content?, title?, key?, alignment?, props?): Promise<UpTip | UpTipWin>

        • Parameters

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

          Returns Promise<UpTip | UpTipWin>

    • notify: ((htmlTarget, content?, title?, key?, alignment?, props?) => Promise<UpTip | UpTipWin>)
        • (htmlTarget, content?, title?, key?, alignment?, props?): Promise<UpTip | UpTipWin>

        • Parameters

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

          Returns Promise<UpTip | UpTipWin>

    Example

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

Static modal

  • get modal(): {
        close: ((key) => boolean | Promise<{}>);
        notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
        system: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
    }

  • Opens a notify or system tooltip modal.

    Returns {
        close: ((key) => boolean | Promise<{}>);
        notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
        system: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
    }

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

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>)
        • (content?, title?, key?, props?): 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?, title?, key?, props?) => Promise<UpTip | UpTipWin>)
        • (content?, title?, key?, props?): 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>

    Example

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

Static mouse

  • get mouse(): {
        close: ((key) => boolean | Promise<{}>);
        notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
    }

  • Opens a notify tooltip at the current mouse position.

    Returns {
        close: ((key) => boolean | Promise<{}>);
        notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>);
    }

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

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • notify: ((content?, title?, key?, props?) => Promise<UpTip | UpTipWin>)
        • (content?, title?, key?, props?): 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>

    Example

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

Static status

  • get status(): {
        close: ((key) => boolean | Promise<{}>);
        error: ((content?, title?, key?, props?) => Promise<void>);
        info: ((content?, title?, key?, props?) => Promise<void>);
        notify: ((content?, title?, key?, props?) => Promise<void>);
        warn: ((content?, title?, key?, props?) => Promise<void>);
    }

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

    Returns {
        close: ((key) => boolean | Promise<{}>);
        error: ((content?, title?, key?, props?) => Promise<void>);
        info: ((content?, title?, key?, props?) => Promise<void>);
        notify: ((content?, title?, key?, props?) => Promise<void>);
        warn: ((content?, title?, key?, props?) => Promise<void>);
    }

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

        • Parameters

          • key: string

          Returns boolean | Promise<{}>

    • error: ((content?, title?, key?, props?) => Promise<void>)
        • (content?, title?, key?, props?): 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?, title?, key?, props?) => Promise<void>)
        • (content?, title?, key?, props?): 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?, title?, key?, props?) => Promise<void>)
        • (content?, title?, key?, props?): 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?, title?, key?, props?) => Promise<void>)
        • (content?, title?, key?, props?): Promise<void>

        • Parameters

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

          Returns Promise<void>

    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);

Settings

Member Visibility

Theme

On This Page