RGLDocumentReaderGraphicField

Objective-C

@interface RGLDocumentReaderGraphicField : NSObject

/**
 Identifies zone whence data is extracted
 */
@property(nonatomic, assign, readonly) RGLResultType sourceType;
/**
 Graphic field logical type, one of RGLGraphicFieldType values
 */
@property(nonatomic, assign, readonly) RGLGraphicFieldType fieldType;
/**
 Graphic field symbolic name
 */
@property(nonatomic, strong, readonly, nonnull) NSString *fieldName;
/**
 Field area coordinates on the general image
 */
@property(nonatomic, assign, readonly) CGRect boundRect;
/**
 An image
 */
@property(nonatomic, strong, readonly, nonnull) UIImage *value;
/**
 Light type, one of RGLGraphicFieldLight values
 */
@property(nonatomic, assign, readonly) RGLGraphicFieldLight lightType;
/**
 Light symbolic name
 */
@property(nonatomic, strong, readonly, nonnull) NSString *lightName;
/**
 An index of the document page whence the graphic field is extracted
 */
@property(nonatomic, assign, readonly) NSInteger pageIndex;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithSourceType:(RGLResultType)sourceType fieldType:(RGLGraphicFieldType)fieldType boundRect:(CGRect)boundRect value:(UIImage *_Nonnull)value light:(RGLGraphicFieldLight) light pageIndex:(NSInteger)pageIndex;
- (instancetype _Nonnull)initWithFieldType:(RGLGraphicFieldType)fieldType valueJSON:(NSDictionary *_Nullable)json;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

+ (NSString *_Nullable)graphicFieldTypeName:(RGLGraphicFieldType)graphicFieldType;
+ (NSString *_Nullable)graphicFieldLightName:(RGLGraphicFieldLight)graphicFieldLight;

@end

Swift

class DocumentReaderGraphicField : NSObject

Undocumented

  • Identifies zone whence data is extracted

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLResultType sourceType;

    Swift

    var sourceType: ResultType { get }
  • Graphic field logical type, one of RGLGraphicFieldType values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLGraphicFieldType fieldType;

    Swift

    var fieldType: GraphicFieldType { get }
  • Graphic field symbolic name

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *fieldName;

    Swift

    var fieldName: String { get }
  • Field area coordinates on the general image

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGRect boundRect;

    Swift

    var boundRect: CGRect { get }
  • An image

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) UIImage *value;

    Swift

    var value: UIImage { get }
  • Light type, one of RGLGraphicFieldLight values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLGraphicFieldLight lightType;

    Swift

    var lightType: GraphicFieldLight { get }
  • Light symbolic name

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *lightName;

    Swift

    var lightName: String { get }
  • An index of the document page whence the graphic field is extracted

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger pageIndex;

    Swift

    var pageIndex: Int { get }
  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;
  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithSourceType:(RGLResultType)sourceType fieldType:(RGLGraphicFieldType)fieldType boundRect:(CGRect)boundRect value:(UIImage *_Nonnull)value light:(RGLGraphicFieldLight) light pageIndex:(NSInteger)pageIndex;

    Swift

    init(sourceType: ResultType, fieldType: GraphicFieldType, boundRect: CGRect, value: UIImage, light: GraphicFieldLight, pageIndex: Int)
  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithFieldType:(RGLGraphicFieldType)fieldType valueJSON:(NSDictionary *_Nullable)json;

    Swift

    init(fieldType: GraphicFieldType, valueJSON json: [AnyHashable : Any]?)
  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;

    Swift

    init(json: [AnyHashable : Any])
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;

    Swift

    class func initWithJSON(_ json: [AnyHashable : Any]) -> Self
  • Undocumented

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)jsonDictionary;

    Swift

    func jsonDictionary() -> [AnyHashable : Any]
  • Undocumented

    Declaration

    Objective-C

    + (NSString *_Nullable)graphicFieldTypeName:(RGLGraphicFieldType)graphicFieldType;

    Swift

    class func graphicFieldTypeName(_ graphicFieldType: GraphicFieldType) -> String?
  • Undocumented

    Declaration

    Objective-C

    + (NSString *_Nullable)graphicFieldLightName:(RGLGraphicFieldLight)graphicFieldLight;

    Swift

    class func graphicFieldLightName(_ graphicFieldLight: GraphicFieldLight) -> String?