文档Dynamic Media查看器参考指南

弹出 flyout

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员
  • 用户

弹出查看器是图像查看器。 它会显示一个静态图像，该图像带有用户激活的弹出视图中显示的缩放版本。 此查看器适用于图像集，并且使用样本完成导航。 它设计为可在台式机和移动设备上工作。

NOTE
此查看器不支持使用IR（图像渲染）或UGC（用户生成的内容）的图像。

查看器类型为504。

请参阅系统要求和先决条件。

演示URL section-e1c3106f5b3e445d9b95be337c2f94e2

https://s7d9.scene7.com/s7viewers/html5/FlyoutViewer.html?asset=Scene7SharedAssets/ImageSet-Views-Sample

使用弹出查看器 section-f21ac23d3f6449ad9765588d69584772

弹出查看器表示一个主JavaScript文件和一组帮助程序文件(单个JavaScript包含此特定查看器使用的所有Viewer SDK组件、资源、CSS)，这些文件由查看器在运行时下载

弹出查看器仅用于嵌入用途，这意味着它使用文档记录的API集成到网页中。 没有可用于弹出查看器的生产就绪网页。

其配置和外观设计与其他查看器的配置和外观设计类似。 您可以使用自定义CSS来应用外观设置。

查看所有查看者通用的命令引用 — 配置属性和所有查看者通用的命令引用 — URL

与弹出查看器交互 section-ab66eb6955aa4a8aa6d14a3b3acfed3f

弹出查看器支持在其他移动设备应用程序中常见的单点触控和多点触控手势。

手势
说明
单点按
激活弹出视图或在主缩放级别和次缩放级别之间进行更改。
水平轻扫或轻扫
在样本栏中滚动样本列表。
垂直轻扫
如果该手势在样本区域内完成，则会执行本机页面滚动。

该查看器还支持在带有触摸屏和鼠标的Windows设备上输入触摸和鼠标。 但是，此支持仅适用于Chrome、Internet Explorer 11和Edge Web浏览器。

此查看器可使用键盘完全访问。

请参阅键盘辅助功能和导航。

嵌入弹出查看器 section-6bb5d3c502544ad18a58eafe12a13435

不同的网页对查看者的行为具有不同的需求。 该网页可能具有静态页面布局，或者使用在不同设备上显示不同或者用于不同浏览器窗口大小的响应式设计。 为了满足这些需求，查看器支持两种主要操作模式：固定大小嵌入和响应式设计嵌入。

当查看器在初始加载后未更改其大小时，使用固定大小嵌入模式。 此选项最适合具有静态页面布局的网页。

响应式设计嵌入模式假定查看器必须在运行时调整大小以响应其容器DIV的大小更改。 最常见的用例是将查看器添加到使用灵活页面布局的网页。

在弹出查看器中使用响应式设计嵌入模式时，请确保使用imagereload参数为主视图图像指定显式断点。 理想情况下，将断点与网页CSS指令的查看器宽度断点相匹配。

在响应式设计嵌入模式下，查看器的行为方式有所不同，具体取决于网页容器DIV的大小方式。 如果网页仅设置容器DIV的宽度，而不限制其高度，则查看器会根据所用资源的长宽比自动选择其高度。 这项功能意味着资产可以完美地融入视图中，而不会有任何边距。 此特定用例最常见于使用响应式设计布局框架(如Bootstrap和Foundation)的网页。

否则，如果网页同时设置了查看器容器DIV的宽度和高度，则查看器将仅填充该区域，并遵循网页布局提供的大小。 一个良好的用例示例是将查看器嵌入到模式叠加中，其中叠加根据Web浏览器窗口大小调整大小。

固定大小嵌入

通过执行以下操作将查看器添加到网页：

  1. 正在将查看器JavaScript文件添加到您的网页。

  2. 正在定义容器DIV。

  3. 设置查看器大小。

  4. 创建和初始化查看器。

  5. 正在将查看器JavaScript文件添加到您的网页。

    创建查看器需要您在HTML头中添加脚本标记。 在使用查看器API之前，请确保包括FlyoutViewer.js。 FlyoutViewer.js在标准IS-Viewers部署的以下html5/js/子文件夹中：

<s7viewers_root>/html5/js/FlyoutViewer.js

如果查看器部署在某个AdobeDynamic Media服务器上，并且来自同一域，则可以使用相对路径。 否则，您可以指定已安装IS-Viewers的某个AdobeDynamic Media服务器的完整路径。

相对路径如下所示：

<script language="javascript" type="text/javascript" src="/s7viewers/html5/js/FlyoutViewer.js"></script>
NOTE
仅引用页面上的主查看器JavaScript include文件。 请勿在网页代码中引用任何其他JavaScript文件，这些文件可能由查看器的逻辑在运行时下载。 特别是，请勿直接引用查看器从/s7viewers上下文HTML加载的库SDK Utils.js库（所谓的统一SDK include）。 原因是Utils.js或类似的运行时查看器库的位置完全由查看器的逻辑管理，并且查看器版本之间的位置会发生变化。 Adobe不会在服务器上保留旧版本的辅助查看器includes。
因此，将来在部署新产品版本时，在页面上直接引用查看器使用的任何二级JavaScript include会破坏查看器功能。

  1. 定义容器DIV。

    向要显示查看器的页面添加一个空DIV元素。 DIV元素必须定义其ID，因为此ID稍后将传递到查看器API。

    占位符DIV是定位元素，这意味着position CSS属性设置为relative或absolute。

    网页负责为占位符DIV元素指定适当的z-index。 这样做可确保查看器的弹出部分显示在其他网页元素的上方。

    以下是定义的占位符DIV元素的示例：

    code language-html 
    <div id="s7viewer" style="position:relative;z-index:1"></div>

  2. 设置查看器大小。

    此查看器在处理多项目集时显示缩略图。 在桌面系统上，缩览图位于主视图的下方。 同时，查看器允许在运行时使用setAsset() API交换主资源。 作为开发人员，当新资产只有一个项目时，您可以控制查看器管理底部区域中缩略图区域的方式。 可以保持外部查看器大小不变，并允许主视图增加其高度并占据缩略图区域。 或者，您可以保持主视图大小为静态并折叠外部查看器区域，让网页内容向上移动，然后使用缩略图中的剩余自由页面区域。

    要保持外部查看器边界不变，请定义.s7flyoutviewer顶级CSS类的大小（以绝对单位表示）。 CSS的大小调整可以直接放在HTML页面或自定义查看器CSS文件中，稍后可将其分配给Dynamic Media Classic中的查看器预设记录，或者使用style命令显式传递。

    有关使用CSS设置查看器样式的详细信息，请参阅自定义弹出查看器。

    以下是在HTML页中定义静态外部查看器大小的示例：

    code language-html 
    #s7viewer.s7flyoutviewer {
 width: 640px;
 height: 480px;
}

    您可以在下面的示例页面上看到带有固定外部查看器区域的行为。 请注意，在组之间切换时，外部查看器大小不会更改：

    https://experienceleague.adobe.com/tools/dynamic-media-demo/viewers-ref/flyout/FlyoutViewer-fixed-outer-area.html?lang=zh-Hans

    要使主视图维度为静态维度，请使用.s7flyoutviewer .s7container CSS选择器为内部Container SDK组件定义查看器大小（以绝对单位表示）。 此外，您应将默认查看器CSS设置为auto，以覆盖为.s7flyoutviewer顶级CSS类定义的固定大小。

    下面是定义内部Container SDK组件的查看器大小的示例，以便主视图区域在切换资产时不会更改其大小：

    code language-html 
    #s7viewer.s7flyoutviewer {
 width: auto;
 height: auto;
}
#s7viewer.s7flyoutviewer .s7container {
 width: 640px;
 height: 480px;
}

    以下示例页面显示了固定主视图大小的查看器行为。 请注意，在页面集之间切换时，主视图将保持静态状态，网页内容将垂直移动：

    https://experienceleague.adobe.com/tools/dynamic-media-demo/viewers-ref/flyout/FlyoutViewer-fixed-main-view.html?lang=zh-Hans

    此外，默认查看器CSS为开箱即用的外部区域提供固定大小。

  3. 创建和初始化查看器。

    完成上述步骤后，创建s7viewers.FlyoutViewer类的实例，将所有配置信息传递到其构造函数，并在查看器实例上调用init()方法。 配置信息作为JSON对象传递给构造函数。 此对象至少应具有containerId字段，该字段包含查看器容器ID的名称，并嵌套params JSON对象以及查看器支持的配置参数。 在这种情况下，params对象必须至少将图像服务URL作为serverUrl属性传递，并将初始资产作为asset参数传递。 基于JSON的初始化API允许您通过一行代码创建和启动查看器。

    将查看器容器添加到DOM很重要，这样查看器代码就可以按其ID查找容器元素。 某些浏览器会延迟构建DOM，直到网页结尾。 要获得最大兼容性，请在结束BODY标记之前或主体onload()事件上调用init()方法。

    同时，容器元素还不一定是网页布局的一部分。 例如，可以使用分配给它的display:none样式隐藏它。 在这种情况下，查看器会延迟其初始化过程，直到网页将容器元素带回布局为止。 进行此操作后，查看器加载会自动恢复。

    以下示例用于创建查看器实例，将所需的最少配置选项传递给构造函数并调用init()方法。 该示例假设flyoutViewer是查看器实例；s7viewer是占位符DIV的名称；http://s7d1.scene7.com/is/image/是图像服务URL；Scene7SharedAssets/ImageSet-Views-Sample是资源：

    code language-html 
    <script type="text/javascript">
var flyoutViewer = new s7viewers.FlyoutViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/ImageSet-Views-Sample",
 "serverurl":"http://s7d1.scene7.com/is/image/"
}
}).init();
</script>

    以下代码是嵌入固定大小弹出查看器的普通网页的完整示例：

    code language-html 
    <!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/FlyoutViewer.js"></script>
<style type="text/css">
#s7viewer.s7flyoutviewer {
 width: 640px;
 height: 480px;
}
</style>
</head>
<body>
<div id="s7viewer" style="position:relative;z-index:1;"></div>
<script type="text/javascript">
var flyoutViewer = new s7viewers.FlyoutViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/ImageSet-Views-Sample",
 "serverurl":"http://s7d1.scene7.com/is/image/"
}
}).init();
</script>
</body>
</html>

高度不受限制的响应式设计嵌入 section-056cb574713c4d07be6d07cf3c598839

通过响应式设计嵌入，网页通常具有某种灵活的布局，可指定查看器容器DIV的运行时大小。 对于以下示例，假设网页允许查看者的容器DIV占用Web浏览器窗口大小的40%，并且其高度不受限制。 网页HTML代码如下所示：

<!DOCTYPE html>
<html>
<head>
<style type="text/css">
.holder {
 width: 40%;
}
</style>
</head>
<body>
<div class="holder"></div>
</body>
</html>

将查看器添加到此类页面与嵌入固定大小的步骤类似。 唯一的区别是，必须使用以相对单位设置的大小覆盖默认查看器CSS的固定大小。

  1. 正在将查看器JavaScript文件添加到您的网页。
  2. 正在定义容器DIV。
  3. 设置查看器大小。
  4. 创建和初始化查看器。

上述所有步骤与嵌入固定大小相同，但以下三个例外：

  • 将容器DIV添加到现有“持有者”DIV；
  • 添加了具有显式断点的imagereload参数；
  • CSS将查看器宽度和高度设置为100%，而不是使用绝对单位设置固定的查看器大小，如下所述：
#s7viewer.s7flyoutviewer {
 width: 100%;
 height: 100%;
}

以下代码是一个完整的示例。 请注意当浏览器调整大小时查看器大小如何变化，以及查看器纵横比如何与资源匹配。

<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/FlyoutViewer.js"></script>
<style type="text/css">
.holder {
 width: 40%;
}
#s7viewer.s7flyoutviewer {
 width: 100%;
 height: 100%;
}
</style>
</head>
<body>
<div class="holder">
<div id="s7viewer" style="position:relative;z-index:1"></div>
</div>
<script type="text/javascript">
var flyoutViewer = new s7viewers.FlyoutViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/ImageSet-Views-Sample",
 "serverurl":"http://s7d1.scene7.com/is/image/",
 "imagereload":"1,breakpoint,200;400;800;1600"
}
}).init();
</script>
</body>
</html>

以下示例页面说明了高度不受限制的响应式设计嵌入的更多实际用途：

实时演示

备用演示位置

定义宽度和高度的灵活大小嵌入 section-0a329016f9414d199039776645c693de

如果定义了宽度和高度的灵活大小嵌入，则网页样式会不同。 它为"holder" DIV提供两种大小，并将其放在浏览器窗口中居中。 此外，网页将HTML和BODY元素的大小设置为100%。

<!DOCTYPE html>
<html>
<head>
<style type="text/css">
html, body {
 width: 100%;
 height: 100%;
}
.holder {
 position: absolute;
 left: 20%;
 top: 20%;
 width: 60%;
height: 60%;
}
</style>
</head>
<body>
<div class="holder"></div>
</body>
</html>

其余嵌入步骤与用于高度不受限制的响应式设计嵌入的步骤相同。 生成的示例如下：

<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/FlyoutViewer.js"></script>
<style type="text/css">
html, body {
 width: 100%;
 height: 100%;
}
.holder {
 position: absolute;
 left: 20%;
 top: 20%;
 width: 60%;
height: 60%;
}
#s7viewer.s7flyoutviewer {
 width: 100%;
 height: 100%;
}
</style>
</head>
<body>
<div class="holder">
<div id="s7viewer" style="position:relative;z-index:1"></div>
</div>
<script type="text/javascript">
var flyoutViewer = new s7viewers.FlyoutViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/ImageSet-Views-Sample",
 "serverurl":"http://s7d1.scene7.com/is/image/",
 "imagereload":"1,breakpoint,200;400;800;1600"
}
}).init();
</script>
</body>
</html>

使用基于Setter的API进行嵌入 section-af26f0cc2e5140e8a9bfd0c6a841a6d1

可以使用基于setter的API和no-args构造函数，而不是使用基于JSON的初始化。 使用此API构造函数不会接受任何参数，配置参数是使用setContainerId()、setParam()和setAsset() API方法通过单独的JavaScript调用指定的。

以下示例说明了如何将固定大小嵌入与基于setter的API一起使用：

<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/FlyoutViewer.js"></script>
<style type="text/css">
#s7viewer.s7flyoutviewer {
 width: 640px;
 height: 480px;
}
</style>
</head><body>
<div id="s7viewer" style="position:relative;z-index:1;"></div>
<script type="text/javascript">
var flyoutViewer = new s7viewers.FlyoutViewer();
flyoutViewer.setContainerId("s7viewer");
flyoutViewer.setParam("serverurl", "http://s7d1.scene7.com/is/image/");
flyoutViewer.setAsset("Scene7SharedAssets/ImageSet-Views-Sample");
flyoutViewer.init();
</script>
</body>
</html>
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8