Class ImageFileDirectory

constructor

• new ImageFileDirectory(
      actualizedFields: Map<
          string
          | number,
          string | number | (string | number)[],
      >,
      deferredFields: Map<string | number, Function>,
      deferredArrays: Map<string | number, DeferredArray>,
      nextIFDByteOffset: number,
  ): ImageFileDirectory

  Create an ImageFileDirectory.

  Parameters

  • actualizedFields: Map<string | number, string | number | (string | number)[]>

    the file directory, mapping tag names to values

  • deferredFields: Map<string | number, Function>

    the deferred fields, mapping tag names to async functions

  • deferredArrays: Map<string | number, DeferredArray>

    the deferred arrays, mapping tag names to DeferredArray objects

  • nextIFDByteOffset: number

    the byte offset to the next IFD

  Returns ImageFileDirectory

actualizedFields

deferredArrays

deferredFields

deferredFieldsBeingResolved

nextIFDByteOffset

getValue

• getValue<
      T extends
          | "NewSubfileType"
          | "SubfileType"
          | "ImageWidth"
          | "ImageLength"
          | "BitsPerSample"
          | "Compression"
          | "PhotometricInterpretation"
          | "Threshholding"
          | "CellWidth"
          | "CellLength"
          | "FillOrder"
          | "DocumentName"
          | "ImageDescription"
          | "Make"
          | "Model"
          | "StripOffsets"
          | "Orientation"
          | "SamplesPerPixel"
          | "RowsPerStrip"
          | "StripByteCounts"
          | "MinSampleValue"
          | "MaxSampleValue"
          | "XResolution"
          | "YResolution"
          | "PlanarConfiguration"
          | "PageName"
          | "XPosition"
          | "YPosition"
          | "FreeOffsets"
          | "FreeByteCounts"
          | "GrayResponseUnit"
          | "GrayResponseCurve"
          | "T4Options"
          | "T6Options"
          | "ResolutionUnit"
          | "PageNumber"
          | "TransferFunction"
          | "Software"
          | "DateTime"
          | "Artist"
          | "HostComputer"
          | "Predictor"
          | "WhitePoint"
          | "PrimaryChromaticities"
          | "ColorMap"
          | "HalftoneHints"
          | "TileWidth"
          | "TileLength"
          | "TileOffsets"
          | "TileByteCounts"
          | "InkSet"
          | "InkNames"
          | "NumberOfInks"
          | "DotRange"
          | "TargetPrinter"
          | "ExtraSamples"
          | "SampleFormat"
          | "SMinSampleValue"
          | "SMaxSampleValue"
          | "TransferRange"
          | "JPEGProc"
          | "JPEGInterchangeFormat"
          | "JPEGInterchangeFormatLngth"
          | "JPEGRestartInterval"
          | "JPEGLosslessPredictors"
          | "JPEGPointTransforms"
          | "JPEGQTables"
          | "JPEGDCTables"
          | "JPEGACTables"
          | "YCbCrCoefficients"
          | "YCbCrSubSampling"
          | "YCbCrPositioning"
          | "ReferenceBlackWhite"
          | "Copyright"
          | "BadFaxLines"
          | "CleanFaxData"
          | "ClipPath"
          | "ConsecutiveBadFaxLines"
          | "Decode"
          | "DefaultImageColor"
          | "Indexed"
          | "JPEGTables"
          | "StripRowCounts"
          | "SubIFDs"
          | "XClipPathUnits"
          | "YClipPathUnits"
          | "ApertureValue"
          | "ColorSpace"
          | "DateTimeDigitized"
          | "DateTimeOriginal"
          | "ExifIFD"
          | "ExifVersion"
          | "ExposureTime"
          | "FileSource"
          | "Flash"
          | "FlashpixVersion"
          | "FNumber"
          | "ImageUniqueID"
          | "LightSource"
          | "MakerNote"
          | "ShutterSpeedValue"
          | "UserComment"
          | "IPTC"
          | "CZ_LSMINFO"
          | "ICCProfile"
          | "XMP"
          | "GDAL_METADATA"
          | "GDAL_NODATA"
          | "Photoshop"
          | "ModelPixelScale"
          | "ModelTiepoint"
          | "ModelTransformation"
          | "GeoKeyDirectory"
          | "GeoDoubleParams"
          | "GeoAsciiParams"
          | "LercParameters" = any,
  >(
      tagIdentifier: number | T,
  ): T extends | "NewSubfileType"
  | "SubfileType"
  | "ImageWidth"
  | "ImageLength"
  | "BitsPerSample"
  | "Compression"
  | "PhotometricInterpretation"
  | "Threshholding"
  | "CellWidth"
  | "CellLength"
  | "FillOrder"
  | "DocumentName"
  | "ImageDescription"
  | "Make"
  | "Model"
  | "StripOffsets"
  | "Orientation"
  | "SamplesPerPixel"
  | "RowsPerStrip"
  | "StripByteCounts"
  | "MinSampleValue"
  | "MaxSampleValue"
  | "XResolution"
  | "YResolution"
  | "PlanarConfiguration"
  | "PageName"
  | "XPosition"
  | "YPosition"
  | "FreeOffsets"
  | "FreeByteCounts"
  | "GrayResponseUnit"
  | "GrayResponseCurve"
  | "T4Options"
  | "T6Options"
  | "ResolutionUnit"
  | "PageNumber"
  | "TransferFunction"
  | "Software"
  | "DateTime"
  | "Artist"
  | "HostComputer"
  | "Predictor"
  | "WhitePoint"
  | "PrimaryChromaticities"
  | "ColorMap"
  | "HalftoneHints"
  | "TileWidth"
  | "TileLength"
  | "TileOffsets"
  | "TileByteCounts"
  | "InkSet"
  | "InkNames"
  | "NumberOfInks"
  | "DotRange"
  | "TargetPrinter"
  | "ExtraSamples"
  | "SampleFormat"
  | "SMinSampleValue"
  | "SMaxSampleValue"
  | "TransferRange"
  | "JPEGProc"
  | "JPEGInterchangeFormat"
  | "JPEGInterchangeFormatLngth"
  | "JPEGRestartInterval"
  | "JPEGLosslessPredictors"
  | "JPEGPointTransforms"
  | "JPEGQTables"
  | "JPEGDCTables"
  | "JPEGACTables"
  | "YCbCrCoefficients"
  | "YCbCrSubSampling"
  | "YCbCrPositioning"
  | "ReferenceBlackWhite"
  | "Copyright"
  | "BadFaxLines"
  | "CleanFaxData"
  | "ClipPath"
  | "ConsecutiveBadFaxLines"
  | "Decode"
  | "DefaultImageColor"
  | "Indexed"
  | "JPEGTables"
  | "StripRowCounts"
  | "SubIFDs"
  | "XClipPathUnits"
  | "YClipPathUnits"
  | "ApertureValue"
  | "ColorSpace"
  | "DateTimeDigitized"
  | "DateTimeOriginal"
  | "ExifIFD"
  | "ExifVersion"
  | "ExposureTime"
  | "FileSource"
  | "Flash"
  | "FlashpixVersion"
  | "FNumber"
  | "ImageUniqueID"
  | "LightSource"
  | "MakerNote"
  | "ShutterSpeedValue"
  | "UserComment"
  | "IPTC"
  | "CZ_LSMINFO"
  | "ICCProfile"
  | "XMP"
  | "GDAL_METADATA"
  | "GDAL_NODATA"
  | "Photoshop"
  | "ModelPixelScale"
  | "ModelTiepoint"
  | "ModelTransformation"
  | "GeoKeyDirectory"
  | "GeoDoubleParams"
  | "GeoAsciiParams"
  | "LercParameters"
      ? TagValue<T<T>>
      | undefined
      : unknown

  Synchronously retrieves the value for a given tag. If it is deferred, an error is thrown.

  Type Parameters

  • T extends
        | "NewSubfileType"
        | "SubfileType"
        | "ImageWidth"
        | "ImageLength"
        | "BitsPerSample"
        | "Compression"
        | "PhotometricInterpretation"
        | "Threshholding"
        | "CellWidth"
        | "CellLength"
        | "FillOrder"
        | "DocumentName"
        | "ImageDescription"
        | "Make"
        | "Model"
        | "StripOffsets"
        | "Orientation"
        | "SamplesPerPixel"
        | "RowsPerStrip"
        | "StripByteCounts"
        | "MinSampleValue"
        | "MaxSampleValue"
        | "XResolution"
        | "YResolution"
        | "PlanarConfiguration"
        | "PageName"
        | "XPosition"
        | "YPosition"
        | "FreeOffsets"
        | "FreeByteCounts"
        | "GrayResponseUnit"
        | "GrayResponseCurve"
        | "T4Options"
        | "T6Options"
        | "ResolutionUnit"
        | "PageNumber"
        | "TransferFunction"
        | "Software"
        | "DateTime"
        | "Artist"
        | "HostComputer"
        | "Predictor"
        | "WhitePoint"
        | "PrimaryChromaticities"
        | "ColorMap"
        | "HalftoneHints"
        | "TileWidth"
        | "TileLength"
        | "TileOffsets"
        | "TileByteCounts"
        | "InkSet"
        | "InkNames"
        | "NumberOfInks"
        | "DotRange"
        | "TargetPrinter"
        | "ExtraSamples"
        | "SampleFormat"
        | "SMinSampleValue"
        | "SMaxSampleValue"
        | "TransferRange"
        | "JPEGProc"
        | "JPEGInterchangeFormat"
        | "JPEGInterchangeFormatLngth"
        | "JPEGRestartInterval"
        | "JPEGLosslessPredictors"
        | "JPEGPointTransforms"
        | "JPEGQTables"
        | "JPEGDCTables"
        | "JPEGACTables"
        | "YCbCrCoefficients"
        | "YCbCrSubSampling"
        | "YCbCrPositioning"
        | "ReferenceBlackWhite"
        | "Copyright"
        | "BadFaxLines"
        | "CleanFaxData"
        | "ClipPath"
        | "ConsecutiveBadFaxLines"
        | "Decode"
        | "DefaultImageColor"
        | "Indexed"
        | "JPEGTables"
        | "StripRowCounts"
        | "SubIFDs"
        | "XClipPathUnits"
        | "YClipPathUnits"
        | "ApertureValue"
        | "ColorSpace"
        | "DateTimeDigitized"
        | "DateTimeOriginal"
        | "ExifIFD"
        | "ExifVersion"
        | "ExposureTime"
        | "FileSource"
        | "Flash"
        | "FlashpixVersion"
        | "FNumber"
        | "ImageUniqueID"
        | "LightSource"
        | "MakerNote"
        | "ShutterSpeedValue"
        | "UserComment"
        | "IPTC"
        | "CZ_LSMINFO"
        | "ICCProfile"
        | "XMP"
        | "GDAL_METADATA"
        | "GDAL_NODATA"
        | "Photoshop"
        | "ModelPixelScale"
        | "ModelTiepoint"
        | "ModelTransformation"
        | "GeoKeyDirectory"
        | "GeoDoubleParams"
        | "GeoAsciiParams"
        | "LercParameters" = any

  Parameters

  • tagIdentifier: number | T

    The field tag ID or name

  Returns T extends | "NewSubfileType"
  | "SubfileType"
  | "ImageWidth"
  | "ImageLength"
  | "BitsPerSample"
  | "Compression"
  | "PhotometricInterpretation"
  | "Threshholding"
  | "CellWidth"
  | "CellLength"
  | "FillOrder"
  | "DocumentName"
  | "ImageDescription"
  | "Make"
  | "Model"
  | "StripOffsets"
  | "Orientation"
  | "SamplesPerPixel"
  | "RowsPerStrip"
  | "StripByteCounts"
  | "MinSampleValue"
  | "MaxSampleValue"
  | "XResolution"
  | "YResolution"
  | "PlanarConfiguration"
  | "PageName"
  | "XPosition"
  | "YPosition"
  | "FreeOffsets"
  | "FreeByteCounts"
  | "GrayResponseUnit"
  | "GrayResponseCurve"
  | "T4Options"
  | "T6Options"
  | "ResolutionUnit"
  | "PageNumber"
  | "TransferFunction"
  | "Software"
  | "DateTime"
  | "Artist"
  | "HostComputer"
  | "Predictor"
  | "WhitePoint"
  | "PrimaryChromaticities"
  | "ColorMap"
  | "HalftoneHints"
  | "TileWidth"
  | "TileLength"
  | "TileOffsets"
  | "TileByteCounts"
  | "InkSet"
  | "InkNames"
  | "NumberOfInks"
  | "DotRange"
  | "TargetPrinter"
  | "ExtraSamples"
  | "SampleFormat"
  | "SMinSampleValue"
  | "SMaxSampleValue"
  | "TransferRange"
  | "JPEGProc"
  | "JPEGInterchangeFormat"
  | "JPEGInterchangeFormatLngth"
  | "JPEGRestartInterval"
  | "JPEGLosslessPredictors"
  | "JPEGPointTransforms"
  | "JPEGQTables"
  | "JPEGDCTables"
  | "JPEGACTables"
  | "YCbCrCoefficients"
  | "YCbCrSubSampling"
  | "YCbCrPositioning"
  | "ReferenceBlackWhite"
  | "Copyright"
  | "BadFaxLines"
  | "CleanFaxData"
  | "ClipPath"
  | "ConsecutiveBadFaxLines"
  | "Decode"
  | "DefaultImageColor"
  | "Indexed"
  | "JPEGTables"
  | "StripRowCounts"
  | "SubIFDs"
  | "XClipPathUnits"
  | "YClipPathUnits"
  | "ApertureValue"
  | "ColorSpace"
  | "DateTimeDigitized"
  | "DateTimeOriginal"
  | "ExifIFD"
  | "ExifVersion"
  | "ExposureTime"
  | "FileSource"
  | "Flash"
  | "FlashpixVersion"
  | "FNumber"
  | "ImageUniqueID"
  | "LightSource"
  | "MakerNote"
  | "ShutterSpeedValue"
  | "UserComment"
  | "IPTC"
  | "CZ_LSMINFO"
  | "ICCProfile"
  | "XMP"
  | "GDAL_METADATA"
  | "GDAL_NODATA"
  | "Photoshop"
  | "ModelPixelScale"
  | "ModelTiepoint"
  | "ModelTransformation"
  | "GeoKeyDirectory"
  | "GeoDoubleParams"
  | "GeoAsciiParams"
  | "LercParameters"
      ? TagValue<T<T>>
      | undefined
      : unknown

  the field value, or undefined if it does not exist

  Throws

  If the tag is deferred and requires asynchronous loading

hasTag

• hasTag<
      T extends
          | "NewSubfileType"
          | "SubfileType"
          | "ImageWidth"
          | "ImageLength"
          | "BitsPerSample"
          | "Compression"
          | "PhotometricInterpretation"
          | "Threshholding"
          | "CellWidth"
          | "CellLength"
          | "FillOrder"
          | "DocumentName"
          | "ImageDescription"
          | "Make"
          | "Model"
          | "StripOffsets"
          | "Orientation"
          | "SamplesPerPixel"
          | "RowsPerStrip"
          | "StripByteCounts"
          | "MinSampleValue"
          | "MaxSampleValue"
          | "XResolution"
          | "YResolution"
          | "PlanarConfiguration"
          | "PageName"
          | "XPosition"
          | "YPosition"
          | "FreeOffsets"
          | "FreeByteCounts"
          | "GrayResponseUnit"
          | "GrayResponseCurve"
          | "T4Options"
          | "T6Options"
          | "ResolutionUnit"
          | "PageNumber"
          | "TransferFunction"
          | "Software"
          | "DateTime"
          | "Artist"
          | "HostComputer"
          | "Predictor"
          | "WhitePoint"
          | "PrimaryChromaticities"
          | "ColorMap"
          | "HalftoneHints"
          | "TileWidth"
          | "TileLength"
          | "TileOffsets"
          | "TileByteCounts"
          | "InkSet"
          | "InkNames"
          | "NumberOfInks"
          | "DotRange"
          | "TargetPrinter"
          | "ExtraSamples"
          | "SampleFormat"
          | "SMinSampleValue"
          | "SMaxSampleValue"
          | "TransferRange"
          | "JPEGProc"
          | "JPEGInterchangeFormat"
          | "JPEGInterchangeFormatLngth"
          | "JPEGRestartInterval"
          | "JPEGLosslessPredictors"
          | "JPEGPointTransforms"
          | "JPEGQTables"
          | "JPEGDCTables"
          | "JPEGACTables"
          | "YCbCrCoefficients"
          | "YCbCrSubSampling"
          | "YCbCrPositioning"
          | "ReferenceBlackWhite"
          | "Copyright"
          | "BadFaxLines"
          | "CleanFaxData"
          | "ClipPath"
          | "ConsecutiveBadFaxLines"
          | "Decode"
          | "DefaultImageColor"
          | "Indexed"
          | "JPEGTables"
          | "StripRowCounts"
          | "SubIFDs"
          | "XClipPathUnits"
          | "YClipPathUnits"
          | "ApertureValue"
          | "ColorSpace"
          | "DateTimeDigitized"
          | "DateTimeOriginal"
          | "ExifIFD"
          | "ExifVersion"
          | "ExposureTime"
          | "FileSource"
          | "Flash"
          | "FlashpixVersion"
          | "FNumber"
          | "ImageUniqueID"
          | "LightSource"
          | "MakerNote"
          | "ShutterSpeedValue"
          | "UserComment"
          | "IPTC"
          | "CZ_LSMINFO"
          | "ICCProfile"
          | "XMP"
          | "GDAL_METADATA"
          | "GDAL_NODATA"
          | "Photoshop"
          | "ModelPixelScale"
          | "ModelTiepoint"
          | "ModelTransformation"
          | "GeoKeyDirectory"
          | "GeoDoubleParams"
          | "GeoAsciiParams"
          | "LercParameters" = any,
  >(
      tagIdentifier: number | T,
  ): this is { getValue(t: T): NonNullable<TagValue<T>> } & ImageFileDirectory

  Type Parameters

  • T extends
        | "NewSubfileType"
        | "SubfileType"
        | "ImageWidth"
        | "ImageLength"
        | "BitsPerSample"
        | "Compression"
        | "PhotometricInterpretation"
        | "Threshholding"
        | "CellWidth"
        | "CellLength"
        | "FillOrder"
        | "DocumentName"
        | "ImageDescription"
        | "Make"
        | "Model"
        | "StripOffsets"
        | "Orientation"
        | "SamplesPerPixel"
        | "RowsPerStrip"
        | "StripByteCounts"
        | "MinSampleValue"
        | "MaxSampleValue"
        | "XResolution"
        | "YResolution"
        | "PlanarConfiguration"
        | "PageName"
        | "XPosition"
        | "YPosition"
        | "FreeOffsets"
        | "FreeByteCounts"
        | "GrayResponseUnit"
        | "GrayResponseCurve"
        | "T4Options"
        | "T6Options"
        | "ResolutionUnit"
        | "PageNumber"
        | "TransferFunction"
        | "Software"
        | "DateTime"
        | "Artist"
        | "HostComputer"
        | "Predictor"
        | "WhitePoint"
        | "PrimaryChromaticities"
        | "ColorMap"
        | "HalftoneHints"
        | "TileWidth"
        | "TileLength"
        | "TileOffsets"
        | "TileByteCounts"
        | "InkSet"
        | "InkNames"
        | "NumberOfInks"
        | "DotRange"
        | "TargetPrinter"
        | "ExtraSamples"
        | "SampleFormat"
        | "SMinSampleValue"
        | "SMaxSampleValue"
        | "TransferRange"
        | "JPEGProc"
        | "JPEGInterchangeFormat"
        | "JPEGInterchangeFormatLngth"
        | "JPEGRestartInterval"
        | "JPEGLosslessPredictors"
        | "JPEGPointTransforms"
        | "JPEGQTables"
        | "JPEGDCTables"
        | "JPEGACTables"
        | "YCbCrCoefficients"
        | "YCbCrSubSampling"
        | "YCbCrPositioning"
        | "ReferenceBlackWhite"
        | "Copyright"
        | "BadFaxLines"
        | "CleanFaxData"
        | "ClipPath"
        | "ConsecutiveBadFaxLines"
        | "Decode"
        | "DefaultImageColor"
        | "Indexed"
        | "JPEGTables"
        | "StripRowCounts"
        | "SubIFDs"
        | "XClipPathUnits"
        | "YClipPathUnits"
        | "ApertureValue"
        | "ColorSpace"
        | "DateTimeDigitized"
        | "DateTimeOriginal"
        | "ExifIFD"
        | "ExifVersion"
        | "ExposureTime"
        | "FileSource"
        | "Flash"
        | "FlashpixVersion"
        | "FNumber"
        | "ImageUniqueID"
        | "LightSource"
        | "MakerNote"
        | "ShutterSpeedValue"
        | "UserComment"
        | "IPTC"
        | "CZ_LSMINFO"
        | "ICCProfile"
        | "XMP"
        | "GDAL_METADATA"
        | "GDAL_NODATA"
        | "Photoshop"
        | "ModelPixelScale"
        | "ModelTiepoint"
        | "ModelTransformation"
        | "GeoKeyDirectory"
        | "GeoDoubleParams"
        | "GeoAsciiParams"
        | "LercParameters" = any

  Parameters

  • tagIdentifier: number | T

    The field tag ID or name

  Returns this is { getValue(t: T): NonNullable<TagValue<T>> } & ImageFileDirectory

  whether the field exists (actualized or deferred)

loadValue

• loadValue<
      T extends
          | "NewSubfileType"
          | "SubfileType"
          | "ImageWidth"
          | "ImageLength"
          | "BitsPerSample"
          | "Compression"
          | "PhotometricInterpretation"
          | "Threshholding"
          | "CellWidth"
          | "CellLength"
          | "FillOrder"
          | "DocumentName"
          | "ImageDescription"
          | "Make"
          | "Model"
          | "StripOffsets"
          | "Orientation"
          | "SamplesPerPixel"
          | "RowsPerStrip"
          | "StripByteCounts"
          | "MinSampleValue"
          | "MaxSampleValue"
          | "XResolution"
          | "YResolution"
          | "PlanarConfiguration"
          | "PageName"
          | "XPosition"
          | "YPosition"
          | "FreeOffsets"
          | "FreeByteCounts"
          | "GrayResponseUnit"
          | "GrayResponseCurve"
          | "T4Options"
          | "T6Options"
          | "ResolutionUnit"
          | "PageNumber"
          | "TransferFunction"
          | "Software"
          | "DateTime"
          | "Artist"
          | "HostComputer"
          | "Predictor"
          | "WhitePoint"
          | "PrimaryChromaticities"
          | "ColorMap"
          | "HalftoneHints"
          | "TileWidth"
          | "TileLength"
          | "TileOffsets"
          | "TileByteCounts"
          | "InkSet"
          | "InkNames"
          | "NumberOfInks"
          | "DotRange"
          | "TargetPrinter"
          | "ExtraSamples"
          | "SampleFormat"
          | "SMinSampleValue"
          | "SMaxSampleValue"
          | "TransferRange"
          | "JPEGProc"
          | "JPEGInterchangeFormat"
          | "JPEGInterchangeFormatLngth"
          | "JPEGRestartInterval"
          | "JPEGLosslessPredictors"
          | "JPEGPointTransforms"
          | "JPEGQTables"
          | "JPEGDCTables"
          | "JPEGACTables"
          | "YCbCrCoefficients"
          | "YCbCrSubSampling"
          | "YCbCrPositioning"
          | "ReferenceBlackWhite"
          | "Copyright"
          | "BadFaxLines"
          | "CleanFaxData"
          | "ClipPath"
          | "ConsecutiveBadFaxLines"
          | "Decode"
          | "DefaultImageColor"
          | "Indexed"
          | "JPEGTables"
          | "StripRowCounts"
          | "SubIFDs"
          | "XClipPathUnits"
          | "YClipPathUnits"
          | "ApertureValue"
          | "ColorSpace"
          | "DateTimeDigitized"
          | "DateTimeOriginal"
          | "ExifIFD"
          | "ExifVersion"
          | "ExposureTime"
          | "FileSource"
          | "Flash"
          | "FlashpixVersion"
          | "FNumber"
          | "ImageUniqueID"
          | "LightSource"
          | "MakerNote"
          | "ShutterSpeedValue"
          | "UserComment"
          | "IPTC"
          | "CZ_LSMINFO"
          | "ICCProfile"
          | "XMP"
          | "GDAL_METADATA"
          | "GDAL_NODATA"
          | "Photoshop"
          | "ModelPixelScale"
          | "ModelTiepoint"
          | "ModelTransformation"
          | "GeoKeyDirectory"
          | "GeoDoubleParams"
          | "GeoAsciiParams"
          | "LercParameters" = any,
  >(
      tagIdentifier: number | T,
  ): Promise<
      T extends | "NewSubfileType"
      | "SubfileType"
      | "ImageWidth"
      | "ImageLength"
      | "BitsPerSample"
      | "Compression"
      | "PhotometricInterpretation"
      | "Threshholding"
      | "CellWidth"
      | "CellLength"
      | "FillOrder"
      | "DocumentName"
      | "ImageDescription"
      | "Make"
      | "Model"
      | "StripOffsets"
      | "Orientation"
      | "SamplesPerPixel"
      | "RowsPerStrip"
      | "StripByteCounts"
      | "MinSampleValue"
      | "MaxSampleValue"
      | "XResolution"
      | "YResolution"
      | "PlanarConfiguration"
      | "PageName"
      | "XPosition"
      | "YPosition"
      | "FreeOffsets"
      | "FreeByteCounts"
      | "GrayResponseUnit"
      | "GrayResponseCurve"
      | "T4Options"
      | "T6Options"
      | "ResolutionUnit"
      | "PageNumber"
      | "TransferFunction"
      | "Software"
      | "DateTime"
      | "Artist"
      | "HostComputer"
      | "Predictor"
      | "WhitePoint"
      | "PrimaryChromaticities"
      | "ColorMap"
      | "HalftoneHints"
      | "TileWidth"
      | "TileLength"
      | "TileOffsets"
      | "TileByteCounts"
      | "InkSet"
      | "InkNames"
      | "NumberOfInks"
      | "DotRange"
      | "TargetPrinter"
      | "ExtraSamples"
      | "SampleFormat"
      | "SMinSampleValue"
      | "SMaxSampleValue"
      | "TransferRange"
      | "JPEGProc"
      | "JPEGInterchangeFormat"
      | "JPEGInterchangeFormatLngth"
      | "JPEGRestartInterval"
      | "JPEGLosslessPredictors"
      | "JPEGPointTransforms"
      | "JPEGQTables"
      | "JPEGDCTables"
      | "JPEGACTables"
      | "YCbCrCoefficients"
      | "YCbCrSubSampling"
      | "YCbCrPositioning"
      | "ReferenceBlackWhite"
      | "Copyright"
      | "BadFaxLines"
      | "CleanFaxData"
      | "ClipPath"
      | "ConsecutiveBadFaxLines"
      | "Decode"
      | "DefaultImageColor"
      | "Indexed"
      | "JPEGTables"
      | "StripRowCounts"
      | "SubIFDs"
      | "XClipPathUnits"
      | "YClipPathUnits"
      | "ApertureValue"
      | "ColorSpace"
      | "DateTimeDigitized"
      | "DateTimeOriginal"
      | "ExifIFD"
      | "ExifVersion"
      | "ExposureTime"
      | "FileSource"
      | "Flash"
      | "FlashpixVersion"
      | "FNumber"
      | "ImageUniqueID"
      | "LightSource"
      | "MakerNote"
      | "ShutterSpeedValue"
      | "UserComment"
      | "IPTC"
      | "CZ_LSMINFO"
      | "ICCProfile"
      | "XMP"
      | "GDAL_METADATA"
      | "GDAL_NODATA"
      | "Photoshop"
      | "ModelPixelScale"
      | "ModelTiepoint"
      | "ModelTransformation"
      | "GeoKeyDirectory"
      | "GeoDoubleParams"
      | "GeoAsciiParams"
      | "LercParameters"
          ? TagValue<T<T>>
          | undefined
          : any,
  >

  Retrieves the value for a given tag. If it is deferred, it will be loaded first.

  Type Parameters

  • T extends
        | "NewSubfileType"
        | "SubfileType"
        | "ImageWidth"
        | "ImageLength"
        | "BitsPerSample"
        | "Compression"
        | "PhotometricInterpretation"
        | "Threshholding"
        | "CellWidth"
        | "CellLength"
        | "FillOrder"
        | "DocumentName"
        | "ImageDescription"
        | "Make"
        | "Model"
        | "StripOffsets"
        | "Orientation"
        | "SamplesPerPixel"
        | "RowsPerStrip"
        | "StripByteCounts"
        | "MinSampleValue"
        | "MaxSampleValue"
        | "XResolution"
        | "YResolution"
        | "PlanarConfiguration"
        | "PageName"
        | "XPosition"
        | "YPosition"
        | "FreeOffsets"
        | "FreeByteCounts"
        | "GrayResponseUnit"
        | "GrayResponseCurve"
        | "T4Options"
        | "T6Options"
        | "ResolutionUnit"
        | "PageNumber"
        | "TransferFunction"
        | "Software"
        | "DateTime"
        | "Artist"
        | "HostComputer"
        | "Predictor"
        | "WhitePoint"
        | "PrimaryChromaticities"
        | "ColorMap"
        | "HalftoneHints"
        | "TileWidth"
        | "TileLength"
        | "TileOffsets"
        | "TileByteCounts"
        | "InkSet"
        | "InkNames"
        | "NumberOfInks"
        | "DotRange"
        | "TargetPrinter"
        | "ExtraSamples"
        | "SampleFormat"
        | "SMinSampleValue"
        | "SMaxSampleValue"
        | "TransferRange"
        | "JPEGProc"
        | "JPEGInterchangeFormat"
        | "JPEGInterchangeFormatLngth"
        | "JPEGRestartInterval"
        | "JPEGLosslessPredictors"
        | "JPEGPointTransforms"
        | "JPEGQTables"
        | "JPEGDCTables"
        | "JPEGACTables"
        | "YCbCrCoefficients"
        | "YCbCrSubSampling"
        | "YCbCrPositioning"
        | "ReferenceBlackWhite"
        | "Copyright"
        | "BadFaxLines"
        | "CleanFaxData"
        | "ClipPath"
        | "ConsecutiveBadFaxLines"
        | "Decode"
        | "DefaultImageColor"
        | "Indexed"
        | "JPEGTables"
        | "StripRowCounts"
        | "SubIFDs"
        | "XClipPathUnits"
        | "YClipPathUnits"
        | "ApertureValue"
        | "ColorSpace"
        | "DateTimeDigitized"
        | "DateTimeOriginal"
        | "ExifIFD"
        | "ExifVersion"
        | "ExposureTime"
        | "FileSource"
        | "Flash"
        | "FlashpixVersion"
        | "FNumber"
        | "ImageUniqueID"
        | "LightSource"
        | "MakerNote"
        | "ShutterSpeedValue"
        | "UserComment"
        | "IPTC"
        | "CZ_LSMINFO"
        | "ICCProfile"
        | "XMP"
        | "GDAL_METADATA"
        | "GDAL_NODATA"
        | "Photoshop"
        | "ModelPixelScale"
        | "ModelTiepoint"
        | "ModelTransformation"
        | "GeoKeyDirectory"
        | "GeoDoubleParams"
        | "GeoAsciiParams"
        | "LercParameters" = any

  Parameters

  • tagIdentifier: number | T

    The field tag ID or name

  Returns Promise<
      T extends | "NewSubfileType"
      | "SubfileType"
      | "ImageWidth"
      | "ImageLength"
      | "BitsPerSample"
      | "Compression"
      | "PhotometricInterpretation"
      | "Threshholding"
      | "CellWidth"
      | "CellLength"
      | "FillOrder"
      | "DocumentName"
      | "ImageDescription"
      | "Make"
      | "Model"
      | "StripOffsets"
      | "Orientation"
      | "SamplesPerPixel"
      | "RowsPerStrip"
      | "StripByteCounts"
      | "MinSampleValue"
      | "MaxSampleValue"
      | "XResolution"
      | "YResolution"
      | "PlanarConfiguration"
      | "PageName"
      | "XPosition"
      | "YPosition"
      | "FreeOffsets"
      | "FreeByteCounts"
      | "GrayResponseUnit"
      | "GrayResponseCurve"
      | "T4Options"
      | "T6Options"
      | "ResolutionUnit"
      | "PageNumber"
      | "TransferFunction"
      | "Software"
      | "DateTime"
      | "Artist"
      | "HostComputer"
      | "Predictor"
      | "WhitePoint"
      | "PrimaryChromaticities"
      | "ColorMap"
      | "HalftoneHints"
      | "TileWidth"
      | "TileLength"
      | "TileOffsets"
      | "TileByteCounts"
      | "InkSet"
      | "InkNames"
      | "NumberOfInks"
      | "DotRange"
      | "TargetPrinter"
      | "ExtraSamples"
      | "SampleFormat"
      | "SMinSampleValue"
      | "SMaxSampleValue"
      | "TransferRange"
      | "JPEGProc"
      | "JPEGInterchangeFormat"
      | "JPEGInterchangeFormatLngth"
      | "JPEGRestartInterval"
      | "JPEGLosslessPredictors"
      | "JPEGPointTransforms"
      | "JPEGQTables"
      | "JPEGDCTables"
      | "JPEGACTables"
      | "YCbCrCoefficients"
      | "YCbCrSubSampling"
      | "YCbCrPositioning"
      | "ReferenceBlackWhite"
      | "Copyright"
      | "BadFaxLines"
      | "CleanFaxData"
      | "ClipPath"
      | "ConsecutiveBadFaxLines"
      | "Decode"
      | "DefaultImageColor"
      | "Indexed"
      | "JPEGTables"
      | "StripRowCounts"
      | "SubIFDs"
      | "XClipPathUnits"
      | "YClipPathUnits"
      | "ApertureValue"
      | "ColorSpace"
      | "DateTimeDigitized"
      | "DateTimeOriginal"
      | "ExifIFD"
      | "ExifVersion"
      | "ExposureTime"
      | "FileSource"
      | "Flash"
      | "FlashpixVersion"
      | "FNumber"
      | "ImageUniqueID"
      | "LightSource"
      | "MakerNote"
      | "ShutterSpeedValue"
      | "UserComment"
      | "IPTC"
      | "CZ_LSMINFO"
      | "ICCProfile"
      | "XMP"
      | "GDAL_METADATA"
      | "GDAL_NODATA"
      | "Photoshop"
      | "ModelPixelScale"
      | "ModelTiepoint"
      | "ModelTransformation"
      | "GeoKeyDirectory"
      | "GeoDoubleParams"
      | "GeoAsciiParams"
      | "LercParameters"
          ? TagValue<T<T>>
          | undefined
          : any,
  >

  the field value, or undefined if it does not exist

loadValueIndexed

• loadValueIndexed(
      tagIdentifier: string | number,
      index: number,
  ): Promise<string | number | bigint | undefined>

  Retrieves the value at a given index for a tag that is an array. If it is deferred, it will be loaded first.

  Parameters

  • tagIdentifier: string | number

    The field tag ID or name

  • index: number

    The index within the array

  Returns Promise<string | number | bigint | undefined>

  the field value at the given index, or undefined if it does not exist

parseGeoKeyDirectory

• parseGeoKeyDirectory(): Partial<Record<GeoKeyName, any>> | null

  Parses the GeoTIFF GeoKeyDirectory tag into a structured object. The GeoKeyDirectory is a special TIFF tag that contains geographic metadata in a key-value format as defined by the GeoTIFF specification.

  Returns Partial<Record<GeoKeyName, any>> | null

  Parsed geo key directory mapping key names to values, or null if not present

  Throws

  If a referenced geo key value cannot be retrieved

toObject

• toObject(): Record<string, unknown>

  Returns Record<string, unknown>