Class QBReport<RecordData, CustomGetSet>

Type Parameters

RecordData extends QBRecordData = QBRecordData
CustomGetSet extends Object = Record<any, any>

Hierarchy

QBReport

Index

Constructors

constructor

new QBReport<RecordData, CustomGetSet>(options?: Partial<QBReportOptions<RecordData>>): QBReport<RecordData, CustomGetSet>
Type Parameters
- RecordData extends QBRecordData = QBRecordData
- CustomGetSet extends Object = Record<any, any>
Parameters
- Optional options: Partial<QBReportOptions<RecordData>>
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:72

Properties

`Readonly` CLASS_NAME

CLASS_NAME: "QBReport" = 'QBReport'

`Private` _data

_data: Record<any, any> = {}

`Private` _fids

_fids: Record<any, number> = {}

`Private` _fields

_fields: QBField<Record<any, any>>[] = []

`Private` _qb

_qb: QuickBase

`Private` _records

_records: QBRecord<RecordData>[] = []

`Private` _reportId

_reportId: string = ''

`Private` _tableId

_tableId: string = ''

id

id: string

An internal id (guid) used for tracking/managing object instances

`Static` `Readonly` CLASS_NAME

CLASS_NAME: "QBReport" = 'QBReport'

`Static` `Readonly` VERSION

VERSION: string = VERSION

The loaded library version

`Static` defaults

defaults: QBReportOptions<{}> = ...

The default settings of a QuickBase instance

Methods

`Private` _buildRecord

_buildRecord(record: Record<string, {
value: any;
}>): QBRecord<RecordData>
Parameters
- record: Record<string, {
 value: any;
 }>
Returns QBRecord<RecordData>
- Defined in qb-report.ts:98

clear

clear(): QBReport<RecordData, CustomGetSet>
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:123

fromJSON

fromJSON(json: string | QBReportJSON): QBReport<RecordData, CustomGetSet>
Rebuild the QBRecord instance from serialized JSON
Parameters
- json: string | QBReportJSON
 
 QBRecord serialized JSON
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:442

get

get(attribute: "tableId"): string
Parameters
- attribute: "tableId"
Returns string
- Defined in qb-report.ts:131
get(attribute: "reportId"): string
Parameters
- attribute: "reportId"
Returns string
- Defined in qb-report.ts:132
get(attribute: P): QuickBaseResponseGetReport[P]
Type Parameters
- P extends keyof QuickBaseResponseGetReport
Parameters
- attribute: P
Returns QuickBaseResponseGetReport[P]
- Defined in qb-report.ts:133
get(attribute: P): CustomGetSet[P]
Type Parameters
- P extends string | number | symbol
Parameters
- attribute: P
Returns CustomGetSet[P]
- Defined in qb-report.ts:134
get(attribute: P): P extends keyof QuickBaseResponseGetReport ? QuickBaseResponseGetReport[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
Type Parameters
- P extends string
Parameters
- attribute: P
Returns P extends keyof QuickBaseResponseGetReport ? QuickBaseResponseGetReport[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
- Defined in qb-report.ts:135

getFid

getFid<T>(field: T): number
Type Parameters
- T extends string | number | symbol
Parameters
- field: T
Returns number
- Defined in qb-report.ts:147
getFid(field: number, byId?: true): string
Parameters
- field: number
- Optional byId: true
Returns string
- Defined in qb-report.ts:148
getFid(field: string | number, byId?: false): number
Parameters
- field: string | number
- Optional byId: false
Returns number
- Defined in qb-report.ts:149

getFids

getFids(): QBFids<RecordData>
Returns QBFids<RecordData>
- Defined in qb-report.ts:176

getField

getField(id: number, returnIndex: true): undefined | number
Parameters
- id: number
- returnIndex: true
Returns undefined | number
- Defined in qb-report.ts:180
getField(id: number, returnIndex?: false): undefined | QBField<Record<any, any>>
Parameters
- id: number
- Optional returnIndex: false
Returns undefined | QBField<Record<any, any>>
- Defined in qb-report.ts:181

getFields

getFields(): QBField<Record<any, any>>[]
Returns QBField<Record<any, any>>[]
- Defined in qb-report.ts:196

getFormulaFields

getFormulaFields(): QBField<Record<any, any>>[]
Returns QBField<Record<any, any>>[]
- Defined in qb-report.ts:200

getNRecords

getNRecords(): number
Returns number
- Defined in qb-report.ts:206

getRecord

getRecord<T>(value: RecordData[T], fieldName: T, returnIndex: true): number
Type Parameters
- T extends string | number | symbol
Parameters
- value: RecordData[T]
- fieldName: T
- returnIndex: true
Returns number
- Defined in qb-report.ts:210
getRecord<T>(value: RecordData[T], fieldName: T, returnIndex?: false): undefined | QBRecord<RecordData>
Type Parameters
- T extends string | number | symbol
Parameters
- value: RecordData[T]
- fieldName: T
- Optional returnIndex: false
Returns undefined | QBRecord<RecordData>
- Defined in qb-report.ts:211
getRecord(value: any, fieldName: string, returnIndex: true): number
Parameters
- value: any
- fieldName: string
- returnIndex: true
Returns number
- Defined in qb-report.ts:212
getRecord(value: any, fieldName: string, returnIndex: false): undefined | QBRecord<RecordData>
Parameters
- value: any
- fieldName: string
- returnIndex: false
Returns undefined | QBRecord<RecordData>
- Defined in qb-report.ts:213

getRecords

getRecords(): QBRecord<RecordData>[]
Returns QBRecord<RecordData>[]
- Defined in qb-report.ts:238

getReportId

getReportId(): string
Returns string
- Defined in qb-report.ts:242

getTableId

getTableId(): string
Returns string
- Defined in qb-report.ts:246

getTempToken

getTempToken(__namedParameters?: QuickBaseRequest): Promise<void>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<void>
- Defined in qb-report.ts:250

load

load(__namedParameters?: QuickBaseRequest): Promise<QuickBaseResponseGetReport>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<QuickBaseResponseGetReport>
- Defined in qb-report.ts:257

run

run(__namedParameters?: QBReportRunRequest): Promise<QBReportRunResponse<RecordData>>
Parameters
- __namedParameters: QBReportRunRequest = {}
Returns Promise<QBReportRunResponse<RecordData>>
- Defined in qb-report.ts:320

set

set(attribute: "tableId", value: string): QBReport<RecordData, CustomGetSet>
Parameters
- attribute: "tableId"
- value: string
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:391
set(attribute: "reportId", value: number): QBReport<RecordData, CustomGetSet>
Parameters
- attribute: "reportId"
- value: number
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:392
set(attribute: P, value: QuickBaseResponseGetReport[P]): QBReport<RecordData, CustomGetSet>
Type Parameters
- P extends keyof QuickBaseResponseGetReport
Parameters
- attribute: P
- value: QuickBaseResponseGetReport[P]
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:393
set(attribute: P, value: CustomGetSet[P]): QBReport<RecordData, CustomGetSet>
Type Parameters
- P extends string | number | symbol
Parameters
- attribute: P
- value: CustomGetSet[P]
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:394
set(attribute: P, value: P extends keyof QuickBaseResponseGetReport ? QuickBaseResponseGetReport[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any): QBReport<RecordData, CustomGetSet>
Type Parameters
- P extends string
Parameters
- attribute: P
- value: P extends keyof QuickBaseResponseGetReport ? QuickBaseResponseGetReport[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:395

setFid

setFid<T>(name: T, id: number): QBReport<RecordData, CustomGetSet>
Type Parameters
- T extends string | number | symbol
Parameters
- name: T
- id: number
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:415
setFid(name: string | number, id: number): QBReport<RecordData, CustomGetSet>
Parameters
- name: string | number
- id: number
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:416

setFids

setFids(fields: Record<any, number>): QBReport<RecordData, CustomGetSet>
Parameters
- fields: Record<any, number>
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:423

setReportId

setReportId(reportId: string): QBReport<RecordData, CustomGetSet>
Parameters
- reportId: string
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:431

setTableId

setTableId(tableId: string): QBReport<RecordData, CustomGetSet>
Parameters
- tableId: string
Returns QBReport<RecordData, CustomGetSet>
- Defined in qb-report.ts:409

toJSON

toJSON(): QBReportJSON
Serialize the QBReport instance into JSON

Returns QBReportJSON
- Defined in qb-report.ts:485

`Static` IsQBReport

IsQBReport<T, K>(obj: any): obj is QBReport<T, K>
Test if a variable is a qb-report object
Type Parameters
- T extends QBRecordData = QBRecordData
- K extends Object = Record<any, any>
Parameters
- obj: any
 
 A variable you'd like to test
Returns obj is QBReport<T, K>
- Defined in qb-report.ts:522

`Static` fromJSON

fromJSON(json: string | QBReportJSON): QBReport<QBRecordData, Record<any, any>>
Create a new QBReport instance from serialized JSON
Parameters
- json: string | QBReportJSON
 
 QBReport serialized JSON
Returns QBReport<QBRecordData, Record<any, any>>
- Defined in qb-report.ts:503

Class QBReport<RecordData, CustomGetSet>

Type Parameters

RecordData extends QBRecordData = QBRecordData

CustomGetSet extends Object = Record<any, any>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

RecordData extends QBRecordData = QBRecordData

CustomGetSet extends Object = Record<any, any>

Parameters

Optional options: Partial<QBReportOptions<RecordData>>

Returns QBReport<RecordData, CustomGetSet>

Properties

Readonly CLASS_NAME

Private _data

Private _fids

Private _fields

Private _qb

Private _records

Private _reportId

Private _tableId

id

Static Readonly CLASS_NAME

Static Readonly VERSION

Static defaults

Methods

Private _buildRecord

Parameters

record: Record<string, { value: any; }>

Returns QBRecord<RecordData>

clear

Returns QBReport<RecordData, CustomGetSet>

fromJSON

Parameters

json: string | QBReportJSON

Returns QBReport<RecordData, CustomGetSet>

get

Parameters

attribute: "tableId"

Returns string

Parameters

attribute: "reportId"

Returns string

Type Parameters

P extends keyof QuickBaseResponseGetReport

Parameters

attribute: P

Returns QuickBaseResponseGetReport[P]

Type Parameters

P extends string | number | symbol

Parameters

attribute: P

Returns CustomGetSet[P]

Type Parameters

P extends string

Parameters

attribute: P

Returns P extends keyof QuickBaseResponseGetReport ? QuickBaseResponseGetReport[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any

getFid

Type Parameters

T extends string | number | symbol

Parameters

field: T

Returns number

Parameters

field: number

Optional byId: true

Returns string

Parameters

field: string | number

Optional byId: false

Returns number

getFids

Returns QBFids<RecordData>

getField

`Optional` options: Partial<QBReportOptions<RecordData>>

`Readonly` CLASS_NAME

`Private` _data

`Private` _fids

`Private` _fields

`Private` _qb

`Private` _records

`Private` _reportId

`Private` _tableId

`Static` `Readonly` CLASS_NAME

`Static` `Readonly` VERSION

`Static` defaults

`Private` _buildRecord

record: Record<string, {
value: any;
}>

`Optional` byId: true

`Optional` byId: false

`Optional` returnIndex: false

`Optional` returnIndex: false