Class CollectionChartContext<S, N>

Type Parameters

S extends TSchema = TSchema
N extends TCollectionName<S> = TCollectionName<S>

Hierarchy (View Summary)

CollectionCustomizationContext<S, N>
- CollectionChartContext

Index

Constructors

constructor

new CollectionChartContext<
    S extends TSchema = TSchema,
    N extends string = TCollectionName<S>,
>(
    collection: Collection,
    caller: Caller,
    recordId: CompositeId,
    parameters?: Record<string, string>,
): CollectionChartContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = TCollectionName<S>
Parameters
- collection: Collection
- caller: Caller
- recordId: CompositeId
- Optionalparameters: Record<string, string>
Returns CollectionChartContext<S, N>
Overrides CollectionCustomizationContext.constructor
- Defined in datasource-customizer/dist/decorators/chart/context.d.ts:9

Properties

`Readonly`compositeRecordId

compositeRecordId: CompositeId

`Protected`realCollection

realCollection: Collection

Accessors

caller

get caller(): Readonly<Caller>
Returns Readonly<Caller>
Inherited from CollectionCustomizationContext.caller
- Defined in datasource-customizer/dist/context/agent-context.d.ts:9

collection

get collection(): RelaxedCollection<S, N>
Returns RelaxedCollection<S, N>
Inherited from CollectionCustomizationContext.collection
- Defined in datasource-customizer/dist/context/collection-context.d.ts:7

dataSource

get dataSource(): RelaxedDataSource<S>
Returns RelaxedDataSource<S>
Inherited from CollectionCustomizationContext.dataSource
- Defined in datasource-customizer/dist/context/agent-context.d.ts:7

parameters

get parameters(): Record<string, string>
Returns Record<string, string>
- Defined in datasource-customizer/dist/decorators/chart/context.d.ts:8

recordId

get recordId(): string | number
Returns string | number
- Defined in datasource-customizer/dist/decorators/chart/context.d.ts:7

Methods

getRecord

getRecord(fields: TFieldName<S, N>[]): Promise<TRow<S, N>>
Parameters
- fields: TFieldName<S, N>[]
Returns Promise<TRow<S, N>>
- Defined in datasource-customizer/dist/decorators/chart/context.d.ts:10

throwError

throwError(message: string): never
Stop hooks execution and send error to the UI
Parameters
- message: string
  the error message
Returns never
Example
```
.throwError('My error message');
```
Inherited from CollectionCustomizationContext.throwError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:30

throwForbiddenError

throwForbiddenError(message: string): never
Stop hooks execution and send Forbidden error to the UI
Parameters
- message: string
  the forbidden error message
Returns never
Example
```
.throwForbiddenError('My forbidden error message');
```
Inherited from CollectionCustomizationContext.throwForbiddenError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:23

throwValidationError

throwValidationError(message: string): never
Stop hooks execution and send Validation error to the UI
Parameters
- message: string
  the validation error message
Returns never
Example
```
.throwValidationError('My validation error message');
```
Inherited from CollectionCustomizationContext.throwValidationError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:16

Class CollectionChartContext<S, N>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionChartContext<S, N>

Properties

ReadonlycompositeRecordId

ProtectedrealCollection

Accessors

caller

Returns Readonly<Caller>

collection

Returns RelaxedCollection<S, N>

dataSource

Returns RelaxedDataSource<S>

parameters

Returns Record<string, string>

recordId

Returns string | number

Methods

getRecord

Parameters

Returns Promise<TRow<S, N>>

throwError

Parameters

Returns never

Example

throwForbiddenError

Parameters

Returns never

Example

throwValidationError

Parameters

Returns never

Example

Settings

On This Page

`Readonly`compositeRecordId

`Protected`realCollection