Class FLEXRunData

A class that contains methods for interacting with the Amplify API

Hierarchy (View Summary)

FLEXAdminSingleRun
- FLEXRunData

Constructors

constructor

new FLEXRunData(): FLEXRunData
Class constructor. Calls _init() on the superclass. Add parameters as needed

Returns FLEXRunData
Overrides FLEXAdminSingleRun.constructor
- Defined in src/ViewModel/FLEXRunDataView.vm.ts:30

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from FLEXAdminSingleRun.amplify
- Defined in src/Model/DGUtility.m.ts:86
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from FLEXAdminSingleRun.amplify
- Defined in src/Model/DGUtility.m.ts:74

analyzedStats

get analyzedStats(): (string | number | boolean)[][]
Returns (string | number | boolean)[][]
Inherited from FLEXAdminSingleRun.analyzedStats
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:664

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from FLEXAdminSingleRun.ctx
- Defined in src/Model/DGUtility.m.ts:82
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from FLEXAdminSingleRun.ctx
- Defined in src/Model/DGUtility.m.ts:78

currentIrregularity

get currentIrregularity(): string
Returns string
Inherited from FLEXAdminSingleRun.currentIrregularity
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:680

errorFunction

set errorFunction(error: (errors: string[] | number[] | object[]) => void): void
Parameters
- error: (errors: string[] | number[] | object[]) => void
Returns void
Inherited from FLEXAdminSingleRun.errorFunction
- Defined in src/Model/DGUtility.m.ts:70

FULL_DATA_TABLE_ROWS

get FULL_DATA_TABLE_ROWS(): number
Returns number
Inherited from FLEXAdminSingleRun.FULL_DATA_TABLE_ROWS
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:219

fullRunData

get fullRunData(): (string | number | boolean)[][]
Returns (string | number | boolean)[][]
Inherited from FLEXAdminSingleRun.fullRunData
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:215

irregularityCalculatedFor

get irregularityCalculatedFor(): string
Returns string
Inherited from FLEXAdminSingleRun.irregularityCalculatedFor
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:686

itemsPerPage

get itemsPerPage(): number
Returns number
Inherited from FLEXAdminSingleRun.itemsPerPage
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:676
set itemsPerPage(itemsPerPage: number): void
Parameters
- itemsPerPage: number
Returns void
Inherited from FLEXAdminSingleRun.itemsPerPage
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:672

MAX_EON_3_UPLOAD_SIZE

get MAX_EON_3_UPLOAD_SIZE(): number
Returns number
Inherited from FLEXAdminSingleRun.MAX_EON_3_UPLOAD_SIZE
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:656

Methods

`Protected`_error

_error(errors: string[] | number[] | object[]): void
- Protected Members **
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from FLEXAdminSingleRun._error
- Defined in src/Model/DGUtility.m.ts:22

`Protected`_errorFunction

_errorFunction(errors: string[] | number[] | object[]): void
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from FLEXAdminSingleRun._errorFunction
- Defined in src/Model/DGUtility.m.ts:42

`Protected`_init

_init(): void
Initialize and perform setup for the class

Returns void
Inherited from FLEXAdminSingleRun._init
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:49

analyzeRuns

analyzeRuns(selectedIDs: number[]): Promise<boolean>
Analyze the runs and display the modal window
Parameters
- selectedIDs: number[]
  The indices of the selected runs
Returns Promise<boolean>
selectedIDs - The indices of the selected runs
Inherited from FLEXAdminSingleRun.analyzeRuns
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:229

avg

avg(arr: number[]): number
Averages an array of numbers
Parameters
- arr: number[]
  an array of numbers to average
Returns number
the average of the elements in the array
Inherited from FLEXAdminSingleRun.avg
- Defined in src/Model/DGUtility.m.ts:60

calculateIrregularity

calculateIrregularity(runIDs: number[], average?: boolean): LambdaResponse
Uses the RunDataTools Lambda to calculate irregularity for a set of runs
Parameters
- runIDs: number[]
- average: boolean = false
Returns LambdaResponse
the result of the irregularity calculation and run IDs
Inherited from FLEXAdminSingleRun.calculateIrregularity
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:291

convertCapitalizedStatname

convertCapitalizedStatname(stat: string): string
Convert a MACRO_CASE stat name to a capitalized string e.g., CONVERTED_STAT_NAME => Converted Stat Name
Parameters
- stat: string
Returns string
Inherited from FLEXAdminSingleRun.convertCapitalizedStatname
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:114

convertTitle

convertTitle(date: string): string
Convert a date string to a title string
Parameters
- date: string
  The date string to convert
Returns string
the converted title string
Inherited from FLEXAdminSingleRun.convertTitle
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:94

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
the result of the call to the uuid function
Inherited from FLEXAdminSingleRun.createID
- Defined in src/Model/DGElement.m.ts:30

deleteRun

deleteRun(runID: number): Promise<boolean>
Delete a run by ID
Parameters
- runID: number
  The ID of the run to delete
Returns Promise<boolean>
true if the run was deleted, false otherwise
Inherited from FLEXAdminSingleRun.deleteRun
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:81

deleteS3Object

deleteS3Object(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<boolean>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<boolean>
Inherited from FLEXAdminSingleRun.deleteS3Object
- Defined in src/Model/Databases/DGAmplify.m.ts:180

executeLambda

executeLambda(
functionName: string,
functionArgs: any,
): Promise<{ logs: string; result: string }>
Executes a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
- functionArgs: any
  The arguments to pass to the lambda function
Returns Promise<{ logs: string; result: string }>
- The API response or error
Inherited from FLEXAdminSingleRun.executeLambda
- Defined in src/Model/Databases/DGAmplify.m.ts:47

filterRunStats

filterRunStats(run: Run): [string, string | number | boolean][]
Filter the run stats for display
Parameters
- run: Run
  The run to filter
Returns [string, string | number | boolean][]
the filtered run stats
Inherited from FLEXAdminSingleRun.filterRunStats
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:141

generateColumnStatistics

generateColumnStatistics(data: Run[]): (string | number | boolean)[][]
Generate stats on run data (similar to column stats on desktop)
Parameters
- data: Run[]
  the runs to be analyzed
Returns (string | number | boolean)[][]
the statistics for each column
Inherited from FLEXAdminSingleRun.generateColumnStatistics
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:151

getDB

getDB(): Client
Returns Client
the value of the db private member

See
DGAmplifyTools
Inherited from FLEXAdminSingleRun.getDB
- Defined in src/Model/DGUtility.m.ts:66

getLambdaParams

getLambdaParams(functionName: string): Promise<{ logs: string; result: string }>
Get all the parameters for a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
Returns Promise<{ logs: string; result: string }>
See
this.executeLambda
Inherited from FLEXAdminSingleRun.getLambdaParams
- Defined in src/Model/Databases/DGAmplify.m.ts:110

getObjectPresignedUrl

getObjectPresignedUrl(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<string>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<string>
Inherited from FLEXAdminSingleRun.getObjectPresignedUrl
- Defined in src/Model/Databases/DGAmplify.m.ts:148

hasFullData

hasFullData(runID: number): Promise<boolean>
Check if the full data for a run is available. Note that most browsers will show a 403 error in the console if the data is not available.
Parameters
- runID: number
  The ID of the run to check
Returns Promise<boolean>
true if the full data is available, false otherwise
Inherited from FLEXAdminSingleRun.hasFullData
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:156

importEon3Data

importEon3Data(teamFieldID: number, deviceID: number): LambdaResponse
Import Eon 3 data from a folder
Parameters
- teamFieldID: number
  The ID of the team field to filter by
- deviceID: number
  The ID of the device to filter by
Returns LambdaResponse
The result of the import
Inherited from FLEXAdminSingleRun.importEon3Data
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:525

importLegacyData

importLegacyData(teamFieldID: number, fileList: FileList): Promise<boolean>
Parameters
- teamFieldID: number
- fileList: FileList
Returns Promise<boolean>
Inherited from FLEXAdminSingleRun.importLegacyData
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:562

isNumeric

isNumeric(n: string): boolean
Parameters
- n: string
Returns boolean
Inherited from FLEXAdminSingleRun.isNumeric
- Defined in src/Model/DGUtility.m.ts:90

listDevices

listDevices(teamID: number): Promise<Device[]>
Parameters
- teamID: number
Returns Promise<Device[]>
Inherited from FLEXAdminSingleRun.listDevices
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:266

listTeamFields

listTeamFields(fieldID: number): Promise<TeamField[]>
Parameters
- fieldID: number
Returns Promise<TeamField[]>
Inherited from FLEXAdminSingleRun.listTeamFields
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:248

loadFromS3

loadFromS3(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<string>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<string>
Inherited from FLEXAdminSingleRun.loadFromS3
- Defined in src/Model/Databases/DGAmplify.m.ts:119

loadFullRunData

loadFullRunData(
url: string,
completion: (m: (string | number | boolean)[][]) => void,
): Promise<void>
Load the full data for a run from S3
Parameters
- url: string
  The URL of the full data
- completion: (m: (string | number | boolean)[][]) => void
  The completion handler
Returns Promise<void>
use the completion handler and this.#fullRunData
Inherited from FLEXAdminSingleRun.loadFullRunData
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:189

loadFullRunDataURL

loadFullRunDataURL(runID: number): Promise<string>
Load the full data URL for a run from S3
Parameters
- runID: number
  The ID of the run to load
Returns Promise<string>
the URL of the full data
Inherited from FLEXAdminSingleRun.loadFullRunDataURL
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:173

loadRun

loadRun(runID: number): Promise<Run>
Load a run from the database by ID
Parameters
- runID: number
  The ID of the run to load
Returns Promise<Run>
the run object
Inherited from FLEXAdminSingleRun.loadRun
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:70

loadRuns

loadRuns(
    fieldID?: number,
    teamFieldID?: number,
    deviceID?: number,
): Promise<RunConnection>
Load runs from the database
Parameters
- fieldID: number = 0
  The ID of the field to filter by
- teamFieldID: number = 0
  The ID of the team field to filter by
- deviceID: number = 0
  The ID of the device to filter by
Returns Promise<RunConnection>
the list of runs
Inherited from FLEXAdminSingleRun.loadRuns
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:383

parseConfigurationData

parseConfigurationData(run: Run): [string, string | number | boolean][]
Parse the configuration data from a run
Parameters
- run: Run
  The run to parse
Returns [string, string | number | boolean][]
the parsed configuration data
Inherited from FLEXAdminSingleRun.parseConfigurationData
- Defined in src/ViewModel/FLEXAdminSingleRun.vm.ts:124

processZip

processZip(
fileObject: { file: object; key: string },
): Promise<{ file: { name: string }; key: string }>
Parameters
- fileObject: { file: object; key: string }
Returns Promise<{ file: { name: string }; key: string }>
Inherited from FLEXAdminSingleRun.processZip
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:638

runsLoadedForPage

runsLoadedForPage(page: number, itemsPerPage: number): boolean
Check if runs have been loaded for the current page
Parameters
- page: number
  The current page
- itemsPerPage: number
  The number of items per page
Returns boolean
true if the runs have been loaded, false otherwise
Inherited from FLEXAdminSingleRun.runsLoadedForPage
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:122

runsToDict

runsToDict(runs: RunConnection): { [ID: string]: Run }
Convert a RunConnection to a dictionary of ID: Run
Parameters
- runs: RunConnection
Returns { [ID: string]: Run }
Inherited from FLEXAdminSingleRun.runsToDict
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:107

s3ObjectExists

s3ObjectExists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
Inherited from FLEXAdminSingleRun.s3ObjectExists
- Defined in src/Model/Databases/DGAmplify.m.ts:165

saveToS3

saveToS3(path: string, data: File): Promise<boolean>
Parameters
- path: string
- data: File
Returns Promise<boolean>
Inherited from FLEXAdminSingleRun.saveToS3
- Defined in src/Model/Databases/DGAmplify.m.ts:133

searchRuns

searchRuns(needle: string, filters: string[], fieldID: number): LambdaResponse
Uses the RunDataTools Lambda to calculate irregularity for a set of runs
Parameters
- needle: string
  The search term to filter runs by
- filters: string[]
  The filters to apply to the search (Run columns)
- fieldID: number
Returns LambdaResponse
the result of the irregularity calculation and run IDs
Inherited from FLEXAdminSingleRun.searchRuns
- Defined in src/ViewModel/FLEXAdminAllRuns.vm.ts:341

Class FLEXRunData

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FLEXRunData

Properties

Protected_ctx

Member

Accessors

amplify

Returns Client

Parameters

Returns void

analyzedStats

Returns (string | number | boolean)[][]

ctx

Returns FLEXContextVariables

Parameters

Returns void

currentIrregularity

Returns string

errorFunction

Parameters

Returns void

FULL_DATA_TABLE_ROWS

Returns number

fullRunData

Returns (string | number | boolean)[][]

irregularityCalculatedFor

Returns string

itemsPerPage

Returns number

Parameters

Returns void

MAX_EON_3_UPLOAD_SIZE

Returns number

page

Returns number

Parameters

Returns void

Methods

Protected_error

Parameters

Returns void

Protected_errorFunction

Parameters

Returns void

Protected_init

Returns void

analyzeRuns

Parameters

Returns Promise<boolean>

avg

Parameters

Returns number

calculateIrregularity

Parameters

Returns LambdaResponse

convertCapitalizedStatname

Parameters

Returns string

convertTitle

Parameters

Returns string

createID

Returns string | number[]

deleteRun

Parameters

Returns Promise<boolean>

deleteS3Object

Parameters

Parameters

Returns void

Returns Promise<boolean>

executeLambda

`Protected`_ctx

`Protected`_error

`Protected`_errorFunction

`Protected`_init