dpi

類別

LogicalPosition

以邏輯像素表示的位置。

自從

2.0.0

建構函式

new LogicalPosition()

new LogicalPosition(x, y): LogicalPosition

參數

參數	類型
x	number
y	number

返回

LogicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L208

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

參數

參數	類型
物件	物件
object.Logical	物件
object.Logical.x	number
object.Logical.y	number

返回

LogicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L209

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

參數

參數	類型
物件	物件
object.x	number
object.y	number

返回

LogicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L210

屬性

屬性	修飾詞	類型	預設值	定義於
type	readonly	"Logical"	'Logical'	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L204
x	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L205
y	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L206

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

名稱	類型	定義於
x	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L252
y	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L253

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L250

toJSON()

toJSON(): object

返回

物件

名稱	類型	定義於
x	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L252
y	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L253

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L257

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

將邏輯位置轉換為物理位置。

參數

參數	類型
scaleFactor	number

返回

PhysicalPosition

範例

import { LogicalPosition } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const position = new LogicalPosition(400, 500);
const physical = position.toPhysical(factor);

自從

2.0.0

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L246

---

LogicalSize

以邏輯像素表示的大小。

自從

2.0.0

建構函式

new LogicalSize()

new LogicalSize(width, height): LogicalSize

參數

參數	類型
width	number
height	number

返回

LogicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L17

new LogicalSize()

new LogicalSize(object): LogicalSize

參數

參數	類型
物件	物件
object.Logical	物件
object.Logical.height	number
object.Logical.width	number

返回

LogicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L18

new LogicalSize()

new LogicalSize(object): LogicalSize

參數

參數	類型
物件	物件
object.height	number
object.width	number

返回

LogicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L19

屬性

屬性	修飾詞	類型	預設值	定義於
height	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L15
type	readonly	"Logical"	'Logical'	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L13
width	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L14

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

名稱	類型	定義於
height	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L62
width	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L61

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L59

toJSON()

toJSON(): object

返回

物件

名稱	類型	定義於
height	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L62
width	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L61

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L66

toPhysical()

toPhysical(scaleFactor): PhysicalSize

將邏輯大小轉換為物理大小。

參數

參數	類型
scaleFactor	number

返回

PhysicalSize

範例

import { LogicalSize } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const size = new LogicalSize(400, 500);
const physical = size.toPhysical(factor);

自從

2.0.0

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L55

---

PhysicalPosition

以物理像素表示的位置。

自從

2.0.0

建構函式

new PhysicalPosition()

new PhysicalPosition(x, y): PhysicalPosition

參數

參數	類型
x	number
y	number

返回

PhysicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L273

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

參數

參數	類型
物件	物件
object.Physical	物件
object.Physical.x	number
object.Physical.y	number

返回

PhysicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L274

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

參數

參數	類型
物件	物件
object.x	number
object.y	number

返回

PhysicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L275

屬性

屬性	修飾詞	類型	預設值	定義於
type	readonly	"Physical"	'Physical'	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L269
x	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L270
y	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L271

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

名稱	類型	定義於
x	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L317
y	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L318

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L315

toJSON()

toJSON(): object

返回

物件

名稱	類型	定義於
x	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L317
y	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L318

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L322

toLogical()

toLogical(scaleFactor): LogicalPosition

將物理位置轉換為邏輯位置。

參數

參數	類型
scaleFactor	number

返回

LogicalPosition

範例

import { PhysicalPosition } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const position = new PhysicalPosition(400, 500);
const physical = position.toLogical(factor);

自從

2.0.0

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L311

---

PhysicalSize

以物理像素表示的大小。

自從

2.0.0

建構函式

new PhysicalSize()

new PhysicalSize(width, height): PhysicalSize

參數

參數	類型
width	number
height	number

返回

PhysicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L82

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

參數

參數	類型
物件	物件
object.Physical	物件
object.Physical.height	number
object.Physical.width	number

返回

PhysicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L83

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

參數

參數	類型
物件	物件
object.height	number
object.width	number

返回

PhysicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L84

屬性

屬性	修飾詞	類型	預設值	定義於
height	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L80
type	readonly	"Physical"	'Physical'	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L78
width	public	number	undefined	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L79

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

名稱	類型	定義於
height	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L123
width	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L122

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L120

toJSON()

toJSON(): object

返回

物件

名稱	類型	定義於
height	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L123
width	number	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L122

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L127

toLogical()

toLogical(scaleFactor): LogicalSize

將物理大小轉換為邏輯大小。

參數

參數	類型
scaleFactor	number

返回

LogicalSize

範例

import { getCurrentWindow } from '@tauri-apps/api/window';
const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const size = await appWindow.innerSize(); // PhysicalSize
const logical = size.toLogical(factor);

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L116

---

Position

以物理或邏輯像素表示的位置。

此類型基本上是 LogicalSize 和 PhysicalSize 的聯合類型，但在 Rust 中使用 tauri::Position 作為指令的參數時非常方便，因為此類別會自動序列化為有效格式，以便正確反序列化為 tauri::Position

所以不用

import { invoke } from '@tauri-apps/api/core';
import { LogicalPosition, PhysicalPosition } from '@tauri-apps/api/dpi';

const position: LogicalPosition | PhysicalPosition = someFunction(); // where someFunction returns either LogicalPosition or PhysicalPosition
const validPosition = position instanceof LogicalPosition
  ? { Logical: { x: position.x, y: position.y } }
  : { Physical: { x: position.x, y: position.y } }
await invoke("do_something_with_position", { position: validPosition });

您可以直接使用 Position

import { invoke } from '@tauri-apps/api/core';
import { LogicalPosition, PhysicalPosition, Position } from '@tauri-apps/api/dpi';

const position: LogicalPosition | PhysicalPosition = someFunction(); // where someFunction returns either LogicalPosition or PhysicalPosition
const validPosition = new Position(position);
await invoke("do_something_with_position", { position: validPosition });

自從

2.1.0

建構函式

new Position()

new Position(position): Position

參數

參數	類型
position	LogicalPosition | PhysicalPosition

返回

Position

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L362

屬性

屬性	類型	定義於
position	LogicalPosition | PhysicalPosition	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L360

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L378

toJSON()

toJSON(): object

返回

物件

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L387

toLogical()

toLogical(scaleFactor): LogicalPosition

參數

參數	類型
scaleFactor	number

返回

LogicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L366

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

參數

參數	類型
scaleFactor	number

返回

PhysicalPosition

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L372

---

Size

以物理或邏輯像素表示的大小。

此類型基本上是 LogicalSize 和 PhysicalSize 的聯合類型，但在 Rust 中使用 tauri::Size 作為指令的參數時非常方便，因為此類別會自動序列化為有效格式，以便正確反序列化為 tauri::Size

所以不用

import { invoke } from '@tauri-apps/api/core';
import { LogicalSize, PhysicalSize } from '@tauri-apps/api/dpi';

const size: LogicalSize | PhysicalSize = someFunction(); // where someFunction returns either LogicalSize or PhysicalSize
const validSize = size instanceof LogicalSize
  ? { Logical: { width: size.width, height: size.height } }
  : { Physical: { width: size.width, height: size.height } }
await invoke("do_something_with_size", { size: validSize });

您可以直接使用 Size

import { invoke } from '@tauri-apps/api/core';
import { LogicalSize, PhysicalSize, Size } from '@tauri-apps/api/dpi';

const size: LogicalSize | PhysicalSize = someFunction(); // where someFunction returns either LogicalSize or PhysicalSize
const validSize = new Size(size);
await invoke("do_something_with_size", { size: validSize });

自從

2.1.0

建構函式

new Size()

new Size(size): Size

參數

參數	類型
size	LogicalSize | PhysicalSize

返回

Size

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L167

屬性

屬性	類型	定義於
size	LogicalSize | PhysicalSize	來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L165

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

物件

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L183

toJSON()

toJSON(): object

返回

物件

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L192

toLogical()

toLogical(scaleFactor): LogicalSize

參數

參數	類型
scaleFactor	number

返回

LogicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L171

toPhysical()

toPhysical(scaleFactor): PhysicalSize

參數

參數	類型
scaleFactor	number

返回

PhysicalSize

來源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L177