Nebula Scatter plot plugins

Scatter plot plugins API definitions

Download specification

experimental

pluginArguments namespace

The arguments that are passed to the fn function of the plugin definition. For example, the layout and keys in the following plugin: const pointPlugin = { info: { name: 'point-plugin', type: 'component-definition', }, fn: ({ layout, keys }) => { const componentDefinition = { key: keys.components.point, type: 'point', settings: { // Some new settings that make use of // the data in layout and keys }, }; return componentDefinition; }, ;

Properties

  • keys object
    Required

    The keys (references) to different types of chart internals

    Show keys properties
    • COMPONENT object
      Required

      The unique keys of the existing components available in the chart. They are useful if you want to extend or override the existing components.

      Show COMPONENT properties
      • POINT string
        Required

        The point component

      • X_AXIS string
        Required

        The x-axis component

      • Y_AXIS string
        Required

        The y-axis component
    • SCALE object
      Required

      The scales associated with the measures. They are useful if you want to, via plugin, add a new component that uses the same scale as one of the measures.

      Show SCALE properties
      • X string
        Required

        The scale used for positioning items along the x axis

      • Y string
        Required

        The scale used for positioning items along the y axis
  • layout object
    Required

    The layout from the enigma model.