Class Progress

Progress logger

Hierarchy

Progress
- ZoomLevelProgress

Implements

GeoPackageProgress

Index

Constructors

constructor

new Progress(title: string, countFrequency: number, timeFrequency: number, unit: string): Progress
Constructor
Parameters
- title: string
  
  title
- countFrequency: number
  
  count frequency
- timeFrequency: number
  
  time frequency in seconds
- unit: string
  
  unit
Returns Progress
- Defined in lib/io/progress.ts:68

Properties

`Protected` active

active: boolean = true

Active flag

`Protected` countFrequency

countFrequency: number

Log count frequency

`Protected` decimalFormat

decimalFormat: {
format: ((num: number) => string);
} = ...

Decimal format

Type declaration

format: ((num: number) => string)
- - (num: number): string
  - Parameters
    - num: number
    Returns string

`Protected` localCount

localCount: number = 0

Local count between logs

`Protected` localTime

localTime: Date = ...

Local time between logs

`Protected` max

max: number = null

Max number

`Protected` progress

progress: number = 0

Total progress

`Protected` timeFrequency

timeFrequency: number

Log time frequency, stored in milliseconds

`Protected` `Readonly` title

title: string

Log Title

`Protected` unit

unit: string

Log Unit

Methods

addProgress

addProgress(progress: number): void
Add to the total progress
Parameters
- progress: number
  
  progress made
Returns void
Implementation of GeoPackageProgress.addProgress
- Defined in lib/io/progress.ts:85

cancel

cancel(): void
Cancel the operation

Returns void
- Defined in lib/io/progress.ts:130

cleanupOnCancel

cleanupOnCancel(): boolean
Should the progress so far be deleted when canceled (#isActive() becomes false)

Returns
true to cleanup progress

Returns boolean
Implementation of GeoPackageProgress.cleanupOnCancel
- Defined in lib/io/progress.ts:123

getCountFrequency

getCountFrequency(): number
Get the count frequency

Returns
count frequency

Returns number
- Defined in lib/io/progress.ts:146

getMax

getMax(): number
Get the max

Returns
max

Returns number
- Defined in lib/io/progress.ts:138

`Protected` getPercentage

getPercentage(count: number, total: number): string
Get the string percentage of the count and total

Returns
string percentage
Parameters
- count: number
  
  current count
- total: number
  
  total count
Returns string
- Defined in lib/io/progress.ts:188

getProgress

getProgress(): number
Get the total progress

Returns
progress

Returns number
- Defined in lib/io/progress.ts:178

getTimeFrequency

getTimeFrequency(): number
Get the time frequency in seconds

Returns
time frequency in seconds

Returns number
- Defined in lib/io/progress.ts:162

isActive

isActive(): boolean
Is the process still active

Returns
true if active, false if canceled

Returns boolean
Implementation of GeoPackageProgress.isActive
- Defined in lib/io/progress.ts:116

`Protected` logProgress

logProgress(): void
Log the progress

Returns void
- Defined in lib/io/progress.ts:102

setCountFrequency

setCountFrequency(countFrequency: number): void
Set the count frequency
Parameters
- countFrequency: number
  
  count frequency
Returns void
- Defined in lib/io/progress.ts:154

setMax

setMax(max: number): void
Set the max progress value
Parameters
- max: number
  
  max value
Returns void
Implementation of GeoPackageProgress.setMax
- Defined in lib/io/progress.ts:78

setTimeFrequency

setTimeFrequency(timeFrequency: number): void
Set the time frequency in seconds
Parameters
- timeFrequency: number
  
  time frequency in seconds
Returns void
- Defined in lib/io/progress.ts:170

Class Progress

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

title: string

countFrequency: number

timeFrequency: number

unit: string

Returns Progress

Properties

Protected active

Protected countFrequency

Protected decimalFormat

Type declaration

format: ((num: number) => string)

Parameters

num: number

Returns string

Protected localCount

Protected localTime

Protected max

Protected progress

Protected timeFrequency

Protected Readonly title

Protected unit

Methods

addProgress

Parameters

progress: number

Returns void

cancel

Returns void

cleanupOnCancel

Returns

Returns boolean

getCountFrequency

Returns

Returns number

getMax

Returns

Returns number

Protected getPercentage

Returns

Parameters

count: number

total: number

Returns string

getProgress

Returns

Returns number

getTimeFrequency

Returns

Returns number

isActive

Returns

Returns boolean

Protected logProgress

Returns void

setCountFrequency

Parameters

countFrequency: number

Returns void

setMax

Parameters

max: number

Returns void

setTimeFrequency

Parameters

timeFrequency: number

Returns void

Settings

Member Visibility

Theme

`Protected` active

`Protected` countFrequency

`Protected` decimalFormat

`Protected` localCount

`Protected` localTime

`Protected` max

`Protected` progress

`Protected` timeFrequency

`Protected` `Readonly` title

`Protected` unit

`Protected` getPercentage

`Protected` logProgress