Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::ImageSettings类 参考

## Public 成员函数
| constructor ()
| 构造函数。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetBackgroundDownScale (down_scale)
| 设置用于有损压缩模式的背景降采样值，用于优化 PDF 文档中的彩色图像。 更多...
| SetCompressionMode (mode)
| 设置用于优化 PDF 文档中彩色/灰度图像的压缩模式。 更多...
| SetForegroundDownScale (down_scale)
| 设置用于有损压缩模式的前景降采样值，用于优化 PDF 文档中的彩色图像。 更多...
| SetImageDPI (dpi)
| 设置 DPI 值作为压缩 PDF 文档中彩色/灰度图像的目标压缩值。 更多...
| SetImageDPILimit (dpi_limit)
| 设置彩色/灰度图像的下限 DPI 值，用于决定是否在 PDF 文档中压缩图像。 更多...
| SetQuality (quality)
| 设置用于有损压缩模式的质量，用于优化 PDF 文档中的彩色/灰度图像。 更多...
| SetStretchMode (mode)
| 设置用于优化 PDF 文档中彩色/灰度图像的拉伸模式。 更多...
| SetTextSensitivity (text_sensitivity)
| 设置用于有损压缩模式的文本敏感度，用于优化 PDF 文档中的彩色图像。 更多...
| SetTileSize (size)
| 设置用于 JPEG2000 压缩模式的平铺大小，用于优化 PDF 文档中的彩色/灰度图像。 更多...

## 静态 Public 属性
static | e_ImageCompressHigh
| 用于彩色或灰度图像的压缩模式枚举。 更多...
static | e_ImageCompressjpeg
| 压缩模式：JPEG。
static | e_ImageCompressjpeg2000
| 压缩模式：JPEG2000。
static | e_ImageCompressQualityHigh
| 压缩质量：高。
static | e_ImageCompressQualityLossless
| 压缩质量：无损，仅适用于 e_ImageCompressjpeg2000 压缩模式。
static | e_ImageCompressQualityLow
| 压缩质量：低。
static | e_ImageCompressQualityMaximum
| 压缩质量：最高。
static | e_ImageCompressQualityMedium
| 压缩质量：中等。
static | e_ImageCompressQualityMinimum
| 用于彩色或灰度图像的有损压缩质量枚举。 更多...
static | e_ImageCompressRetain
| 压缩模式：保留，表示不压缩。
static | e_ImageCompressZip
| 压缩模式：zip。
static | e_StretchBicubic
| 设置此值时，表示对缩放执行双三次插值。
static | e_StretchDefault
| 用于拉伸模式的枚举。 更多...
static | e_StretchDownsample
| 设置此值时，表示不对缩小或旋转执行半色调。
static | e_StretchInterpol
| 设置此值时，表示对缩放执行插值。
static | e_StretchNoSmooth
| 设置此值时，表示不对拉伸执行任何插值。
static | e_StretchOff
| 设置此值时，表示不执行拉伸。

## 详细描述

此类表示彩色和灰度图像的降采样/重新压缩设置。 此类对象可以设置到类 FSDK.OptimizerSettings，然后用于优化 PDF 文档。

参见
  FSDK.OptimizerSettings

## 成员函数说明

## ◆ constructor()

FSDK::ImageSettings::constructor | ( |  | ) |

构造函数。

此构造函数用于构造具有默认设置选项的彩色/灰度图像设置对象。 用户还可以调用此类中的 "set" 方法来更改这些设置选项。 请参考这些 "set" 方法的注释以获取有关默认值的更多详细信息。

## ◆ IsEmpty()

FSDK::ImageSettings::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示当前对象不为空。

## ◆ SetBackgroundDownScale()

FSDK::ImageSettings::SetBackgroundDownScale | ( | down_scale |  | ) |

设置用于有损压缩模式的背景降采样值，用于优化 PDF 文档中的彩色图像。

此函数用于降低背景图像的分辨率。

参数

  [in] | down_scale | 用于有损压缩模式的背景降采样值。应大于 0。 如果值为 1，则不降低背景分辨率。 如果值大于 1，则值越高，背景分辨率越低。 如果未调用此函数设置此选项，则表示使用 3 作为此选项的默认值。

返回
  无。

## ◆ SetCompressionMode()

FSDK::ImageSettings::SetCompressionMode | ( | mode |  | ) |

设置用于优化 PDF 文档中彩色/灰度图像的压缩模式。

对于新构造的对象，如果未调用此函数设置选项， 则表示使用 FSDK.ImageSettings.e_ImageCompressjpeg 作为此选项的默认值。

参数

  [in] | mode | 图像压缩模式。请参考从 FSDK.ImageSettings.e_ImageCompressHigh 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetForegroundDownScale()

FSDK::ImageSettings::SetForegroundDownScale | ( | down_scale |  | ) |

设置用于有损压缩模式的前景降采样值，用于优化 PDF 文档中的彩色图像。

此函数用于降低前景图像的分辨率。

参数

  [in] | down_scale | 用于有损压缩模式的前景降采样值。应大于 0。 如果值为 1，则不降低前景分辨率。 如果值大于 1，则值越高，前景分辨率越低。 如果未调用此函数设置此选项，则表示使用 3 作为此选项的默认值。

返回
  无。

## ◆ SetImageDPI()

FSDK::ImageSettings::SetImageDPI | ( | dpi |  | ) |

设置 DPI 值作为压缩 PDF 文档中彩色/灰度图像的目标压缩值。

当可以压缩图像时，此图像的分辨率将被压缩到当前函数设置的 DPI 值。
对于新构造的对象，如果未调用此函数设置选项， 则表示使用 150 作为此选项的默认值。

参数

  [in] | dpi | 设置为目标压缩 DPI 值的 DPI 值。

返回
  无。

## ◆ SetImageDPILimit()

FSDK::ImageSettings::SetImageDPILimit | ( | dpi_limit |  | ) |

设置彩色/灰度图像的下限 DPI 值，用于决定是否在 PDF 文档中压缩图像。

如果 PDF 文档中图像的分辨率高于下限 DPI 值，此图像将被压缩到 由函数 FSDK.ImageSettings.SetImageDPI 设置的目标压缩 DPI 值。
对于新构造的对象，如果未调用此函数设置选项， 则表示将使用 DPI 值（是目标压缩 DPI 值的 1.5 倍）作为此选项的默认值。

参数

  [in] | dpi_limit | 作为下限的 DPI 值。此值应为正数。建议范围： 大于目标压缩 DPI 值（由函数 FSDK.ImageSettings.SetImageDPI 设置）， 最大值为目标压缩 DPI 值的 10 倍。 如果输入值不大于目标压缩 DPI 值，将使用比目标压缩 DPI 值多 1 的 DPI 值。 如果输入值大于最大值，将使用最大值。

返回
  无。

## ◆ SetQuality()

FSDK::ImageSettings::SetQuality | ( | quality |  | ) |

设置用于有损压缩模式的质量，用于优化 PDF 文档中的彩色/灰度图像。

对于新构造的对象，如果未调用此函数设置此选项， 则表示使用 FSDK.ImageSettings.e_ImageCompressQualityMinimum 作为此选项的默认值。

参数

  [in] | quality | 用于有损压缩模式的质量值。请参考从 FSDK.ImageSettings.e_ImageCompressQualityMinimum 开始的值，这应该是这些值之一。

返回
  无。

## ◆ SetStretchMode()

FSDK::ImageSettings::SetStretchMode | ( | mode |  | ) |

设置用于优化 PDF 文档中彩色/灰度图像的拉伸模式。

对于新构造的对象，如果未调用此函数设置此选项， 则表示使用 FSDK.ImageSettings.e_StretchBicubic 作为此选项的默认值。

参数

  [in] | mode | 拉伸模式。请参考从 FSDK.ImageSettings.e_StretchOff 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetTextSensitivity()

FSDK::ImageSettings::SetTextSensitivity | ( | text_sensitivity |  | ) |

设置用于有损压缩模式的文本敏感度，用于优化 PDF 文档中的彩色图像。

此函数影响分割为前景（通常是文本）和背景。 如果未调用此函数设置此选项，则表示使用 60 作为此选项的默认值。

参数

  [in] | text_sensitivity | 文本敏感度的值。更高的敏感度值 会导致更多内容在前景中表示。该值对于 低对比度的文档以及具有图案、图像或背景颜色的文档尤其重要。 相反，对于高对比度、清晰明亮背景和清晰深色符号的简单文本文档，其影响较小。 有效值：从 0 到 100。

返回
  无。

## ◆ SetTileSize()

FSDK::ImageSettings::SetTileSize | ( | size |  | ) |

设置用于 JPEG2000 压缩模式的平铺大小，用于优化 PDF 文档中的彩色/灰度图像。

对于新构造的对象，如果未调用此函数设置此选项， 则表示使用 256 作为此选项的默认值。

参数

  [in] | size | 平铺的大小，此值只能在 128 到 2048 之间。

注解
  此方法仅在 e_ImageCompressjpeg2000 压缩模式下有效。

返回
  无。

## 类成员变量说明

## ◆ e_ImageCompressHigh

FSDK::ImageSettings::e_ImageCompressHigh
| static

用于彩色或灰度图像的压缩模式枚举。

此枚举的值应单独使用。

压缩模式：高。如果图像 DPI 小于 200，此标志将无效。

## ◆ e_ImageCompressQualityMinimum

FSDK::ImageSettings::e_ImageCompressQualityMinimum
| static

用于彩色或灰度图像的有损压缩质量枚举。

此枚举的值应单独使用。

压缩质量：最低。

## ◆ e_StretchDefault

FSDK::ImageSettings::e_StretchDefault
| static

用于拉伸模式的枚举。

此枚举的值应单独使用。

设置此值时，表示执行默认拉伸。