Class D3Renderer

constructor

• new D3Renderer(
      container: HTMLElement,
      ft: FamilyTree,
      opts?: Partial<D3RendererOptions>,
  ): D3Renderer

  Constructs a new D3Renderer.

  Parameters

  • container: HTMLElement

    The HTML element to render into.

  • ft: FamilyTree

    The FamilyTree instance to visualize.

  • Optionalopts: Partial<D3RendererOptions>

    Optional renderer options to override defaults.

  Returns D3Renderer

opts

container

• get container(): HTMLElement

  Gets the current container element.

  Returns HTMLElement

• set container(c: HTMLElement): void

  Sets the container element and initializes the SVG and tooltip.

  Parameters

  • c: HTMLElement

  Returns void

clear

• clear(): void

  Deletes all rendered elements from the SVG.

  Returns void

render

• render(
      layoutResult: LayoutResult,
      previousPosition?: Coordinates,
      newPosition?: Coordinates,
  ): void

  Main render function. Draws the current layout, updates nodes and links, tooltips, and labels. Also centers the view on the clicked node unless running in JSDOM.

  Parameters

  • layoutResult: LayoutResult

    The layout result to render.

  • OptionalpreviousPosition: Coordinates

    Optional previous position for transitions.

  • OptionalnewPosition: Coordinates

    Optional new position for transitions.

  Returns void