IElementsQueryResult
Paged result of valid element query. Last page of data returns empty items.
export interface IElementsQueryResult extends IPagedResource<IAttributeElement>
Extends: IPagedResource<IAttributeElement>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (Optional) Number format to apply to the element values. |
Methods
Method | Description |
|---|---|
Requested page of the elements; carries the same number format. | |
Next page of the elements; carries the same number format. |
Property details
IElementsQueryResult.numberFormatproperty
Number format to apply to the element values.
readonly numberFormat?: string;
Remarks
Uses the same format specification as measure formats. Present for numeric computed attributes; the backend applies no formatting itself, the client formats the element titles with it and the workspace separators, the same way it formats measure values. Absent for every other attribute.
Method details
IElementsQueryResult.goTo()method
Requested page of the elements; carries the same number format.
goTo(pageIndex: number): Promise<IElementsQueryResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
pageIndex | number |
Returns
Promise<IElementsQueryResult>
IElementsQueryResult.next()method
Next page of the elements; carries the same number format.
next(): Promise<IElementsQueryResult>;
Returns
Promise<IElementsQueryResult>