Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MatLegacyTooltip
    • LinqOptionalToolTipDirective

Index

Constructors

  • new LinqOptionalToolTipDirective(overlay: Overlay, elementRef: ElementRef<HTMLElement>, scrollDispatcher: ScrollDispatcher, viewContainerRef: ViewContainerRef, ngZone: NgZone, platform: Platform, ariaDescriber: AriaDescriber, focusMonitor: FocusMonitor, scrollStrategy: any, dir: Directionality, defaultOptions: MatTooltipDefaultOptions, _document: any): LinqOptionalToolTipDirective
  • Parameters

    • overlay: Overlay
    • elementRef: ElementRef<HTMLElement>
    • scrollDispatcher: ScrollDispatcher
    • viewContainerRef: ViewContainerRef
    • ngZone: NgZone
    • platform: Platform
    • ariaDescriber: AriaDescriber
    • focusMonitor: FocusMonitor
    • scrollStrategy: any
    • dir: Directionality
    • defaultOptions: MatTooltipDefaultOptions
    • _document: any

    Returns LinqOptionalToolTipDirective

Properties

_cssClassPrefix: string
_dir: Directionality
_overlayRef: OverlayRef
_tooltipComponent: typeof LegacyTooltipComponent
_tooltipInstance: LegacyTooltipComponent
_viewportMargin: number
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.
ɵdir: unknown
ɵfac: unknown

Accessors

  • get disabled(): boolean
  • set disabled(value: BooleanInput): void
  • Disables the display of the tooltip.

    Returns boolean

  • Disables the display of the tooltip.

    Parameters

    • value: BooleanInput

    Returns void

  • get hideDelay(): number
  • set hideDelay(value: NumberInput): void
  • The default delay in ms before hiding the tooltip after hide is called

    Returns number

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

    Parameters

    • value: NumberInput

    Returns void

  • 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

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

  • Parameters

    • txt: string

    Returns void

  • 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

  • get positionAtOrigin(): boolean
  • set positionAtOrigin(value: BooleanInput): void
  • Whether tooltip should be relative to the click or touch origin instead of outside the element bounding box.

    Returns boolean

  • Whether tooltip should be relative to the click or touch origin instead of outside the element bounding box.

    Parameters

    • value: BooleanInput

    Returns void

  • get showDelay(): number
  • set showDelay(value: NumberInput): void
  • The default delay in ms before showing the tooltip after show is called

    Returns number

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

    Parameters

    • value: NumberInput

    Returns void

  • 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

  • _addOffset(position: ConnectedPosition): ConnectedPosition
  • Adds the configured offset to a position. Used as a hook for child classes.

    Parameters

    • position: ConnectedPosition

    Returns ConnectedPosition

  • _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(): { 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(): boolean
  • Returns true if the tooltip is currently visible to the user

    Returns boolean

  • check(): void
  • Returns void

  • 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(): void
  • Returns void

  • ngOnDestroy(): void
  • Dispose the tooltip when destroyed.

    Returns void

  • show(delay?: number, origin?: { x: number; y: number }): void
  • Shows the tooltip after the delay in ms, defaults to tooltip-delay-show or 0ms if no input

    Parameters

    • Optional delay: number
    • Optional origin: { x: number; y: number }
      • x: number
      • y: number

    Returns void

  • toggle(origin?: { x: number; y: number }): void
  • Shows/hides the tooltip

    Parameters

    • Optional origin: { x: number; y: number }
      • x: number
      • y: number

    Returns void

Generated using TypeDoc