TableDataExtractionSettings: { allowedExportFormats?: TableDataExportFormat[]; appearance?: { visibleOptions?: ExtractTableOptionType[] | boolean; visualEditor?: { cssText?: string; emptyCellColor?: string; enableAutoScroll?: boolean; hideSelectionArea?: boolean; lineColor?: string; selectionAreaColor?: string; selectionAreaOpacity?: string } }; extractOptions?: ClientTableExtractOptions }

Configuration options for the Table Data Extraction panel. Defines settings for table data extraction behavior, appearance, and export capabilities.

Type declaration

  • Optional allowedExportFormats?: TableDataExportFormat[]

    Specifies the formats available for exporting extracted table data.

    Default

    ['tsv', 'csv', 'json', 'xlsx', 'xml', 'html']

    Example

    // Allow only CSV and JSON exports
    options.tableDataExtraction = {
    allowedExportFormats: ['csv', 'json']
    };

    Remarks

    Supported formats:

    • 'tsv': Tab-separated values
    • 'csv': Comma-separated values
    • 'json': JavaScript Object Notation
    • 'xlsx': Microsoft Excel format
    • 'xml': Extensible Markup Language
    • 'html': HyperText Markup Language table
  • Optional appearance?: { visibleOptions?: ExtractTableOptionType[] | boolean; visualEditor?: { cssText?: string; emptyCellColor?: string; enableAutoScroll?: boolean; hideSelectionArea?: boolean; lineColor?: string; selectionAreaColor?: string; selectionAreaOpacity?: string } }

    UI customization options for the Table Extraction Panel.

    • Optional visibleOptions?: ExtractTableOptionType[] | boolean

      Controls visibility and ordering of extraction parameters in the options panel.

      Default

      ["CoefMinimumDistanceBetweenRows", "CoefMinimumDistanceBetweenCols", "MinimumRowHeight", "MinimumColWidth"]

      Example

      // Show specific options in custom order
      options.tableDataExtraction = {
      appearance: {
      visibleOptions: ['CoefPrecision', 'MinimumRowHeight']
      }
      };

      Example

      // Hide all options
      options.tableDataExtraction = {
      appearance: {
      visibleOptions: false
      }
      };

      Remarks

      When array is provided, only listed options will be visible in the specified order. When set to false, all options will be hidden from the UI.

    • Optional visualEditor?: { cssText?: string; emptyCellColor?: string; enableAutoScroll?: boolean; hideSelectionArea?: boolean; lineColor?: string; selectionAreaColor?: string; selectionAreaOpacity?: string }

      Visual styling options for the table extraction editor interface.

      Example

      viewer.options.tableDataExtraction = {
      appearance: {
      visualEditor: {
      lineColor: "red",
      selectionAreaColor: "rgba(255,0,0,0.2)",
      hideSelectionArea: false
      }
      }
      };
      • Optional cssText?: string

        Additional CSS styles to apply to the visual editor

        Example

        "border: 1px dashed black; background-color: yellow;"
        
      • Optional emptyCellColor?: string

        Empty cell background color

        Default

        rgba(165, 151, 151, 0.2)

      • Optional enableAutoScroll?: boolean

        Determines whether auto - scrolling is enabled when the cursor reaches the edge of the page during table selection.
        When set to true orundefined, auto - scrolling is enabled, allowing the page to scroll automatically as the cursor approaches the edge.
        If set tofalse, auto - scrolling is disabled.

      • Optional hideSelectionArea?: boolean

        Whether to hide the selection area highlight

        Default

        false

      • Optional lineColor?: string

        Color of the grid lines in the visual editor

        Default

        "#3a87fd" (blue)

        Example

        "red", "#FF0000", "rgb(255,0,0)"
        
      • Optional selectionAreaColor?: string

        Background color of the selection area

        Default

        "rgba(58, 135, 253, 0.2)" (light blue)

        Example

        "rgba(255,0,0,0.3)" for semi-transparent red
        
      • Optional selectionAreaOpacity?: string

        Opacity level of the selection area (0-1)

        Default

        "0.2"

  • Optional extractOptions?: ClientTableExtractOptions

    Advanced configuration for table extraction algorithms.

    Example

    // Configure extraction precision parameters
    options.tableDataExtraction = {
    extractOptions: {
    CoefPrecision: 0.3,
    CoefTokenization: 0.1,
    MinimumRowHeight: 15
    }
    };

    Property

    Precision coefficient for cell detection (0-1)

    Property

    Text tokenization sensitivity (0-1)

    Property

    Minimum row spacing in pixels

    Property

    Minimum column spacing in pixels