export method

export

Exports the collection of metadata to the stream.

def export(self, metadata, stream):
    ...
Parameter Type Description
metadata Iterable[MetadataItem] The collection of metadata.
stream io.RawIOBase The output stream.

export

Exports the document information to the stream.

def export(self, document_info, stream):
    ...
Parameter Type Description
document_info IDocumentInfo The document information.
stream io.RawIOBase The output stream.

export

Exports the collection of text areas to the stream.

def export(self, text_areas, stream):
    ...
Parameter Type Description
text_areas Iterable[PageTextArea] The collection of the text areas.
stream io.RawIOBase The output stream.

export

Exports the collection of tables to the stream.

def export(self, tables, stream):
    ...
Parameter Type Description
tables Iterable[PageTableArea] The collection of tables.
stream io.RawIOBase The output stream.

export

Exports the collection of barcodes to the provided output stream.

def export(self, barcodes, stream):
    ...
Parameter Type Description
barcodes Iterable[PageBarcodeArea] Iterable of barcode objects to export.
stream io.RawIOBase An io.RawIOBase stream to write the exported data.

export

Exports document data to the stream.

def export(self, document_data, stream):
    ...
Parameter Type Description
document_data DocumentData Document data.
stream io.RawIOBase The output stream.

Returns: None.

Aliases

These names call export too, limited to the overloads listed.

Alias Accepts
export_ienumerable export_ienumerable(metadata, stream)
export_ienumerable(text_areas, stream)
export_ienumerable(tables, stream)
export_ienumerable(barcodes, stream)
export_stream export_stream(metadata, stream)
export_stream(document_info, stream)
export_stream(text_areas, stream)
export_stream(tables, stream)
export_stream(barcodes, stream)
export_stream(document_data, stream)
export_streams export_streams(metadata, stream)
export_streams(document_info, stream)
export_streams(text_areas, stream)
export_streams(tables, stream)
export_streams(barcodes, stream)
export_streams(document_data, stream)
export_idocument_info export_idocument_info(document_info, stream)
export_document_data export_document_data(document_data, stream)

See Also