Project

CLASS	DESCRIPTION
AIX	The AIXFormat object represents a collection of Adobe Illustrator Exchange (AIX)
BMP	The BMPFormat object represents a collection of Microsoft Windows bitmap (BMP)
EMF	The EMFFormat object represents a collection of Enhanced Metafile format (EMF)
EPS	The EPSFormat object represents a collection of Encapsulated PostScript (EPS)
Format	Base Format class that contains all shared props and allows for isinstance checking for a Format object
GIF	The GIFFormat object represents a collection of Graphic Interchange Format (GIF)
JPEG	The JPEGFormat object represents a collection of Joint Photographic Experts Group (JPEG)
PDF	The PDFFormat object represents a collection of Portable Document Format (PDF)
PNG	The PNGFormat object represents a collection of Portable Network Graphics (PNG)
SVG	The SVGFormat object represents a collection of Scalable Vector Graphics (SVG)
TGA	The TGAFormat object represents a collection of Truevision Graphics Adaptor (TGA)

AIX dataclass

AIX(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    convertMarkers: bool = False,
    embedColorProfile: bool = True,
    embedFonts: bool = True,
    imageCompression: ImageCompression = 'ADAPTIVE',
    imageCompressionQuality: int = 80,
    imageQuality: ImageQuality = 'BEST',
    removeLayoutBackground: bool = True,
)

Bases: Format[AIXFormat, AIXOpts]

The AIXFormat object represents a collection of Adobe Illustrator Exchange (AIX) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output AIX file.

Documentation

BMP dataclass

BMP(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '24-BIT_TRUE_COLOR',
    georeferenceMapFrame: MapFrame | MapFrame | None = None,
    threshold: int = 128,
    worldFile: bool = False,
)

Bases: Format[BMPFormat, BMPOpts]

The BMPFormat object represents a collection of Microsoft Windows bitmap (BMP) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output BMP file.

Documentation

EMF dataclass

EMF(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    convertMarkers: bool = False,
    imageQuality: ImageQuality = 'BEST',
    outputAsImage: bool = False,
)

Bases: Format[EMFFormat, EMFOpts]

The EMFFormat object represents a collection of Enhanced Metafile format (EMF) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output EMF file.

Documentation

EPS dataclass

EPS(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    convertMarkers: bool = False,
    embedFonts: bool = True,
    imageCompression: ImageCompression = 'DEFLATE',
    imageQuality: ImageQuality = 'BEST',
    outputAsImage: bool = False,
)

Bases: Format[EPSFormat, EPSOpts]

The EPSFormat object represents a collection of Encapsulated PostScript (EPS) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output EPS file.

Documentation

Format dataclass

Format(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
)

Base Format class that contains all shared props and allows for isinstance checking for a Format object

Subclassed by:

• Modules Project
  •  AIX
  •  BMP
  •  EMF
  •  EPS
  •  GIF
  •  JPEG
  •  PDF
  •  PNG
  •  SVG
  •  TGA
  •  TIFF

Used by:

• Modules Project
  •  Layout  export
  •  MapFrame  export
  •  MapView  export

METHOD	DESCRIPTION
update	Update the Format with the provided options.

update abstractmethod

update(
    mapping: Opts | None = None, /, **opts: Unpack[Opts]
) -> None

Update the Format with the provided options.

PARAMETER	DESCRIPTION
mapping	An optional positional only dictionary (arg[0]) containing the update options TYPE: Opts | None DEFAULT: None
**opts	Keyword overrides that will be applied to any supplied mapping arg TYPE: Unpack[Opts] DEFAULT: {}

Source code in src/arcpie/project/formats.py

@abstractmethod
def update(self, mapping: Opts | None = None, /, **opts: Unpack[Opts]) -> None:  # type: ignore
    """Update the Format with the provided options.

    Args:
        mapping: An optional positional only dictionary (arg[0]) containing the update options
        **opts: Keyword overrides that will be applied to any supplied mapping arg
    """

GIF dataclass

GIF(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '8-BIT_ADAPTIVE_PALETTE',
    georeferenceMapFrame: MapFrame | MapFrame | None = None,
    threshold: int = 128,
    worldFile: bool = False,
)

Bases: Format[GIFFormat, GIFOpts]

The GIFFormat object represents a collection of Graphic Interchange Format (GIF) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output GIF file.

Documentation

JPEG dataclass

JPEG(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '24-BIT_TRUE_COLOR',
    georeferenceMapFrame: MapFrame | MapFrame | None = None,
    imageCompressionQuality: int = 80,
    worldFile: bool = False,
)

Bases: Format[JPEGFormat, JPEGOpts]

The JPEGFormat object represents a collection of Joint Photographic Experts Group (JPEG) file properties that can be configured and used with the export method on the Layout, MapFrame, MapView, MapSeries and BookmarkMapSeries objects to create an output JPG file.

Documentation

PDF dataclass

PDF(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    author: str = '',
    compressVectorGraphics: bool = True,
    convertMarkers: bool = False,
    embedColorProfile: bool = True,
    embedFonts: bool = True,
    georefInfo: bool = True,
    imageCompression: ImageCompression = 'ADAPTIVE',
    imageCompressionQuality: int = 80,
    imageQuality: ImageQuality = 'BEST',
    includeAccessibilityTags: bool = True,
    includeNonVisibleMapLayers: bool = False,
    keywords: str = '',
    languageCode: str = '',
    layersAndAttributes: LayerAttributes = 'LAYERS_ONLY',
    outputAsImage: bool = False,
    rasterAsSingleTile: bool = False,
    removeLayoutBackground: bool = False,
    simulateOverprint: bool = False,
    subject: str = '',
    title: str = '',
)

Bases: Format[PDFFormat, PDFOpts]

The PDFFormat object represents a collection of Portable Document Format (PDF) file properties that can be configured and used with the export method on the Layout, MapFrame, MapView, MapSeries, BookmarkMapSeries and Report objects to create an output PDF file.

Documentation

PNG dataclass

PNG(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '32-BIT_WITH_ALPHA',
    georeferenceMapFrame: MapFrame | MapFrame | None = None,
    threshold: int = 128,
    transparentBackground: bool = False,
    worldFile: bool = False,
)

Bases: Format[PNGFormat, PNGOpts]

The PNGFormat object represents a collection of Portable Network Graphics (PNG) file properties that can be configured and used with the export method on the Layout, MapFrame, MapView, MapSeries and BookmarkMapSeries objects to create an output PNG file.

Documentation

SVG dataclass

SVG(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    compressToSVGZ: bool = False,
    convertMarkers: bool = False,
    embedFonts: bool = True,
    imageQuality: ImageQuality = 'BEST',
    includeNonVisibleMapLayers: bool = False,
    outputAsImage: bool = False,
    rasterAsSingleTile: bool = False,
)

Bases: Format[SVGFormat, SVGOpts]

The SVGFormat object represents a collection of Scalable Vector Graphics (SVG) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output SVG or SVGZ file.

Documentation

TGA dataclass

TGA(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '32-BIT_WITH_ALPHA',
    transparentBackground: bool = False,
)

Bases: Format[TGAFormat, TGAOpts]

The TGAFormat object represents a collection of Truevision Graphics Adaptor (TGA) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output TGA file.

Documentation

TIFF dataclass

TIFF(
    clipToElements: bool = False,
    filePath: Path | str = '',
    height: float = 960,
    width: float = 960,
    resolution: int = 96,
    colorMode: ColorMode = '32-BIT_WITH_ALPHA',
    embedColorProfile: bool = True,
    georeferenceMapFrame: MapFrame | MapFrame | None = None,
    geoTIFFTags: bool = False,
    imageCompression: ImageCompression = 'LZW',
    imageCompressionQuality: int = 100,
    threshold: int = 128,
    transparentBackground: bool = False,
    worldFile: bool = False,
)

Bases: Format[TIFFFormat, TIFFOpts]

The TIFFFormat object represents a collection of Tagged Image File Format (TIFF) file properties that can be configured and used with the export method on the Layout, MapFrame, MapView, MapSeries and BookmarkMapSeries objects to create an output TIF file.

Documentation