Class: Xberg::PdfConfig

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializePdfConfig

Returns a new instance of PdfConfig.

Parameters:

  • extract_images: (Boolean)
  • extract_tables: (Boolean)
  • passwords: (Array[String])
  • extract_metadata: (Boolean)
  • hierarchy: (HierarchyConfig)
  • extract_annotations: (Boolean)
  • top_margin_fraction: (Float)
  • bottom_margin_fraction: (Float)
  • allow_single_column_tables: (Boolean)
  • ocr_inline_images: (Boolean)
  • extract_form_fields: (Boolean)
  • reading_order: (Boolean)
  • backend: (enum_PdfBackend)


2027
# File 'sig/types.rbs', line 2027

def initialize: (?extract_images: bool, ?extract_tables: bool, ?passwords: Array[String], ?extract_metadata: bool, ?hierarchy: HierarchyConfig, ?extract_annotations: bool, ?top_margin_fraction: Float, ?bottom_margin_fraction: Float, ?allow_single_column_tables: bool, ?ocr_inline_images: bool, ?extract_form_fields: bool, ?reading_order: bool, ?backend: enum_PdfBackend) -> void

Instance Attribute Details

#allow_single_column_tablesBoolean (readonly)

Returns the value of attribute allow_single_column_tables.

Returns:

  • (Boolean)


2021
2022
2023
# File 'sig/types.rbs', line 2021

def allow_single_column_tables
  @allow_single_column_tables
end

#backendenum_PdfBackend (readonly)

Returns the value of attribute backend.

Returns:

  • (enum_PdfBackend)


2025
2026
2027
# File 'sig/types.rbs', line 2025

def backend
  @backend
end

#bottom_margin_fractionFloat? (readonly)

Returns the value of attribute bottom_margin_fraction.

Returns:

  • (Float, nil)


2020
2021
2022
# File 'sig/types.rbs', line 2020

def bottom_margin_fraction
  @bottom_margin_fraction
end

#extract_annotationsBoolean (readonly)

Returns the value of attribute extract_annotations.

Returns:

  • (Boolean)


2018
2019
2020
# File 'sig/types.rbs', line 2018

def extract_annotations
  @extract_annotations
end

#extract_form_fieldsBoolean (readonly)

Returns the value of attribute extract_form_fields.

Returns:

  • (Boolean)


2023
2024
2025
# File 'sig/types.rbs', line 2023

def extract_form_fields
  @extract_form_fields
end

#extract_imagesBoolean (readonly)

Returns the value of attribute extract_images.

Returns:

  • (Boolean)


2013
2014
2015
# File 'sig/types.rbs', line 2013

def extract_images
  @extract_images
end

#extract_metadataBoolean (readonly)

Returns the value of attribute extract_metadata.

Returns:

  • (Boolean)


2016
2017
2018
# File 'sig/types.rbs', line 2016

def 
  @extract_metadata
end

#extract_tablesBoolean (readonly)

Returns the value of attribute extract_tables.

Returns:

  • (Boolean)


2014
2015
2016
# File 'sig/types.rbs', line 2014

def extract_tables
  @extract_tables
end

#hierarchyHierarchyConfig? (readonly)

Returns the value of attribute hierarchy.

Returns:



2017
2018
2019
# File 'sig/types.rbs', line 2017

def hierarchy
  @hierarchy
end

#ocr_inline_imagesBoolean (readonly)

Returns the value of attribute ocr_inline_images.

Returns:

  • (Boolean)


2022
2023
2024
# File 'sig/types.rbs', line 2022

def ocr_inline_images
  @ocr_inline_images
end

#passwordsArray[String]? (readonly)

Returns the value of attribute passwords.

Returns:

  • (Array[String], nil)


2015
2016
2017
# File 'sig/types.rbs', line 2015

def passwords
  @passwords
end

#reading_orderBoolean (readonly)

Returns the value of attribute reading_order.

Returns:

  • (Boolean)


2024
2025
2026
# File 'sig/types.rbs', line 2024

def reading_order
  @reading_order
end

#top_margin_fractionFloat? (readonly)

Returns the value of attribute top_margin_fraction.

Returns:

  • (Float, nil)


2019
2020
2021
# File 'sig/types.rbs', line 2019

def top_margin_fraction
  @top_margin_fraction
end

Instance Method Details

#validatevoid

This method returns an undefined value.



2028
# File 'sig/types.rbs', line 2028

def validate: () -> void