Static Functions

Root static functions of SvgTooltip Component

NameParametersReturnsDescription
calculateShapes

  • location

    : TooltipLocation

  • size

    : Size

  • shape

    : string

  • options

    : PathOption
    • Object

    Calculates the shape rendering options for a tooltip marker based on shape type.


    Params:
  • location: The location coordinates for the shape.
  • size: The size dimensions for the shape.
  • shape: The type of shape to render (e.g., 'Circle', 'Rectangle', 'Diamond').
  • options: The base rendering options for the shape.
    • createPathOption

  • id

    : string

  • fill

    : string

  • opacity

    : number

  • stroke

    : string

  • strokeWidth

    : number

  • dashArray

    : string | null
    • PathOption

    Creates a PathOption object for path rendering.


    Params:
  • id: The unique identifier for the path element.
  • fill: The fill color for the path.
  • opacity: The opacity value for the path.
  • stroke: The stroke color for the path.
  • strokeWidth: The stroke width for the path.
  • dashArray: The dash array pattern for the path, or null for solid line.
    • createRect

  • x

    : number

  • y

    : number

  • width

    : number

  • height

    : number
    • Rect

    Creates a Rect object with specified position and dimensions.


    Params:
  • x: The x-coordinate of the rectangle.
  • y: The y-coordinate of the rectangle.
  • width: The width of the rectangle.
  • height: The height of the rectangle.
    • createSize

  • width

    : number

  • height

    : number
    • Size

    Creates a Size object with specified width and height.


    Params:
  • width: The width value.
  • height: The height value.
    • createTooltipLocation

  • x

    : number

  • y

    : number
    • TooltipLocation

    Creates a TooltipLocation object with specified coordinates.


    Params:
  • x: The x-coordinate for the tooltip.
  • y: The y-coordinate for the tooltip.
    • findDirection

  • rX

    : number

  • rY

    : number

  • rect

    : Rect

  • arrowLocation

    : TooltipLocation

  • arrowPadding

    : number

  • top

    : boolean

  • bottom

    : boolean

  • left

    : boolean

  • tipX

    : number

  • tipY

    : number
    • string

    Determines the path direction for tooltip rendering based on positioning parameters.


    Params:
  • rX: The x-radius for rounded corners.
  • rY: The y-radius for rounded corners.
  • rect: The rectangle defining the tooltip area.
  • arrowLocation: The location for the tooltip arrow.
  • arrowPadding: The padding around the arrow.
  • top: Whether the tooltip is positioned at the top.
  • bottom: Whether the tooltip is positioned at the bottom.
  • left: Whether the tooltip is positioned at the left.
  • tipX: The x-coordinate of the tooltip tip.
  • tipY: The y-coordinate of the tooltip tip.
    • getTooltipThemeColor

  • theme

    : TooltipTheme
    • ITooltipThemeStyle

    Determines the appropriate theme styles for tooltips based on the specified theme.


    Params:
  • theme: The current theme for which tooltip styles are needed.
    • measureText
    -
    Size

    Measures the dimensions of text with specified font styles.

    withInAreaBounds
    -
    boolean

    Checks if the provided coordinates are within the bounds of the area.

    calculateShapes

  • location

    : TooltipLocation

  • size

    : Size

  • shape

    : string

  • options

    : PathOption
    • Object

    Calculates the shape rendering options for a tooltip marker based on shape type.


    Params:
  • location: The location coordinates for the shape.
  • size: The size dimensions for the shape.
  • shape: The type of shape to render (e.g., 'Circle', 'Rectangle', 'Diamond').
  • options: The base rendering options for the shape.
    • createPathOption

  • id

    : string

  • fill

    : string

  • opacity

    : number

  • stroke

    : string

  • strokeWidth

    : number

  • dashArray

    : string | null
    • PathOption

    Creates a PathOption object for path rendering.


    Params:
  • id: The unique identifier for the path element.
  • fill: The fill color for the path.
  • opacity: The opacity value for the path.
  • stroke: The stroke color for the path.
  • strokeWidth: The stroke width for the path.
  • dashArray: The dash array pattern for the path, or null for solid line.
    • createRect

  • x

    : number

  • y

    : number

  • width

    : number

  • height

    : number
    • Rect

    Creates a Rect object with specified position and dimensions.


    Params:
  • x: The x-coordinate of the rectangle.
  • y: The y-coordinate of the rectangle.
  • width: The width of the rectangle.
  • height: The height of the rectangle.
    • createSize

  • width

    : number

  • height

    : number
    • Size

    Creates a Size object with specified width and height.


    Params:
  • width: The width value.
  • height: The height value.
    • createTooltipLocation

  • x

    : number

  • y

    : number
    • TooltipLocation

    Creates a TooltipLocation object with specified coordinates.


    Params:
  • x: The x-coordinate for the tooltip.
  • y: The y-coordinate for the tooltip.
    • findDirection

  • rX

    : number

  • rY

    : number

  • rect

    : Rect

  • arrowLocation

    : TooltipLocation

  • arrowPadding

    : number

  • top

    : boolean

  • bottom

    : boolean

  • left

    : boolean

  • tipX

    : number

  • tipY

    : number
    • string

    Determines the path direction for tooltip rendering based on positioning parameters.


    Params:
  • rX: The x-radius for rounded corners.
  • rY: The y-radius for rounded corners.
  • rect: The rectangle defining the tooltip area.
  • arrowLocation: The location for the tooltip arrow.
  • arrowPadding: The padding around the arrow.
  • top: Whether the tooltip is positioned at the top.
  • bottom: Whether the tooltip is positioned at the bottom.
  • left: Whether the tooltip is positioned at the left.
  • tipX: The x-coordinate of the tooltip tip.
  • tipY: The y-coordinate of the tooltip tip.
    • getTooltipThemeColor

  • theme

    : TooltipTheme
    • ITooltipThemeStyle

    Determines the appropriate theme styles for tooltips based on the specified theme.


    Params:
  • theme: The current theme for which tooltip styles are needed.
    • measureText
    -
    Size

    Measures the dimensions of text with specified font styles.

    withInAreaBounds
    -
    boolean

    Checks if the provided coordinates are within the bounds of the area.