Type Alias AttributeHandler

AttributeHandler: (
    attr: DeepReadonly<ObjectAttribute>,
    objInfo: DeepReadonly<ObjectAttrInfo>,
    dataPath: string | null,
    onfinish?: AttributeOnLoad,
) => AttributeHandlerResult | Promise<AttributeHandlerResult>

Handler that is called whenever the attribute for which the handler was registered needs to be displayed in tabular form like in the InfoWindow or Balloon Window (see PluginAPI.SetAttributeHandler).

Type declaration

- (
      attr: DeepReadonly<ObjectAttribute>,
      objInfo: DeepReadonly<ObjectAttrInfo>,
      dataPath: string | null,
      onfinish?: AttributeOnLoad,
  ): AttributeHandlerResult | Promise<AttributeHandlerResult>
- Parameters
  - attr: DeepReadonly<ObjectAttribute>
    the attribute for which the current handler is responsible.
  - objInfo: DeepReadonly<ObjectAttrInfo>
    information about the object to which the attributes belong.
  - dataPath: string | null
    the path to the EDB on the server. This path is needed when additional resources (like images or videos) need to be loaded.
  - Optionalonfinish: AttributeOnLoad
    function to be called when asynchronous loading of additional resources is finished. This function typically resizes the attribute window in case it is too narrow for the asynchronously retrieved resource.
  Returns AttributeHandlerResult | Promise<AttributeHandlerResult>
  entries for the info and balloon window

Remarks

To support sorting the attribute entries alphabetically (see Config.sortAttributes), the handler should add a property "data-sort-key" to each returned table row (the <tr> tag); this property holds the sort key in lowercase letters. Rows with the same key keep their relative order.

Type Alias AttributeHandler

Type declaration

Parameters

Returns AttributeHandlerResult | Promise<AttributeHandlerResult>

Remarks

Settings