trueChart Core API
interface

IActionsFeature Actions feature interface

Hierarchy

  • IActionsFeature

Index

Properties

Properties

Optional customActionParameters

customActionParameters: undefined | string

Parameters which the "Custom" action implimentation will provide. Optional/Required: If you implement the "Custom" action, then you also have to provide it's function parameters. Otherwise this will result in a warning in core version < 3.0 or an error in core version >= 3.0

example

'$, element, event, clickInfo'

execute

execute: Partial<IActionImplementations>

Implementation of the actions supported by the application

preventActions

preventActions: function

In some cases actions may be not permitted (i.e. in edit mode), this method must return true in such cases. Optional: If omitted, it will be replaced by a default implementation.

Type declaration

supports

supports: function

Internally defined function. Returns true when given action(s) are defined in execute object. Optional: If omitted, it will be replaced by a default implementation.

Type declaration

    • (actionName: string | string[]): boolean

    • Parameters

      • actionName: string | string[]

      Returns boolean

Optional unsupported

unsupported: TActionNames[]

List of explicitly unsupported actions Actions listed in this property must be either implemented nor added as supported action

Optional unsupportedParameters

unsupportedParameters: Partial<object>

List of action names and corresponding parameter names which are unsupported and therefore should be omitted in the settings UI. If not defined, no restrictions will be applied and all parameters will be part within the settings UI.