展示

图片预览器 AsamImageViewer

为一组图片提供独立预览、切换、缩放和关闭交互。

使用场景 ​

为一组图片提供独立预览、切换、缩放和关闭交互。

基础用法与状态 ​

下列示例只使用本入口的实际公开能力。

基础用法与状态

展开源码

独立实例、缩放输入与关闭策略 ​

下面的完整 TS/JS SFC 直接挂载 AsamImageViewer,展示全部公开实例、四个事件和四个插槽。前两张图片为本地 data URL,第三张故意加载失败,供观察 error 与 viewer-error。

打开前配置图片列表、缩放范围与关闭方式,打开后可通过实例控制。 完整说明。

ref<AsamImageViewerInstance>() 的公开 setActiveItem(index): void 用于手动切换。 完整说明。

scale 是父级输入,不是 v-model;2.14.7 没有 scale 或 update:scale 事件。 完整说明。

公开实例、缩放输入、关闭策略与完整插槽

展开源码

事件、插槽与职责拆分 ​

入口 独立 Viewer 示例中的用途
close / error / switch / rotate 记录无参数 close、原始 Event.type、图片索引和旋转角度,原生载荷不改写。
default 放置父级参数控制区与公开 ref 操作;Image 的内置预览不承接此插槽。
progress 使用 { activeIndex, total } 显示进度;关闭此插槽后可以独立观察 showProgress。
toolbar 使用 { actions, prev, next, reset, activeIndex, setActiveItem };reset 按原生切换原始尺寸/适应模式,不是公开 ref 方法。
viewer-error 使用 { activeIndex, src } 展示故意失败的第三张图片,并用 ref 返回第一张。

图片加载和占位能力由 Image 提供;ImageViewer 负责查看、缩放与关闭。 完整说明。

使用约定 ​

urlList 提供图片数组,initialIndex 设置起始图片,infinite 控制循环,zoomRate/minScale/maxScale 控制缩放范围。 完整说明。

缩放边界、键盘、切换和关闭遵循组件的公开行为。公开实例方法及其返回值以本页 API 为准。

局部与全局挂载 ​

局部模式将遮罩限制在演示区域;全局模式使用默认视口范围。 开关显示当前模式,两个模式均可操作;关闭后可以再次切换。

局部与全局挂载

展开源码

API

属性 AsamImageViewerProps

属性名说明类型默认值
urlList用于预览的图片链接列表string[] | undefined工厂函数(每个实例创建)
zIndex预览时遮罩层的 z-indexnumber | undefined—
initialIndex初始预览图像索引,小于 url-list 的长度number | undefined0
infinite是否可以无限循环预览boolean | undefinedtrue
hideOnClickModal是否可以通过点击遮罩层关闭预览boolean | undefinedfalse
teleportedimage 自身是否插入至 body 元素上。嵌套的父元素属性会发生修改时应该将此属性设置为 trueboolean | undefinedfalse
closeOnPressEscape是否可以通过按下 ESC 关闭 Image Viewerboolean | undefinedtrue
zoomRate图像查看器缩放事件的缩放速率。number | undefined1.2
scale预览图片缩放比例。number | undefined1
minScale图像查看器缩放事件的最小缩放比例number | undefined0.2
maxScale图像查看器缩放事件的最大缩放比例number | undefined7
showProgress显示预览进度内容。boolean | undefinedfalse
crossorigin设置原生 HTML crossorigin 属性。enum"" | "anonymous" | "use-credentials"完整类型:AsamImageViewerCrossorigin | undefined—
onClose—(() => any) | undefined—
onError—((evt: Event) => any) | undefined—
onRotate—((deg: number) => any) | undefined—
onSwitch—((index: number) => any) | undefined—
key—PropertyKey | undefined—
ref—VNodeRef | undefined—
ref_for—boolean | undefined—
ref_key—string | undefined—
onVnodeBeforeMount—(AsamImageViewerProps)["onVnodeBeforeMount"]—
onVnodeMounted—(AsamImageViewerProps)["onVnodeMounted"]—
onVnodeBeforeUpdate—(AsamImageViewerProps)["onVnodeBeforeUpdate"]—
onVnodeUpdated—(AsamImageViewerProps)["onVnodeUpdated"]—
onVnodeBeforeUnmount—(AsamImageViewerProps)["onVnodeBeforeUnmount"]—
onVnodeUnmounted—(AsamImageViewerProps)["onVnodeUnmounted"]—
class—unknown—
style—unknown—

实例方法与状态 AsamImageViewerExpose

属性名说明类型默认值
$—AsamImageViewerExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamImageViewerProps—
$attrs—AsamImageViewerExpose["$attrs"]—
$refs—AsamImageViewerExpose["$refs"]—
$slots—AsamImageViewerSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void)—
$el—any—
$options—(AsamImageViewerExpose)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamImageViewerExpose)["$nextTick"]—
$watch—(AsamImageViewerExpose)["$watch"]—
infinite—boolean—
scale—number—
initialIndex—number—
closeOnPressEscape—boolean—
zoomRate—number—
minScale—number—
maxScale—number—
urlList—string[]—
zIndex预览时遮罩层的 z-indexnumber | undefined—
teleportedimage 自身是否插入至 body 元素上。嵌套的父元素属性会发生修改时应该将此属性设置为 trueboolean | undefined—
onError—((evt: Event) => any) | undefined—
hideOnClickModal是否可以通过点击遮罩层关闭预览boolean | undefined—
showProgress显示预览进度内容。boolean | undefined—
crossorigin设置原生 HTML crossorigin 属性。enum"" | "anonymous" | "use-credentials"完整类型:AsamImageViewerCrossorigin | undefined—
onClose—(() => any) | undefined—
onSwitch—((index: number) => any) | undefined—
onRotate—((deg: number) => any) | undefined—
setActiveItem手动切换图片(index: number) => void—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamImageViewerExpose["$route"]—
$router应用使用的 Router 实例。AsamImageViewerExpose["$router"]—

类型 AsamImageViewerInstance

属性名说明类型默认值
$—AsamImageViewerExpose["$"]—
$data—AsamTableColumnExpose—
$props—AsamImageViewerProps—
$attrs—AsamImageViewerExpose["$attrs"]—
$refs—AsamImageViewerExpose["$refs"]—
$slots—AsamImageViewerSlots—
$root—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$parent—
查看完整类型ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null
—
$host—Element | null—
$emit—((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void)—
$el—any—
$options—(AsamImageViewerInstance)["$options"]—
$forceUpdate—() => void—
$nextTick—(AsamImageViewerInstance)["$nextTick"]—
$watch—(AsamImageViewerInstance)["$watch"]—
infinite—boolean—
scale—number—
initialIndex—number—
closeOnPressEscape—boolean—
zoomRate—number—
minScale—number—
maxScale—number—
urlList—string[]—
zIndex预览时遮罩层的 z-indexnumber | undefined—
teleportedimage 自身是否插入至 body 元素上。嵌套的父元素属性会发生修改时应该将此属性设置为 trueboolean | undefined—
onError—((evt: Event) => any) | undefined—
hideOnClickModal是否可以通过点击遮罩层关闭预览boolean | undefined—
showProgress显示预览进度内容。boolean | undefined—
crossorigin设置原生 HTML crossorigin 属性。enum"" | "anonymous" | "use-credentials"完整类型:AsamImageViewerCrossorigin | undefined—
onClose—(() => any) | undefined—
onSwitch—((index: number) => any) | undefined—
onRotate—((deg: number) => any) | undefined—
setActiveItem手动切换图片(index: number) => void—
$route当前规范化路由位置,详见 RouteLocationNormalizedLoaded。AsamImageViewerExpose["$route"]—
$router应用使用的 Router 实例。AsamImageViewerExpose["$router"]—

插槽 AsamImageViewerSlots

属性名说明类型默认值
progress—(AsamImageViewerSlots)["progress"]—
toolbar—(AsamImageViewerSlots)["toolbar"]—
viewer-error—(AsamImageViewerSlots)["viewer-error"]—
default—(AsamImageViewerSlots)["default"]—

类型 AsamImageViewerAction

类型 AsamImageViewerCrossorigin

事件 AsamImageViewerEmits

属性名说明类型默认值
close—() => boolean—
error—(evt: Event) => boolean—
switch—(index: number) => boolean—
rotate—(deg: number) => boolean—

类型 AsamImageViewerMode

属性名说明类型默认值
name—string—
icon—(AsamImageViewerMode)["icon"]—

类型 AsamImageViewerPropsPublic

属性名说明类型默认值
zIndex—number | undefined—
teleported—boolean | undefined—
initialIndex—number | undefined—
hideOnClickModal—boolean | undefined—
infinite—(AsamImageViewerPropsPublic)["infinite"]—
closeOnPressEscape—(AsamImageViewerPropsPublic)["closeOnPressEscape"]—
zoomRate—number | undefined—
scale—number | undefined—
minScale—number | undefined—
maxScale—number | undefined—
showProgress—boolean | undefined—
crossorigin—enum"" | "anonymous" | "use-credentials"完整类型:(AsamImageViewerPropsPublic)["crossorigin"]—
urlList—string[] | undefined—

用法与契约补充说明 ​

独立实例、缩放输入与关闭策略 ​

ref<AsamImageViewerInstance>() 的公开 setActiveItem(index): void 用于手动切换。示例中的“ref:第二张”调用真实 Viewer ref 并显示返回类型;它与 toolbar scope 的 setActiveItem 分别展示。原生上一张/下一张在 infinite=false 时保留首尾边界,infinite=true 时按原生规则循环。

独立实例、缩放输入与关闭策略 ​

scale 是父级输入,不是 v-model;2.14.7 没有 scale 或 update:scale 事件。改动输入值观察原生显示;初始/动态 scale 的限制及 toolbar 的缩放步长均由依赖处理,ASAM 不新增缩放算法。关闭事件由原生 close、Esc 或允许的遮罩点击触发,宿主在 close handler 中卸载;“父级卸载 Viewer”直接改变 v-if,不伪造 close 事件。

使用约定 ​

urlList 提供图片数组,initialIndex 设置起始图片,infinite 控制循环,zoomRate/minScale/maxScale 控制缩放范围。close/switch/rotate 等事件反馈交互;插槽名称及参数以公开 Slots 为准。宿主用 v-if 管理预览器存在状态并处理 close。teleported 决定挂载位置,zIndex 决定层级。本入口没有控件密度 size。

更多参数与事件说明 ​

独立实例、缩放输入与关闭策略 ​

打开前可设置 urlList、initialIndex、teleported、zIndex、infinite、zoomRate、scale、minScale、maxScale、closeOnPressEscape、hideOnClickModal、showProgress;本例还透传原生 crossorigin。打开后,default 插槽中的控制区可以动态修改 scale、关闭开关和循环策略。

事件、插槽与职责拆分 ​

图片本身的 load、lazy、placeholder、error 和 showPreview 属于 AsamImage;其 cap-image-preview、cap-custom-toolbar、cap-custom-progress、cap-load-failed 示例展示从图片打开预览的路径。本页 standalone 独立承接 Viewer 的 ref、scale、关闭策略以及 default/progress/toolbar/viewer-error,不能用 Image 的 toolbar slot 方法替代 Viewer ref 的证明。

参数与事件补充说明

公开绑定参数,包含具备类型的事件监听器;默认值由运行时定义提供。

参数与事件说明

urlList

必填:否;声明来源:上游声明。

默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)

固定上游文档默认:[](2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码工厂(未执行):() => mutable([] as const)(2.14.7;源码事实,未作为 ASAM 运行实测)

zIndex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

initialIndex

必填:否;声明来源:上游声明。

默认值与来源
0(已安装运行时;已安装组件)

固定上游文档默认:0(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)

infinite

必填:否;声明来源:上游声明。

infinite 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

hideOnClickModal

必填:否;声明来源:上游声明。

hideOnClickModal 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

teleported

必填:否;声明来源:上游声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

closeOnPressEscape

必填:否;声明来源:上游声明。

closeOnPressEscape 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

zoomRate

必填:否;声明来源:上游声明。

默认值与来源
1.2(已安装运行时;已安装组件)

固定上游文档默认:1.2(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:1.2(2.14.7;源码事实,未作为 ASAM 运行实测)

scale

必填:否;声明来源:上游声明。

默认值与来源
1(已安装运行时;已安装组件)

固定上游文档默认:1(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:1(2.14.7;源码事实,未作为 ASAM 运行实测)

minScale

必填:否;声明来源:上游声明。

默认值与来源
0.2(已安装运行时;已安装组件)

固定上游文档默认:0.2(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:0.2(2.14.7;源码事实,未作为 ASAM 运行实测)

maxScale

必填:否;声明来源:上游声明。

默认值与来源
7(已安装运行时;已安装组件)

固定上游文档默认:7(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:7(2.14.7;源码事实,未作为 ASAM 运行实测)

showProgress

必填:否;声明来源:上游声明。

showProgress 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

crossorigin

必填:否;声明来源:上游声明。

crossorigin 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "anonymous" / "use-credentials"

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onClose

必填:否;声明来源:上游声明。

onClose 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): any

onError

必填:否;声明来源:上游声明。

onError 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(evt: Event): any

onRotate

必填:否;声明来源:上游声明。

onRotate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(deg: number): any

onSwitch

必填:否;声明来源:上游声明。

onSwitch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): any

key

必填:否;声明来源:依赖声明。

ref

必填:否;声明来源:依赖声明。

ref 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(ref: Element | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null, refs: Record<string, any>): void

  • ref.value: any — 依赖声明
  • ref.__@RefSymbol@8854: true — 依赖声明

    仅用于区分类型:保留在公开声明中,通过私有 Symbol 避免出现在编辑器自动补全中。

    枚举:true

ref_for

必填:否;声明来源:依赖声明。

ref_for 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

ref_key

必填:否;声明来源:依赖声明。

onVnodeBeforeMount

必填:否;声明来源:依赖声明。

onVnodeBeforeMount 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeMounted

必填:否;声明来源:依赖声明。

onVnodeMounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUpdate

必填:否;声明来源:依赖声明。

onVnodeBeforeUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUpdated

必填:否;声明来源:依赖声明。

onVnodeUpdated 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>, oldVNode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeBeforeUnmount

必填:否;声明来源:依赖声明。

onVnodeBeforeUnmount 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

onVnodeUnmounted

必填:否;声明来源:依赖声明。

onVnodeUnmounted 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(vnode: VNode<RendererNode, RendererElement, { [key: string]: any; }>): void

class

必填:否;声明来源:依赖声明。

style

必填:否;声明来源:依赖声明。

AsamImageViewerProps 公开类型视图
ts
import type { VNodeRef, ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, VNode, RendererNode, RendererElement } from 'vue';
import type { AsamImageViewerProps, AsamImageViewerCrossorigin, AsamImageViewerExpose } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamImageViewerProps
type PublicContract = {
	readonly "urlList"?: string[] | undefined;
	readonly "zIndex"?: number | undefined;
	readonly "initialIndex"?: number | undefined;
	readonly "infinite"?: boolean | undefined;
	readonly "hideOnClickModal"?: boolean | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "closeOnPressEscape"?: boolean | undefined;
	readonly "zoomRate"?: number | undefined;
	readonly "scale"?: number | undefined;
	readonly "minScale"?: number | undefined;
	readonly "maxScale"?: number | undefined;
	readonly "showProgress"?: boolean | undefined;
	readonly "crossorigin"?: AsamImageViewerCrossorigin | undefined;
	readonly "onClose"?: (() => any) | undefined;
	readonly "onError"?: ((evt: Event) => any) | undefined;
	readonly "onRotate"?: ((deg: number) => any) | undefined;
	readonly "onSwitch"?: ((index: number) => any) | undefined;
	"key"?: PropertyKey | undefined;
	"ref"?: VNodeRef | undefined;
	"ref_for"?: boolean | undefined;
	"ref_key"?: string | undefined;
	"onVnodeBeforeMount"?: (AsamImageViewerProps)["onVnodeBeforeMount"];
	"onVnodeMounted"?: (AsamImageViewerProps)["onVnodeMounted"];
	"onVnodeBeforeUpdate"?: (AsamImageViewerProps)["onVnodeBeforeUpdate"];
	"onVnodeUpdated"?: (AsamImageViewerProps)["onVnodeUpdated"];
	"onVnodeBeforeUnmount"?: (AsamImageViewerProps)["onVnodeBeforeUnmount"];
	"onVnodeUnmounted"?: (AsamImageViewerProps)["onVnodeUnmounted"];
	"class"?: unknown;
	"style"?: unknown;
};

完整的上游实例,包含全部公开方法与响应式状态。

参数与事件说明

$

必填:是;声明来源:依赖声明。

$ 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$data

必填:是;声明来源:依赖声明。

$props

必填:是;声明来源:依赖声明。

$attrs

必填:是;声明来源:依赖声明。

$attrs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$refs

必填:是;声明来源:依赖声明。

$refs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$slots

必填:是;声明来源:依赖声明。

$root

必填:是;声明来源:依赖声明。

$parent

必填:是;声明来源:依赖声明。

$host

必填:是;声明来源:依赖声明。

$host 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

$emit

必填:是;声明来源:依赖声明。

$emit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: "error", ...args: [evt: globalThis.Event]): void

事件参数完整签名见公开类型视图:((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void)。

事件参数:(event: "switch", ...args: [index: number]): void

事件参数:(event: "rotate", ...args: [deg: number]): void

$el

必填:是;声明来源:依赖声明。

$options

必填:是;声明来源:依赖声明。

$forceUpdate

必填:是;声明来源:依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$nextTick

必填:是;声明来源:依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): Promise<void>

事件参数:<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$watch

必填:是;声明来源:依赖声明。

$watch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamImageViewerExpose)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

infinite

必填:是;声明来源:上游声明。

infinite 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

scale

必填:是;声明来源:上游声明。

initialIndex

必填:是;声明来源:上游声明。

closeOnPressEscape

必填:是;声明来源:上游声明。

closeOnPressEscape 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

zoomRate

必填:是;声明来源:上游声明。

minScale

必填:是;声明来源:上游声明。

maxScale

必填:是;声明来源:上游声明。

urlList

必填:是;声明来源:上游声明。

urlList 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

zIndex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

teleported

必填:否;声明来源:上游声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

onError

必填:否;声明来源:上游声明。

onError 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(evt: Event): any

hideOnClickModal

必填:否;声明来源:上游声明。

hideOnClickModal 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

showProgress

必填:否;声明来源:上游声明。

showProgress 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

crossorigin

必填:否;声明来源:上游声明。

crossorigin 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "anonymous" / "use-credentials"

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onClose

必填:否;声明来源:上游声明。

onClose 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): any

onSwitch

必填:否;声明来源:上游声明。

onSwitch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): any

onRotate

必填:否;声明来源:上游声明。

onRotate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(deg: number): any

setActiveItem

必填:是;声明来源:上游声明。

setActiveItem 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): void

$route

必填:是;声明来源:依赖声明。

$route 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamImageViewerExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamImageViewerExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串,使用百分号编码。

  • $route.query: (NonNullable<AsamImageViewerExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段;存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前,最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串,使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段;存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前,最初尝试访问的位置。

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录,而不是添加新记录。

      枚举:false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同,也触发导航;除非传入 replace: true,否则会添加一条历史记录。

      枚举:false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamImageViewerExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamImageViewerExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填:是;声明来源:依赖声明。

$router 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamImageViewerExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory,并配置服务器回退;createWebHashHistory 无需服务器配置,但搜索引擎无法处理其哈希路由,影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径;例如 base 为 /sub-folder 时,可将单页应用部署在域名的对应子目录。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数:(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数:(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.createHref: (location: AsamImageViewerMode["name"]) => string — 依赖声明

        生成用于链接元素的对应 href。

        事件参数:(location: string): string

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。

      事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamImageViewerExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数:(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。

      事件参数:(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名;未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名;未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $,使其匹配到路径结尾。

      声明默认:`true`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

  • $router.addRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数:(): void

  • $router.currentRoute: ShallowRef<AsamImageViewerExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听,这是用于微前端的底层 API。

    枚举:false / true

  • $router.hasRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamImageViewerExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamImageViewerExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamImageViewerExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamImageViewerExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退,等价于 router.go(-1)。

    事件参数:(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进,等价于 router.go(1)。

    事件参数:(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数:(delta: number): void

  • $router.beforeEach: (NonNullable<AsamImageViewerExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫,并返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamImageViewerExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamImageViewerExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子,并返回移除此钩子的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamImageViewerExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。

    事件参数:(handler: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise,此时关联的异步进入钩子与异步组件均已解析;导航已完成时立即兑现。可用于保持服务端与客户端渲染一致;服务端需手动推入初始位置,客户端从 URL 自动读取。

    事件参数:(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用,用户不应手动调用;客户端调用时会触发初次导航。

    事件参数:(app: App<any>): void

AsamImageViewerExpose 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamImageViewerExpose, AsamTableColumnExpose, AsamImageViewerProps, AsamImageViewerSlots, AsamImageViewerCrossorigin, AsamImageViewerMode } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamImageViewerExpose
type PublicContract = {
	"$": AsamImageViewerExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamImageViewerProps;
	"$attrs": AsamImageViewerExpose["$attrs"];
	"$refs": AsamImageViewerExpose["$refs"];
	"$slots": AsamImageViewerSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": ((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void);
	"$el": any;
	"$options": (AsamImageViewerExpose)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamImageViewerExpose)["$nextTick"];
	"$watch": (AsamImageViewerExpose)["$watch"];
	readonly "infinite": boolean;
	readonly "scale": number;
	readonly "initialIndex": number;
	readonly "closeOnPressEscape": boolean;
	readonly "zoomRate": number;
	readonly "minScale": number;
	readonly "maxScale": number;
	readonly "urlList": string[];
	readonly "zIndex"?: number | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "onError"?: ((evt: Event) => any) | undefined;
	readonly "hideOnClickModal"?: boolean | undefined;
	readonly "showProgress"?: boolean | undefined;
	readonly "crossorigin"?: AsamImageViewerCrossorigin | undefined;
	readonly "onClose"?: (() => any) | undefined;
	readonly "onSwitch"?: ((index: number) => any) | undefined;
	readonly "onRotate"?: ((deg: number) => any) | undefined;
	"setActiveItem": (index: number) => void;
	"$route": AsamImageViewerExpose["$route"];
	"$router": AsamImageViewerExpose["$router"];
};

参数与事件说明

$

必填:是;声明来源:依赖声明。

$ 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$data

必填:是;声明来源:依赖声明。

$props

必填:是;声明来源:依赖声明。

$attrs

必填:是;声明来源:依赖声明。

$attrs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$refs

必填:是;声明来源:依赖声明。

$refs 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$slots

必填:是;声明来源:依赖声明。

$root

必填:是;声明来源:依赖声明。

$parent

必填:是;声明来源:依赖声明。

$host

必填:是;声明来源:依赖声明。

$host 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

$emit

必填:是;声明来源:依赖声明。

$emit 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(event: "error", ...args: [evt: globalThis.Event]): void

事件参数完整签名见公开类型视图:((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void)。

事件参数:(event: "switch", ...args: [index: number]): void

事件参数:(event: "rotate", ...args: [deg: number]): void

$el

必填:是;声明来源:依赖声明。

$options

必填:是;声明来源:依赖声明。

$forceUpdate

必填:是;声明来源:依赖声明。

$forceUpdate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$nextTick

必填:是;声明来源:依赖声明。

$nextTick 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): Promise<void>

事件参数:<T, R>(this: T, fn: (this: T) => R | Promise<R>): Promise<R>

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

$watch

必填:是;声明来源:依赖声明。

$watch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:<T extends string | ((...args: any) => any)>(source: T, cb: Parameters<Extract<NonNullable<(AsamImageViewerInstance)["$watch"]>, (...args: never[]) => unknown>>[1], options?: WatchOptions<boolean> | undefined): WatchStopHandle

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

infinite

必填:是;声明来源:上游声明。

infinite 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

scale

必填:是;声明来源:上游声明。

initialIndex

必填:是;声明来源:上游声明。

closeOnPressEscape

必填:是;声明来源:上游声明。

closeOnPressEscape 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

zoomRate

必填:是;声明来源:上游声明。

minScale

必填:是;声明来源:上游声明。

maxScale

必填:是;声明来源:上游声明。

urlList

必填:是;声明来源:上游声明。

urlList 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

zIndex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

teleported

必填:否;声明来源:上游声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

onError

必填:否;声明来源:上游声明。

onError 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(evt: Event): any

hideOnClickModal

必填:否;声明来源:上游声明。

hideOnClickModal 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

showProgress

必填:否;声明来源:上游声明。

showProgress 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

crossorigin

必填:否;声明来源:上游声明。

crossorigin 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "anonymous" / "use-credentials"

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

onClose

必填:否;声明来源:上游声明。

onClose 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): any

onSwitch

必填:否;声明来源:上游声明。

onSwitch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): any

onRotate

必填:否;声明来源:上游声明。

onRotate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(deg: number): any

setActiveItem

必填:是;声明来源:上游声明。

setActiveItem 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): void

$route

必填:是;声明来源:依赖声明。

$route 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $route.matched: (NonNullable<AsamImageViewerExpose["$route"]>)["matched"] — 依赖声明

    仅包含普通组件的 RouteLocationMatched 数组;懒加载组件已解析并替换 components 中的值,可直接展示路由,不包含重定向记录。此属性不可枚举。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $route.name: (NonNullable<AsamImageViewerExpose["$route"]>)["name"] — 依赖声明

    匹配路由记录的名称。

  • $route.fullPath: string — 依赖声明

    包含 search 和 hash 的完整位置字符串,使用百分号编码。

  • $route.query: (NonNullable<AsamImageViewerExpose["$route"]>)["query"] — 依赖声明

    当前位置 search 属性的对象表示。

  • $route.hash: string — 依赖声明

    当前位置的哈希片段;存在时以 # 开头。

  • $route.redirectedFrom: (NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"] — 依赖声明

    最终到达当前位置之前,最初尝试访问的位置。

    • $route.redirectedFrom.matched: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "matched"> — 依赖声明

      包含添加路由时原始组件的 RouteRecord 数组,也可能包含重定向记录,不能直接用于展示。此属性不可枚举。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $route.redirectedFrom.fullPath: string — 依赖声明

      包含 search 和 hash 的完整位置字符串,使用百分号编码。

    • $route.redirectedFrom.query: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "query"> — 依赖声明

      当前位置 search 属性的对象表示。

    • $route.redirectedFrom.hash: string — 依赖声明

      当前位置的哈希片段;存在时以 # 开头。

    • $route.redirectedFrom.redirectedFrom: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "redirectedFrom"> — 依赖声明

      最终到达当前位置之前,最初尝试访问的位置。

      嵌套展开边界:递归引用;完整类型见公开类型视图。

    • $route.redirectedFrom.name: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "name"> — 依赖声明

      匹配路由记录的名称。

    • $route.redirectedFrom.meta: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "meta"> — 依赖声明

      全部匹配路由记录合并后的 meta 属性。

    • $route.redirectedFrom.params: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "params"> — 依赖声明

      从 path 提取并解码后的参数对象。

    • $route.redirectedFrom.path: string — 依赖声明

      URL 中经过百分号编码的路径部分。

    • $route.redirectedFrom.replace: boolean | undefined — 依赖声明

      替换当前历史记录,而不是添加新记录。

      枚举:false / true

    • $route.redirectedFrom.force: boolean | undefined — 依赖声明

      即使目标与当前位置相同,也触发导航;除非传入 replace: true,否则会添加一条历史记录。

      枚举:false / true

    • $route.redirectedFrom.state: PublicMember<NonNullable<(NonNullable<AsamImageViewerExpose["$route"]>)["redirectedFrom"]>, "state"> — 依赖声明

      通过 History API 保存的状态;不能包含响应式值,也不允许 Symbol 等部分值。详情参见 https://developer.mozilla.org/zh-CN/docs/Web/API/History/state。

  • $route.meta: (NonNullable<AsamImageViewerExpose["$route"]>)["meta"] — 依赖声明

    全部匹配路由记录合并后的 meta 属性。

  • $route.params: (NonNullable<AsamImageViewerExpose["$route"]>)["params"] — 依赖声明

    从 path 提取并解码后的参数对象。

  • $route.path: string — 依赖声明

    URL 中经过百分号编码的路径部分。

$router

必填:是;声明来源:依赖声明。

$router 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • $router.options: (NonNullable<AsamImageViewerExpose["$router"]>)["options"] — 依赖声明

    创建路由器时传入的原始配置对象。

    • $router.options.routes: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["routes"] — 依赖声明

      需要添加到路由器的初始路由列表。

      嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

    • $router.options.history: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"] — 依赖声明

      路由器使用的历史记录实现。通常使用 createWebHistory,并配置服务器回退;createWebHashHistory 无需服务器配置,但搜索引擎无法处理其哈希路由,影响搜索优化。

      • $router.options.history.base: string — 依赖声明

        添加到每个 URL 前的基础路径;例如 base 为 /sub-folder 时,可将单页应用部署在域名的对应子目录。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.location: string — 依赖声明

        当前历史记录位置。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.state: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["state"] — 依赖声明

        当前历史记录状态。

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.push: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["push"] — 依赖声明

        导航到指定位置;使用 HTML5 History 时,通过 history.pushState 实际更新 URL。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["push"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.replace: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["replace"] — 依赖声明

        与 RouterHistory.push 类似,但调用 history.replaceState,而非 history.pushState。

        事件参数:(to: string, data?: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["replace"]>, (...args: never[]) => unknown>>[1]): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.go: (delta: number, triggerListeners?: boolean) => void — 依赖声明

        按指定方向遍历历史记录。

        事件参数:(delta: number, triggerListeners?: boolean | undefined): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.listen: (NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["listen"] — 依赖声明

        为历史记录实现添加监听器;由浏览器前进、后退等外部导航,或传入 true 的 RouterHistory.back、RouterHistory.forward 触发。

        事件参数:(callback: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["history"]>)["listen"]>, (...args: never[]) => unknown>>[0]): () => void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.createHref: (location: AsamImageViewerMode["name"]) => string — 依赖声明

        生成用于链接元素的对应 href。

        事件参数:(location: string): string

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • $router.options.history.destroy: () => void — 依赖声明

        清除历史记录实现注册的全部事件监听器。

        事件参数:(): void

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • $router.options.scrollBehavior: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"] — 依赖声明

      控制页面导航时滚动行为的函数;可返回 Promise 延迟滚动。

      事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[0], from: AsamImageViewerExpose["$route"], savedPosition: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>[2]): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["scrollBehavior"]>, (...args: never[]) => unknown>>

    • $router.options.parseQuery: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["parseQuery"] — 依赖声明

      自定义查询参数解析函数;与 EXPERIMENTAL_RouterOptions_Base.stringifyQuery 配套。

      事件参数:(search: string): ReturnType<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["parseQuery"]>, (...args: never[]) => unknown>>

    • $router.options.stringifyQuery: (NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["stringifyQuery"] — 依赖声明

      自定义查询对象序列化函数;不要添加开头的 ?,与 parseQuery 的解析函数配套。

      事件参数:(query: Parameters<Extract<NonNullable<(NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["options"]>)["stringifyQuery"]>, (...args: never[]) => unknown>>[0]): string

    • $router.options.linkActiveClass: string | undefined — 依赖声明

      应用于激活 RouterLink 的默认类名;未指定时使用 router-link-active。

    • $router.options.linkExactActiveClass: string | undefined — 依赖声明

      应用于精确激活 RouterLink 的默认类名;未指定时使用 router-link-exact-active。

    • $router.options.end: boolean | undefined — 依赖声明

      是否在表达式末尾添加 $,使其匹配到路径结尾。

      声明默认:`true`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.sensitive: boolean | undefined — 依赖声明

      使正则表达式区分大小写。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

    • $router.options.strict: boolean | undefined — 依赖声明

      是否禁止路径末尾的斜杠。

      声明默认:`false`(注释,实际运行默认以源码/安装包为准)

      枚举:false / true

  • $router.addRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["addRoute"] — 依赖声明

    向已有路由添加子路由,或向路由器添加新的 RouteRecordRaw 路由记录。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.removeRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["removeRoute"] — 依赖声明

    按名称移除已有路由。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["removeRoute"]>, (...args: never[]) => unknown>>[0]): void

  • $router.clearRoutes: () => void — 依赖声明

    从路由器中删除全部路由。

    事件参数:(): void

  • $router.currentRoute: ShallowRef<AsamImageViewerExpose["$route"]> — 依赖声明

    当前 RouteLocationNormalized。

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • $router.listening: boolean — 依赖声明

    允许关闭历史事件监听,这是用于微前端的底层 API。

    枚举:false / true

  • $router.hasRoute: (NonNullable<AsamImageViewerExpose["$router"]>)["hasRoute"] — 依赖声明

    检查指定名称的路由是否存在。

    事件参数:(name: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["hasRoute"]>, (...args: never[]) => unknown>>[0]): boolean

  • $router.getRoutes: (NonNullable<AsamImageViewerExpose["$router"]>)["getRoutes"] — 依赖声明

    获取全部 RouteRecord 路由记录的完整列表。

    事件参数:(): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["getRoutes"]>, (...args: never[]) => unknown>>

  • $router.resolve: (NonNullable<AsamImageViewerExpose["$router"]>)["resolve"] — 依赖声明

    返回 RouteLocationRaw 的规范化位置,包含带基础路径的 href;默认使用 router.currentRoute 作为 currentLocation,仅在高级场景中覆盖。

    事件参数完整签名见公开类型视图。

    事件参数完整签名见公开类型视图。

  • $router.push: (NonNullable<AsamImageViewerExpose["$router"]>)["push"] — 依赖声明

    通过向历史栈添加记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["push"]>, (...args: never[]) => unknown>>

  • $router.replace: (NonNullable<AsamImageViewerExpose["$router"]>)["replace"] — 依赖声明

    通过替换历史栈中的当前记录,以编程方式导航到新 URL。

    事件参数:(to: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>[0]): ReturnType<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["replace"]>, (...args: never[]) => unknown>>

  • $router.back: () => void — 依赖声明

    通过 history.back() 在可用时后退,等价于 router.go(-1)。

    事件参数:(): void

  • $router.forward: () => void — 依赖声明

    通过 history.forward() 在可用时前进,等价于 router.go(1)。

    事件参数:(): void

  • $router.go: (delta: number) => void — 依赖声明

    通过调用 history.go() 在历史记录中前进或后退。

    事件参数:(delta: number): void

  • $router.beforeEach: (NonNullable<AsamImageViewerExpose["$router"]>)["beforeEach"] — 依赖声明

    添加每次导航之前执行的守卫,并返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["beforeEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.beforeResolve: (NonNullable<AsamImageViewerExpose["$router"]>)["beforeResolve"] — 依赖声明

    添加导航确认之前执行的守卫,此时组件已获取且其他导航守卫已通过;返回移除此守卫的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["beforeResolve"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.afterEach: (NonNullable<AsamImageViewerExpose["$router"]>)["afterEach"] — 依赖声明

    添加每次导航结束后执行的钩子,并返回移除此钩子的函数。

    事件参数:(guard: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["afterEach"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.onError: (NonNullable<AsamImageViewerExpose["$router"]>)["onError"] — 依赖声明

    添加导航期间未捕获错误的处理函数,涵盖同步和异步异常、守卫返回或传给 next 的错误,以及路由异步组件解析错误。

    事件参数:(handler: Parameters<Extract<NonNullable<(NonNullable<AsamImageViewerExpose["$router"]>)["onError"]>, (...args: never[]) => unknown>>[0]): () => void

  • $router.isReady: () => Promise<void> — 依赖声明

    返回在初次导航完成后兑现的 Promise,此时关联的异步进入钩子与异步组件均已解析;导航已完成时立即兑现。可用于保持服务端与客户端渲染一致;服务端需手动推入初始位置,客户端从 URL 自动读取。

    事件参数:(): Promise<void>

  • $router.install: (app: App) => void — 依赖声明

    由 app.use(router) 自动调用,用户不应手动调用;客户端调用时会触发初次导航。

    事件参数:(app: App<any>): void

AsamImageViewerInstance 公开类型视图
ts
import type { ComponentPublicInstance, ComponentOptionsBase, ComponentProvideOptions, ComponentOptionsMixin, GlobalComponents, GlobalDirectives, WatchOptions, WatchStopHandle, ShallowRef, App } from 'vue';
import type { AsamImageViewerInstance, AsamImageViewerExpose, AsamTableColumnExpose, AsamImageViewerProps, AsamImageViewerSlots, AsamImageViewerCrossorigin, AsamImageViewerMode } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamImageViewerInstance
type PublicContract = {
	"$": AsamImageViewerExpose["$"];
	"$data": AsamTableColumnExpose;
	"$props": AsamImageViewerProps;
	"$attrs": AsamImageViewerExpose["$attrs"];
	"$refs": AsamImageViewerExpose["$refs"];
	"$slots": AsamImageViewerSlots;
	"$root": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$parent": ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions>, {}, {}, "", {}, any> | null;
	"$host": Element | null;
	"$emit": ((event: "error", evt: Event) => void) & ((event: "close") => void) & ((event: "switch", index: number) => void) & ((event: "rotate", deg: number) => void);
	"$el": any;
	"$options": (AsamImageViewerInstance)["$options"];
	"$forceUpdate": () => void;
	"$nextTick": (AsamImageViewerInstance)["$nextTick"];
	"$watch": (AsamImageViewerInstance)["$watch"];
	readonly "infinite": boolean;
	readonly "scale": number;
	readonly "initialIndex": number;
	readonly "closeOnPressEscape": boolean;
	readonly "zoomRate": number;
	readonly "minScale": number;
	readonly "maxScale": number;
	readonly "urlList": string[];
	readonly "zIndex"?: number | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "onError"?: ((evt: Event) => any) | undefined;
	readonly "hideOnClickModal"?: boolean | undefined;
	readonly "showProgress"?: boolean | undefined;
	readonly "crossorigin"?: AsamImageViewerCrossorigin | undefined;
	readonly "onClose"?: (() => any) | undefined;
	readonly "onSwitch"?: ((index: number) => any) | undefined;
	readonly "onRotate"?: ((deg: number) => any) | undefined;
	"setActiveItem": (index: number) => void;
	"$route": AsamImageViewerExpose["$route"];
	"$router": AsamImageViewerExpose["$router"];
};

作用域插槽保留上游实例契约。

参数与事件说明

progress

必填:否;声明来源:上游声明。

progress 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: { activeIndex: number; /** Scoped slots retain the upstream instance contract. */ total: number; }): any

toolbar

必填:否;声明来源:上游声明。

toolbar 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: Parameters<Extract<NonNullable<(AsamImageViewerSlots)["toolbar"]>, (...args: never[]) => unknown>>[0]): any

viewer-error

必填:否;声明来源:上游声明。

viewer-error 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: { activeIndex: number; src: string; }): any

default

必填:否;声明来源:上游声明。

default 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: AsamTableColumnExpose): any

AsamImageViewerSlots 公开类型视图
ts
import type { AsamImageViewerSlots, AsamImageViewerExpose, AsamTableColumnExpose } from '@asam-ui/ui';

// AsamImageViewerSlots
type PublicContract = {
	"progress"?: (AsamImageViewerSlots)["progress"];
	"toolbar"?: (AsamImageViewerSlots)["toolbar"];
	"viewer-error"?: (AsamImageViewerSlots)["viewer-error"];
	"default"?: (AsamImageViewerSlots)["default"];
	readonly [key: string]: import("vue").Slot<any> | undefined;
};

组合契约按分支生效;请同时查看公开类型。

AsamImageViewerAction 公开类型视图
ts
import type { AsamImageViewerAction } from '@asam-ui/ui';

// AsamImageViewerAction
type PublicContract = AsamImageViewerAction;

组合契约按分支生效;请同时查看公开类型。

AsamImageViewerCrossorigin 公开类型视图
ts
import type { AsamImageViewerCrossorigin } from '@asam-ui/ui';

// AsamImageViewerCrossorigin
type PublicContract = AsamImageViewerCrossorigin;

参数与事件说明

close

必填:是;声明来源:上游声明。

close 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): boolean

error

必填:是;声明来源:上游声明。

error 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(evt: Event): boolean

switch

必填:是;声明来源:上游声明。

switch 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(index: number): boolean

rotate

必填:是;声明来源:上游声明。

rotate 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(deg: number): boolean

AsamImageViewerEmits 公开类型视图
ts
import type { AsamImageViewerEmits, AsamImageViewerExpose } from '@asam-ui/ui';

// AsamImageViewerEmits
type PublicContract = {
	"close": () => boolean;
	"error": (evt: Event) => boolean;
	"switch": (index: number) => boolean;
	"rotate": (deg: number) => boolean;
};

参数与事件说明

name

必填:是;声明来源:上游声明。

icon

必填:是;声明来源:上游声明。

icon 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<(AsamImageViewerMode)["icon"]>, (...args: never[]) => unknown>>[1]): any

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

AsamImageViewerMode 公开类型视图
ts
import type { AsamImageViewerMode, AsamImageViewerExpose } from '@asam-ui/ui';

// AsamImageViewerMode
type PublicContract = {
	"name": string;
	"icon": (AsamImageViewerMode)["icon"];
};

参数与事件说明

zIndex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

teleported

必填:否;声明来源:上游声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

initialIndex

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:0(2.14.7;源码事实,未作为 ASAM 运行实测)

hideOnClickModal

必填:否;声明来源:上游声明。

hideOnClickModal 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

infinite

必填:否;声明来源:上游声明。

infinite 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

closeOnPressEscape

必填:否;声明来源:上游声明。

closeOnPressEscape 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

zoomRate

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:1.2(2.14.7;源码事实,未作为 ASAM 运行实测)

scale

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:1(2.14.7;源码事实,未作为 ASAM 运行实测)

minScale

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:0.2(2.14.7;源码事实,未作为 ASAM 运行实测)

maxScale

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:7(2.14.7;源码事实,未作为 ASAM 运行实测)

showProgress

必填:否;声明来源:上游声明。

showProgress 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

crossorigin

必填:否;声明来源:上游声明。

crossorigin 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "anonymous" / "use-credentials"

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

urlList

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码工厂(未执行):() => mutable([] as const)(2.14.7;源码事实,未作为 ASAM 运行实测)

AsamImageViewerPropsPublic 公开类型视图
ts
import type { AsamImageViewerPropsPublic, AsamImageViewerProps, AsamImageViewerCrossorigin } from '@asam-ui/ui';

// AsamImageViewerPropsPublic
type PublicContract = {
	readonly "zIndex"?: number | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "initialIndex"?: number | undefined;
	readonly "hideOnClickModal"?: boolean | undefined;
	readonly "infinite"?: (AsamImageViewerPropsPublic)["infinite"];
	readonly "closeOnPressEscape"?: (AsamImageViewerPropsPublic)["closeOnPressEscape"];
	readonly "zoomRate"?: number | undefined;
	readonly "scale"?: number | undefined;
	readonly "minScale"?: number | undefined;
	readonly "maxScale"?: number | undefined;
	readonly "showProgress"?: boolean | undefined;
	readonly "crossorigin"?: (AsamImageViewerPropsPublic)["crossorigin"];
	readonly "urlList"?: string[] | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭