GetTextDimensions

Returns the width and height dimensions of a text string.

Syntax

GetTextDimensions(text: string): { width: number; height: number }

Parameters

• text: string - The text string to measure

Return Value

Returns an object with the following properties:

• width: number - The width of the text in pixels

• height: number - The height of the text in pixels

Description

The GetTextDimensions method calculates the dimensions of a text string using the current chart's canvas context. This is useful for positioning text objects and ensuring they fit within available space.

Example

// Get dimensions of a simple text string
const dimensions1 = this.api.GetTextDimensions("Hello World");
console.log(`Width: ${dimensions1.width}px, Height: ${dimensions1.height}px`);

// Use dimensions for positioning a text object
const text = "Price Label";
const dimensions = this.api.GetTextDimensions(text);
const padding = 5;

// Create text object with proper spacing
this.api.СreateChartObject(
  "MyLabel",
  TObjectType.TEXT,
  0,
  this.api.createFTODate(1641024000000),
  1.2
);
this.api.SetObjectText("MyLabel", text);

// Position text to avoid overlapping
const xOffset = dimensions.width / 2 + padding;
const yOffset = dimensions.height + padding;

// Example of checking if text fits in a given space
function doesTextFit(
  text: string,
  maxWidth: number,
  maxHeight: number
): boolean {
  const { width, height } = this.api.GetTextDimensions(text);
  return width <= maxWidth && height <= maxHeight;
}

// Example of truncating text to fit
function truncateTextToFit(text: string, maxWidth: number): string {
  const ellipsis = "...";
  let truncated = text;

  while (
    this.api.GetTextDimensions(truncated + ellipsis).width > maxWidth &&
    truncated.length > 0
  ) {
    truncated = truncated.slice(0, -1);
  }

  return truncated.length < text.length ? truncated + ellipsis : text;
}