Remove Background Color

remove-background-color

Use Remove Background Color through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool IDremove-background-color

バージョン1

実行方式CLIENT

対応モードHeadless, Interactive, Embedded

クイック操作

入力ファイル 1出力ファイル 1

結果処理ガイド → レシピ → 統合サンプル → Playground →

入力

この Tool が受け付ける入力形式とファイル数です。

入力種類	file
ファイル数	1 – 1
対応 MIME	image/jpeg, image/png, image/webp

パラメータ

これらの値は request.options で渡します。

パラメータ	型	必須	既定値	許可値 / 範囲	説明
`color`	string	任意	`#ffffff`	—	Solid background color as a 6-digit hex value.
`tolerance`	number	任意	`28`	0 – 100	Color tolerance from 0 to 100.
`edgeConnected`	boolean	任意	`true`	—	Remove matching pixels only when connected to an outer image edge.

出力

処理完了後に返される結果形式です。

型	files
ファイル数	1 – 1
出力 MIME	image/png
Metadata	width, height, inputBytes, outputBytes
ZIP アーカイブ	非対応

基本例

対応する統合モードを確認し、生成された開始コードをコピーできます。

Headless

const result = await client.run("remove-background-color", {
  file,
  options: { color: "#ffffff", tolerance: 28, edgeConnected: true }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "remove-background-color",
  input: { file },
  options: { color: "#ffffff", tolerance: 28, edgeConnected: true },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "remove-background-color", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.