Convert options. More...

#include <base_type.h>

Public Attributes
bool	enable_ai_layout = true
	Whether to enable AI layout analysis during conversion.

bool	contain_image = true
	Whether to contain images when converting,which takes effect only when IsAllowOCR is false.

bool	json_contain_table = true
	Whether to contain table when convert pdf to json.

bool	contain_annotation = true
	Whether to contain annotations when converting.

bool	excel_all_content = false
	Whether to set contain all pdf content to the xlsx file.

bool	excel_csv_format = false
	Whether to set to save the table in csv format.

bool	enable_ocr = false
	Whether to use OCR.

bool	txt_table_format = true
	Whether format table when convert pdf to txt.

bool	image_path_enhance = false
	Whether to enhance the image path.

bool	formula_to_image = false
	Whether to convert formulas to images.

float	image_scaling = 1.0
	Specify the image scaling of the image file.

PageLayoutMode	page_layout_mode = PageLayoutMode::e_Flow
	Specify the layout mode.

ExcelWorksheetOption	excel_worksheet_option = ExcelWorksheetOption::e_ForTable
	Specify the Excel worksheet option.

HtmlOption	html_option = HtmlOption::e_SinglePage
	Specify the Html option.

ImageColorMode	image_color_mode = ImageColorMode::e_Color
	Specify the image color mode of the image file.

ImageType	image_type = ImageType::e_JPG
	Specify the image type of the image file.

std::string	page_ranges
	Specify the pages to convert, e.g. "1-3,5,7-9".

Detailed Description

Convert options.

Member Data Documentation

◆ contain_annotation

bool compdfkit::base::ConvertOptions::contain_annotation = true

Whether to contain annotations when converting.

◆ contain_image

bool compdfkit::base::ConvertOptions::contain_image = true

Whether to contain images when converting,which takes effect only when IsAllowOCR is false.

◆ enable_ai_layout

bool compdfkit::base::ConvertOptions::enable_ai_layout = true

Whether to enable AI layout analysis during conversion.

◆ enable_ocr

bool compdfkit::base::ConvertOptions::enable_ocr = false

Whether to use OCR.

◆ excel_all_content

bool compdfkit::base::ConvertOptions::excel_all_content = false

Whether to set contain all pdf content to the xlsx file.

◆ excel_csv_format

bool compdfkit::base::ConvertOptions::excel_csv_format = false

Whether to set to save the table in csv format.

◆ excel_worksheet_option

ExcelWorksheetOption compdfkit::base::ConvertOptions::excel_worksheet_option = ExcelWorksheetOption::e_ForTable

Specify the Excel worksheet option.

◆ formula_to_image

bool compdfkit::base::ConvertOptions::formula_to_image = false

Whether to convert formulas to images.

◆ html_option

HtmlOption compdfkit::base::ConvertOptions::html_option = HtmlOption::e_SinglePage

Specify the Html option.

◆ image_color_mode

ImageColorMode compdfkit::base::ConvertOptions::image_color_mode = ImageColorMode::e_Color

Specify the image color mode of the image file.

◆ image_path_enhance

bool compdfkit::base::ConvertOptions::image_path_enhance = false

Whether to enhance the image path.

◆ image_scaling

float compdfkit::base::ConvertOptions::image_scaling = 1.0

Specify the image scaling of the image file.

◆ image_type

ImageType compdfkit::base::ConvertOptions::image_type = ImageType::e_JPG

Specify the image type of the image file.

◆ json_contain_table

bool compdfkit::base::ConvertOptions::json_contain_table = true

Whether to contain table when convert pdf to json.

◆ page_layout_mode

PageLayoutMode compdfkit::base::ConvertOptions::page_layout_mode = PageLayoutMode::e_Flow

Specify the layout mode.

◆ page_ranges

std::string compdfkit::base::ConvertOptions::page_ranges

Specify the pages to convert, e.g. "1-3,5,7-9".

◆ txt_table_format

bool compdfkit::base::ConvertOptions::txt_table_format = true

Whether format table when convert pdf to txt.

The documentation for this struct was generated from the following file:

base_type.h

Public Attributes