Interface
A data record represents a record in a data source.
Properties
Property | Type | Notes |
---|---|---|
clone | (deep?: boolean) => DataRecord | Create a clone of the data record object.
Use shallow clone by default. If |
dataSource | DataSource | A reference of the data source object that has this record. |
getData | () => any | The data is a plain object. The format is {key: value}, and the key is "jimuFieldName". |
getFieldValue | (jimuFieldName: string) => any | Return the value of a specific field. |
getFormattedData | (intl: IntlShape) => any | Return formatted record. |
getFormattedFieldValue | (jimuFieldName: string, intl: IntlShape) => string | Return the formatted value of a specific field. |
getGeometry | () => IGeometry | Return geometry of the record. |
getId | () => string | Return ID of the record. |
setId | (id: string) => void | Set ID of the record. |
toJson | () => any | Return the data in JSON format, which is used to serialize data, and the key is "jimuFieldName". |
clone
Interface Propertyclone: (deep?: boolean) => DataRecord
Create a clone of the data record object.
Use shallow clone by default. If deep
is true
, will use deep clone.
Type declaration
function(deep?: boolean): DataRecord
Parameters
Parameter | Type |
---|---|
deep | boolean |
Returns
DataRecord
dataSource
Interface PropertydataSource: DataSource
A reference of the data source object that has this record.
getData
Interface PropertygetData: () => any
The data is a plain object. The format is {key: value}, and the key is "jimuFieldName".
The data before mapping use this schema: {fieldName: value}. We need to return this schema: {jimuFieldName: value}.
Type declaration
function(): any
Returns
any
getFieldValue
Interface PropertygetFieldValue: (jimuFieldName: string) => any
Return the value of a specific field.
Type declaration
function(jimuFieldName: string): any
Parameters
Parameter | Type |
---|---|
jimu | string |
Returns
any
getFormattedData
Interface PropertygetFormattedData: (intl: IntlShape) => any
Return formatted record.
Type declaration
function(intl: IntlShape): any
Parameters
Parameter | Type |
---|---|
intl | IntlShape |
Returns
any
getFormattedFieldValue
Interface PropertygetFormattedFieldValue: (jimuFieldName: string, intl: IntlShape) => string
Return the formatted value of a specific field.
Type declaration
function(jimuFieldName: string, intl: IntlShape): string
Parameters
Parameter | Type |
---|---|
jimu | string |
intl | IntlShape |
Returns
string
getGeometry
Interface PropertygetGeometry: () => IGeometry
Return geometry of the record.
Type declaration
function(): IGeometry
Returns
IGeometry
getId
Interface PropertygetId: () => string
Return ID of the record.
Type declaration
function(): string
Returns
string