Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LinqOptionalToolTipDirective

Hierarchy

  • MatTooltip
    • LinqOptionalToolTipDirective

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new LinqOptionalToolTipDirective(el: ElementRef<any>, _overlay: Overlay, _scrollDispatcher: ScrollDispatcher, _viewContainerRef: ViewContainerRef, _ngZone: NgZone, _platform: Platform, _ariaDescriber: AriaDescriber, _focusMonitor: FocusMonitor, _scrollStrategy: any, _dir: Directionality, _defaultOptions: MatTooltipDefaultOptions): LinqOptionalToolTipDirective

  • Parameters

    • el: ElementRef<any>
    • _overlay: Overlay
    • _scrollDispatcher: ScrollDispatcher
    • _viewContainerRef: ViewContainerRef
    • _ngZone: NgZone
    • _platform: Platform
    • _ariaDescriber: AriaDescriber
    • _focusMonitor: FocusMonitor
    • _scrollStrategy: any
    • _dir: Directionality
    • _defaultOptions: MatTooltipDefaultOptions

    Returns LinqOptionalToolTipDirective

Properties

_overlayRef

_overlayRef: OverlayRef

_tooltipInstance

_tooltipInstance: TooltipComponent

hideDelay

hideDelay: number

The default delay in ms before hiding the tooltip after hide is called

showDelay

showDelay: number

The default delay in ms before showing the tooltip after show is called

touchGestures

touchGestures: TooltipTouchGestures

How touch gestures should be handled by the tooltip. On touch devices the tooltip directive uses a long press gesture to show and hide, however it can conflict with the native browser gestures. To work around the conflict, Angular Material disables native gestures on the trigger, but that might not be desirable on particular elements (e.g. inputs and draggable elements). The different values for this option configure the touch event handling as follows:

  • auto - Enables touch gestures for all elements, but tries to avoid conflicts with native browser gestures on particular elements. In particular, it allows text selection on inputs and textareas, and preserves the native browser dragging on elements marked as draggable.
  • on - Enables touch gestures for all elements and disables native browser gestures with no exceptions.
  • off - Disables touch gestures. Note that this will prevent the tooltip from showing on touch devices.

Static ngAcceptInputType_disabled

ngAcceptInputType_disabled: string | boolean

Static ngAcceptInputType_hideDelay

ngAcceptInputType_hideDelay: string | number

Static ngAcceptInputType_showDelay

ngAcceptInputType_showDelay: string | number

Static ɵdir

ɵdir: ɵɵDirectiveDefWithMeta<MatTooltip, "[matTooltip]", ["matTooltip"], { disabled: "matTooltipDisabled"; hideDelay: "matTooltipHideDelay"; message: "matTooltip"; position: "matTooltipPosition"; showDelay: "matTooltipShowDelay"; tooltipClass: "matTooltipClass"; touchGestures: "matTooltipTouchGestures" }, {}, never>

Static ɵfac

ɵfac: ɵɵFactoryDef<MatTooltip, [null, null, null, null, null, null, null, null, null, { optional: true }, { optional: true }]>

Accessors

disabled

  • get disabled(): boolean
  • set disabled(value: boolean): void

  • Disables the display of the tooltip.

    Returns boolean

  • Disables the display of the tooltip.

    Parameters

    • value: boolean

    Returns void

message

  • get message(): string
  • set message(value: string): void

  • The message to be displayed in the tooltip

    Returns string

  • The message to be displayed in the tooltip

    Parameters

    • value: string

    Returns void

optionalToolTip

  • get optionalToolTip(): string
  • set optionalToolTip(txt: string): void

  • Returns string

  • Parameters

    • txt: string

    Returns void

position

  • get position(): TooltipPosition
  • set position(value: TooltipPosition): void

  • Allows the user to define the position of the tooltip relative to the parent element

    Returns TooltipPosition

  • Allows the user to define the position of the tooltip relative to the parent element

    Parameters

    • value: TooltipPosition

    Returns void

tooltipClass

  • get tooltipClass(): string | string[] | Set<string> | {}
  • set tooltipClass(value: string | string[] | Set<string> | {}): void

  • Classes to be passed to the tooltip. Supports the same syntax as ngClass.

    Returns string | string[] | Set<string> | {}

  • Classes to be passed to the tooltip. Supports the same syntax as ngClass.

    Parameters

    • value: string | string[] | Set<string> | {}

    Returns void

Methods

_getOrigin

  • _getOrigin(): { fallback: OriginConnectionPosition; main: OriginConnectionPosition }

  • Returns the origin position and a fallback position based on the user's position preference. The fallback position is the inverse of the origin (e.g. 'below' -> 'above').

    Returns { fallback: OriginConnectionPosition; main: OriginConnectionPosition }

    • fallback: OriginConnectionPosition
    • main: OriginConnectionPosition

_getOverlayPosition

  • _getOverlayPosition(): { fallback: OverlayConnectionPosition; main: OverlayConnectionPosition }

  • Returns the overlay position and a fallback position based on the user's preference

    Returns { fallback: OverlayConnectionPosition; main: OverlayConnectionPosition }

    • fallback: OverlayConnectionPosition
    • main: OverlayConnectionPosition

_isTooltipVisible

  • _isTooltipVisible(): boolean

  • Returns true if the tooltip is currently visible to the user

    Returns boolean

check

  • check(): void

  • Returns void

hide

  • hide(delay?: number): void

  • Hides the tooltip after the delay in ms, defaults to tooltip-delay-hide or 0ms if no input

    Parameters

    • Optional delay: number

    Returns void

ngAfterViewInit

  • ngAfterViewInit(): void

  • Returns void

ngOnDestroy

  • ngOnDestroy(): void

  • Dispose the tooltip when destroyed.

    Returns void

show

  • show(delay?: number): void

  • Shows the tooltip after the delay in ms, defaults to tooltip-delay-show or 0ms if no input

    Parameters

    • Optional delay: number

    Returns void

toggle

  • toggle(): void

  • Shows/hides the tooltip

    Returns void

Generated using TypeDoc