Back to Content

TextMetrics: fontBoundingBoxAscent property

files/en-us/web/api/textmetrics/fontboundingboxascent/index.md

latest1.2 KB
Original Source

{{APIRef("Canvas API")}}{{AvailableInWorkers}}

The read-only fontBoundingBoxAscent property of the {{domxref("TextMetrics")}} interface returns the distance from the horizontal line indicated by the {{domxref("CanvasRenderingContext2D.textBaseline")}} attribute, to the top of the highest bounding rectangle of all the fonts used to render the text, in CSS pixels.

Value

A number, in CSS pixels.

Examples

The code below shows how you can get the fontBoundingBoxAscent for some text in a particular font.

js
const canvas = document.createElement("canvas");
const ctx = canvas.getContext("2d");

ctx.font = "25px serif";
const text = "Foo";

const textMetrics = ctx.measureText(text); // returns TextMetrics object
const ascentCssPixels = textMetrics.fontBoundingBoxAscent;
html
<p id="log"></p>
js
const log = document.getElementById("log");
log.innerText = `fontBoundingBoxAscent: ${ascentCssPixels}`;

The ascent in CSS pixels for the text "Foo" in a 25px serif font is shown below.

{{EmbedLiveSample('Examples', 100, 50)}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("TextMetrics.fontBoundingBoxDescent")}}
  • {{domxref("TextMetrics")}}