Class FLEXFieldEditor

Hierarchy (View Summary)

default
- FLEXFieldEditor

Index

Constructors

constructor

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

Returns FLEXFieldEditor
Overrides default.constructor
- Defined in ViewModel/FLEXFieldEditor.vm.ts:218

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

`Protected`_errorFunction

_errorFunction: (errors: string[] | number[] | object[]) => void = console.error

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:84
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:72

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:80
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:76

errorFunction

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

previousUploadedImageName

get previousUploadedImageName(): string
Returns string
- Defined in ViewModel/FLEXFieldEditor.vm.ts:223

temporaryFieldURL

get temporaryFieldURL(): string
Returns string
- Defined in ViewModel/FLEXFieldEditor.vm.ts:227
set temporaryFieldURL(value: string): void
Parameters
- value: string
Returns void
- Defined in ViewModel/FLEXFieldEditor.vm.ts:231

Methods

`Protected`_error

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

`Protected`_init

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

Returns void
Overrides default._init
- Defined in ViewModel/FLEXFieldEditor.vm.ts:44

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 default.avg
- Defined in Model/DGUtility.m.ts:58

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 default.createID
- Defined in Model/DGElement.m.ts:30

getDB

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

See
DGAmplifyTools
Inherited from default.getDB
- Defined in Model/DGUtility.m.ts:64

isNumeric

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

loadInfillTypes

loadInfillTypes(): Promise<InfillType[]>
Returns Promise<InfillType[]>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:207

processImage

processImage(
fileObject: { file: File; key: string },
): Promise<{ file: File; key: string }>
Parameters
- fileObject: { file: File; key: string }
Returns Promise<{ file: File; key: string }>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:82

propertiesForImage

propertiesForImage(
    imageURL: string,
    handleError?: {
        (...data: any[]): void;
        (message?: any, ...optionalParams: any[]): void;
    },
): Promise<GetPropertiesWithPathOutput>
Parameters
- imageURL: string
- handleError: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void } = console.error
  - (...data: any[]): void
    
    The console.error() static method outputs a message to the console at the "error" log level. The message is only displayed to the user if the console is configured to display error output. In most cases, the log level is configured within the console UI. The message may be formatted as an error, with red colors and call stack information.
    
    MDN Reference
    
    Parameters
    
    ...data: any[]
    
    Returns void
    
    (message?: any, ...optionalParams: any[]): void
    
    Parameters
    
    Optionalmessage: any
    
    ...optionalParams: any[]
    
    Returns void
Returns Promise<GetPropertiesWithPathOutput>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:104

removeImage

removeImage(
    imageURL: string,
    bucketPrefix?: string,
    urlIncludesPrefix?: boolean,
    handleError?: {
        (...data: any[]): void;
        (message?: any, ...optionalParams: any[]): void;
    },
): Promise<boolean>
Parameters
- imageURL: string
- bucketPrefix: string = "public"
- urlIncludesPrefix: boolean = false
- handleError: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void } = console.error
  - (...data: any[]): void
    
    The console.error() static method outputs a message to the console at the "error" log level. The message is only displayed to the user if the console is configured to display error output. In most cases, the log level is configured within the console UI. The message may be formatted as an error, with red colors and call stack information.
    
    MDN Reference
    
    Parameters
    
    ...data: any[]
    
    Returns void
    
    (message?: any, ...optionalParams: any[]): void
    
    Parameters
    
    Optionalmessage: any
    
    ...optionalParams: any[]
    
    Returns void
Returns Promise<boolean>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:63

setFieldImageURL

setFieldImageURL(
updateFieldInput: Field,
fieldImageURL: string,
): Promise<GraphQLResult<NeverEmpty<UpdateFieldMutation>>>
- Public Methods **
Parameters
- updateFieldInput: Field
- fieldImageURL: string
Returns Promise<GraphQLResult<NeverEmpty<UpdateFieldMutation>>>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:51

uploadImage

uploadImage(
    image: File,
    bucketPrefix?: string,
    onProgress?: {
        (...data: any[]): void;
        (message?: any, ...optionalParams: any[]): void;
    },
    handleError?: {
        (...data: any[]): void;
        (message?: any, ...optionalParams: any[]): void;
    },
): Promise<string>
Parameters
- image: File
- bucketPrefix: string = "public"
- onProgress: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void } = console.log
  - (...data: any[]): void
    
    The console.log() static method outputs a message to the console.
    
    MDN Reference
    
    Parameters
    
    ...data: any[]
    
    Returns void
    
    (message?: any, ...optionalParams: any[]): void
    
    Parameters
    
    Optionalmessage: any
    
    ...optionalParams: any[]
    
    Returns void
- handleError: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void } = console.error
  - (...data: any[]): void
    
    The console.error() static method outputs a message to the console at the "error" log level. The message is only displayed to the user if the console is configured to display error output. In most cases, the log level is configured within the console UI. The message may be formatted as an error, with red colors and call stack information.
    
    MDN Reference
    
    Parameters
    
    ...data: any[]
    
    Returns void
    
    (message?: any, ...optionalParams: any[]): void
    
    Parameters
    
    Optionalmessage: any
    
    ...optionalParams: any[]
    
    Returns void
Returns Promise<string>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:134

urlForImage

urlForImage(
    imageURL: string,
    handleError?: {
        (...data: any[]): void;
        (message?: any, ...optionalParams: any[]): void;
    },
): Promise<StorageGetUrlOutput>
Parameters
- imageURL: string
- handleError: { (...data: any[]): void; (message?: any, ...optionalParams: any[]): void } = console.error
  - (...data: any[]): void
    
    The console.error() static method outputs a message to the console at the "error" log level. The message is only displayed to the user if the console is configured to display error output. In most cases, the log level is configured within the console UI. The message may be formatted as an error, with red colors and call stack information.
    
    MDN Reference
    
    Parameters
    
    ...data: any[]
    
    Returns void
    
    (message?: any, ...optionalParams: any[]): void
    
    Parameters
    
    Optionalmessage: any
    
    ...optionalParams: any[]
    
    Returns void
Returns Promise<StorageGetUrlOutput>
- Defined in ViewModel/FLEXFieldEditor.vm.ts:119

Class FLEXFieldEditor

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FLEXFieldEditor

Properties

Protected_ctx

Member

Protected_errorFunction

Accessors

amplify

Returns Client

Parameters

Returns void

ctx

Returns FLEXContextVariables

Parameters

Returns void

errorFunction

Parameters

Returns void

previousUploadedImageName

Returns string

temporaryFieldURL

Returns string

Parameters

Returns void

Methods

Protected_error

Parameters

Returns void

Protected_init

Returns void

avg

Parameters

Returns number

createID

Returns string | number[]

getDB

Returns Client

See

isNumeric

Parameters

Returns boolean

loadInfillTypes

Returns Promise<InfillType[]>

processImage

Parameters

Returns Promise<{ file: File; key: string }>

propertiesForImage

Parameters

Parameters

Returns void

Parameters

Returns void

Returns Promise<GetPropertiesWithPathOutput>

removeImage

Parameters

Parameters

Returns void

Parameters

Returns void

Returns Promise<boolean>

setFieldImageURL

Parameters

Returns Promise<GraphQLResult<NeverEmpty<UpdateFieldMutation>>>

uploadImage

Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

`Protected`_ctx

`Protected`_errorFunction

`Protected`_error

`Protected`_init