Powered by Zoomin Software. For more details please contactZoomin

Data Inspector Library - API Reference

Product category
Technology
Doc type
Version
Product lifecycle
This publication

Data Inspector Library - API Reference: PluginError | Data Inspector Library API Reference

Table of Contents

PluginError | Data Inspector Library API Reference

The PluginError class represents an error during data processing via a GeoJSON plugin; contains several typical error messages.

Hierarchy

Index

Constructors

constructor

  • new PluginError(key: string, payload?: object): PluginError
  • A default constructor.

    Parameters

    • key: string

      Translation key.

    • Optional payload: object

      Additional data of the translated string. Optional.

    Returns PluginError

Properties

Readonly Static INVALID_RESULT

INVALID_RESULT: "olpdi.interactiveDS.plugin-error.invalid-result" = "olpdi.interactiveDS.plugin-error.invalid-result"

A message for a malformed result from the renderer plugin.

Readonly Static LOAD_RENDERER_PLUGIN_FAILURE

LOAD_RENDERER_PLUGIN_FAILURE: "olpdi.interactiveDS.plugin-error.load-fail" = "olpdi.interactiveDS.plugin-error.load-fail"

A message when failed to load the renderer plugin.

Readonly Static RENDERER_PLUGIN_ERROR

RENDERER_PLUGIN_ERROR: "olpdi.interactiveDS.plugin-error.processing-fail" = "olpdi.interactiveDS.plugin-error.processing-fail"

A message for an error while processing the renderer plugin.

Readonly Static RENDERER_PLUGIN_ERROR_BOTH_METHODS

RENDERER_PLUGIN_ERROR_BOTH_METHODS: "olpdi.interactiveDS.plugin-error.implementation-error" = "olpdi.interactiveDS.plugin-error.implementation-error"

A message for the renderer plugin implementation errors.

Readonly Static RENDERER_PLUGIN_MISSING

RENDERER_PLUGIN_MISSING: "olpdi.interactiveDS.plugin-error.plugin-missing" = "olpdi.interactiveDS.plugin-error.plugin-missing"

A message for a case when a renderer plugin is missing.

Readonly Static RENDERER_PLUGIN_MISSING_IN_SCHEMA

RENDERER_PLUGIN_MISSING_IN_SCHEMA: "olpdi.interactiveDS.plugin-error.plugin-missing-in-schema" = "olpdi.interactiveDS.plugin-error.plugin-missing-in-schema"

A message for a case when a renderer plugin is missing in schema.

Readonly Static RUNTIME_ERROR

RUNTIME_ERROR: "olpdi.interactiveDS.plugin-error.runtime-error" = "olpdi.interactiveDS.plugin-error.runtime-error"

A message for a runtime error in the renderer plugin.

Readonly Static SYNTAX_ERROR

SYNTAX_ERROR: "olpdi.interactiveDS.plugin-error.syntax-error" = "olpdi.interactiveDS.plugin-error.syntax-error"

A message for a syntax error in the renderer plugin.

Accessors

payload

  • get payload(): undefined | object
  • Returns an additional data of the translated string or undefined.

    Returns undefined | object

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Class
  • Class with type parameter
  • Enumeration
  • Inherited constructor
  • Static property
Was this article helpful?
TitleResults for “How to create a CRG?”Also Available inAlert