Skip to content

ResolveStatusBarBandParams

Parameters for resolveStatusBarBand.

Import:

import type { ResolveStatusBarBandParams } from 'obsidian-integration-testing';

Signature:

export interface ResolveStatusBarBandParams

Properties

PropertyTypeDescription
channelCountnumberHow many bytes each pixel occupies in ResolveStatusBarBandParams.pixels — 3 for RGB, 4 for RGBA.
edgeMarginInPixels?numberHow far in from each edge to start reading, in pixels.

A device's rounded corners darken a handful of pixels at both ends of every row in the band, constantly and harmlessly; the check is about what the APP draws, so it ignores them.
heightInPixelsnumberThe height of the band, in pixels — the same number paintOutStatusBar would paint.
pixelsUint8ArrayThe frame's raw pixels, row-major, as sharp's raw() reports them.
sampleInsetInPixels?numberHow far above the band's bottom edge the row is read from, in pixels.

The bar's own content stops short of the band's bottom edge, so the rows immediately under it are empty; this picks one of them.
widthInPixelsnumberThe frame's width, in pixels.

Links to this page: