Class ScanOptions

Helper class for getting/setting scan options.

Any changes (i.e. calls to ScanOptions.setValue) return a new class instance.

Hierarchy

ScanOptionsBase
- ScanOptions

Index

Constructors

`Protected` constructor

new ScanOptions(lib, opts): ScanOptions
Parameters
- lib: LibSANE
- opts: ScanOption<any>[]
Returns ScanOptions
Inherited from ScanOptionsBase.constructor
- Defined in src/options.ts:102

Properties

`Protected` _lib

_lib: LibSANE

`Readonly` brX

brX: null | ScanOption<number> = null

Well-known SANE option br-x.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` brY

brY: null | ScanOption<number> = null

Well-known SANE option br-y.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` options

options: readonly ScanOption<any>[]

List of all SANE options.

`Readonly` preview

preview: null | ScanOption<boolean> = null

Well-known SANE option preview.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` resolution

resolution: null | ScanOption<number> = null

Well-known SANE option resolution.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` tlX

tlX: null | ScanOption<number> = null

Well-known SANE option tl-x.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` tlY

tlY: null | ScanOption<number> = null

Well-known SANE option tl-y.

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

`Readonly` zero

zero: ScanOption<number>

Well-known SANE option index zero (total number of options).

See

https://sane-project.gitlab.io/standard/1.06/api.html#well-known-options

Methods

[iterator]

[iterator](): IterableIterator<ScanOption<any>>
Returns IterableIterator<ScanOption<any>>
Inherited from ScanOptionsBase.[iterator]
- Defined in src/options.ts:73

`Protected` _setOpts

_setOpts(this, opts): void
Parameters
- this: {
      brX: null | ScanOption<number>;
      brY: null | ScanOption<number>;
      options: readonly ScanOption<any>[];
      preview: null | ScanOption<boolean>;
      resolution: null | ScanOption<number>;
      tlX: null | ScanOption<number>;
      tlY: null | ScanOption<number>;
      zero: ScanOption<number>;
      [iterator]() => IterableIterator<ScanOption<any>>;
      setValue(index, value) => any;
  }
  - Readonly brX: null | ScanOption<number>
  - Readonly brY: null | ScanOption<number>
  - Readonly options: readonly ScanOption<any>[]
  - Readonly preview: null | ScanOption<boolean>
  - Readonly resolution: null | ScanOption<number>
  - Readonly tlX: null | ScanOption<number>
  - Readonly tlY: null | ScanOption<number>
  - Readonly zero: ScanOption<number>
  - [iterator]:function
    - [iterator](): IterableIterator<ScanOption<any>>
    - Returns IterableIterator<ScanOption<any>>
      
      Defined in src/options.ts:73
  - setValue:function
    - setValue(index, value): any
    - Set option value. Use null as value for automatic.
      
      Parameters
      
      index: number
      
      value: any
      
      Returns any
      
      See
      https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option
      
      Defined in src/options.ts:163
- opts: ScanOption<any>[]
Returns void
Inherited from ScanOptionsBase._setOpts
- Defined in src/options.ts:107

`Protected` _setValue

_setValue(index, value): Promise<{
    info: null;
    opts: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
} | {
    info: SANEInfo;
    opts: ScanOption<any>[];
    status: GOOD;
}>
Parameters
- index: number
- value: any
Returns Promise<{
    info: null;
    opts: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
} | {
    info: SANEInfo;
    opts: ScanOption<any>[];
    status: GOOD;
}>
Inherited from ScanOptionsBase._setValue
- Defined in src/options.ts:125

setValue

setValue(index, value): Promise<{
    info: SANEInfo;
    status: GOOD;
    updated: ScanOptions;
} | {
    info: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
    updated: null;
}>
Set option value. Use null as value for automatic.
Parameters
- index: number
- value: any
Returns Promise<{
    info: SANEInfo;
    status: GOOD;
    updated: ScanOptions;
} | {
    info: null;
    status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
    updated: null;
}>

See
https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option
Overrides ScanOptionsBase.setValue
- Defined in src/options.ts:201

`Static` `Protected` _getOpts

_getOpts(lib): Promise<ScanOption<any>[]>
Parameters
- lib: LibSANE
Returns Promise<ScanOption<any>[]>
Inherited from ScanOptionsBase._getOpts
- Defined in src/options.ts:77

`Static` get

get(lib): Promise<ScanOptions>
Get class instance (with all scanning options).
Parameters
- lib: LibSANE
Returns Promise<ScanOptions>
Overrides ScanOptionsBase.get
- Defined in src/options.ts:197

Class ScanOptions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

lib: LibSANE

opts: ScanOption<any>[]

Returns ScanOptions

Properties

Protected _lib

Readonly brX

See

Readonly brY

See

Readonly options

Readonly preview

See

Readonly resolution

See

Readonly tlX

See

Readonly tlY

See

Readonly zero

See

Methods

[iterator]

Returns IterableIterator<ScanOption<any>>

Protected _setOpts

Parameters

Readonly brX: null | ScanOption<number>

Readonly brY: null | ScanOption<number>

Readonly options: readonly ScanOption<any>[]

Readonly preview: null | ScanOption<boolean>

Readonly resolution: null | ScanOption<number>

Readonly tlX: null | ScanOption<number>

Readonly tlY: null | ScanOption<number>

Readonly zero: ScanOption<number>

[iterator]:function

Returns IterableIterator<ScanOption<any>>

setValue:function

Parameters

index: number

value: any

Returns any

See

opts: ScanOption<any>[]

Returns void

Protected _setValue

Parameters

index: number

value: any

Returns Promise<{ info: null; opts: null; status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; } | { info: SANEInfo; opts: ScanOption<any>[]; status: GOOD; }>

setValue

Parameters

index: number

value: any

Returns Promise<{ info: SANEInfo; status: GOOD; updated: ScanOptions; } | { info: null; status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED; updated: null; }>

See

Static Protected _getOpts

Parameters

lib: LibSANE

Returns Promise<ScanOption<any>[]>

Static get

Parameters

lib: LibSANE

Returns Promise<ScanOptions>

Settings

Member Visibility

Theme

On This Page

`Protected` constructor

`Protected` _lib

`Readonly` brX

`Readonly` brY

`Readonly` options

`Readonly` preview

`Readonly` resolution

`Readonly` tlX

`Readonly` tlY

`Readonly` zero

`Protected` _setOpts

`Readonly` brX: null | ScanOption<number>

`Readonly` brY: null | ScanOption<number>

`Readonly` options: readonly ScanOption<any>[]

`Readonly` preview: null | ScanOption<boolean>

`Readonly` resolution: null | ScanOption<number>

`Readonly` tlX: null | ScanOption<number>

`Readonly` tlY: null | ScanOption<number>

`Readonly` zero: ScanOption<number>

`Protected` _setValue

Returns Promise<{
info: null;
opts: null;
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
} | {
info: SANEInfo;
opts: ScanOption<any>[];
status: GOOD;
}>

Returns Promise<{
info: SANEInfo;
status: GOOD;
updated: ScanOptions;
} | {
info: null;
status: UNSUPPORTED | CANCELLED | DEVICE_BUSY | INVAL | EOF | JAMMED | NO_DOCS | COVER_OPEN | IO_ERROR | NO_MEM | ACCESS_DENIED;
updated: null;
}>

`Static` `Protected` _getOpts

`Static` get