packages/devtools_app/lib/src/ui/plotly.dart

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

@JS()
library plotly;

import 'package:js/js.dart';

// Button names for modeBarButtonsToRemove
const String sendDataToClose = 'sendDataToCloud';
const String select2D = 'select2d';
const String lasso2D = 'lasso2d';
const String hoverClosestCartesian = 'hoverClosestCartesian';
const String hoverCompareCartesian = 'hoverCompareCartesian';
const String toggleSpikeLines = 'toggleSpikelines';

@JS('hookupPlotlyClick')
external void _hookupPlotlyClick(
  String domName,
  Function jsFunction,
);

@JS('hookupPlotlyHover')
external void _hookupPlotlyHover(
  String domName,
  Function jsFunction,
);

@JS('hookupPlotlyLegendClick')
external bool _hookupPlotlyLegendClick(
  String domName,
  Function jsFunction,
);

@JS('hookupPlotlyDoubleClick')
external void _hookupPlotlyDoubleClick(
  String domName,
  Function jsFunction,
);

@JS()
external void extendTraces1(
  String domName,
  List x0,
  List y0,
  List traces,
);

@JS()
external void extendTraces2(
  String domName,
  List x0,
  List x1,
  List y0,
  List y1,
  List traces,
);

@JS()
external void extendTraces4(
  String domName,
  List x0,
  List x1,
  List x2,
  List x3,
  List y0,
  List y1,
  List y2,
  List y3,
  List traces,
);

@JS()
external Shape createGlowShape(
  int shapeIndex,
  num x,
  num y,
  String fillColor,
  String lineColor,
);

@JS()
external Shape createEventShape(
  devToolEvent,
  shapeIndex,
  lastEventTime,
  time,
);

@JS()
class Plotly {
  external static void addTraces(
    String domName,
    List<Data> traces,
    List<int> traceindex,
  );
  external static void newPlot(
    String domName,
    List<Data> traces, [
    Layout layout,
    Configuration config,
  ]);
  external static void extendTraces(
    String domName,
    TraceData traceData,
    List<int> traceindex,
  );
  external static void relayout(
    String domName,
//    Shape shape,
    dynamic layout,
  );
  external static void restyle(
    String domName,
    String style,
    List update,
    List<int> traces,
  );
  external static void update(
    String domName,
    List<Data> data,
    Layout layout, [
    List<int> traceindex,
  ]);
}

@JS('Plotly.Fx.hover')
external void plotFXHover(String domName, List<HoverFX> hoverInfo);

@JS()
@anonymous
class TraceData {
  external factory TraceData({
    List<List> x,
    List<List> y,
  });

  external List<List> get x;
  external List<List> get y;
}

@JS()
@anonymous
class Data {
  external factory Data({
    List x,
    List y,
    String type,
    String mode,
    Marker marker,
    Line line,
    String name,
    List<String> text,
    String stackgroup,
    List<Transform> transforms,
    String hoverinfo,
    HoverLabel hoverlabel,
    bool showlegend,
    String legendgroup,
    List<int> width,
    String visible,
    String yaxis,
  });

  external List get x;
  external List get y;
  external String get type;
  external String get mode;
  external Marker get marker;
  external Line get line;
  external String get name;
  external List<String> get text;
  external String get stackgroup;
  external List<Transform> get transforms;
  external String get hoverinfo;
  external HoverLabel get hoverlabel;
  external bool get showlegend;
  external String get legendgroup;
  external List<int> get width;
  external String get visible;
  external String get yaxis;

  // Setters.
  external set visible(String value);
  external set hoverinfo(String value);
}

@JS()
@anonymous
class Marker {
  external factory Marker({
    String color,
    String symbol,
    int size,
    Line line,
  });

  external String get color;
  external String get symbol;
  external int get size;
  external Line get line;
}

@JS()
@anonymous
class Line {
  external factory Line({
    String color,
    String dash,
    int width,
  });

  external String get color;
  external String get dash;
  external int get width;
}

@JS()
@anonymous
class Transform {
  external factory Transform({
    List target,
    bool enabled,
    bool preservegaps,
    String operation,
    int value,
    String type,
  });

  external List get target;
  external bool get enabled;
  external bool get preservegaps;
  external String get operation;
  external int get value;
  external String get type;
}

@JS()
@anonymous
class Title {
  external factory Title({
    String text,
    Font font,
    int size,
  });

  external String get text;
  external Font get font;
  external int get size;
}

@JS()
@anonymous
class Layout {
  external factory Layout({
    String title,
    bool showlegend,
    AxisLayout xaxis,
    AxisLayout yaxis,
    AxisLayout yaxis2,
    AxisLayout yaxis3,
    bool autosize,
    Margin margin,
    String hovermode,
    String barmode,
    num bargap,
    num bargroupgap,
    String dragmode,
    HoverLabel hoverlabel,
    List<Shape> shapes,
    Font font,
    Legend legend,
    // ignore: non_constant_identifier_names
    String plot_bgcolor,
    // ignore: non_constant_identifier_names
    String paper_bgcolor,
  });

  external String get title;
  external bool get showlegend;
  external AxisLayout get xaxis;
  external AxisLayout get yaxis;
  external AxisLayout get yaxis2;
  external AxisLayout get yaxis3;
  external bool get autosize;
  external Margin get margin;
  external String get hovermode;
  external bool get barmode;
  external num get bargap;
  external num get bargroupgap;
  external String get dragmode;
  external List<Shape> get shapes;
  external Font get font;
  external Legend get legend;
  // ignore: non_constant_identifier_names
  external String get plot_bgcolor;
  // ignore: non_constant_identifier_names
  external String get paper_bgcolor;
}

@JS()
@anonymous
class Shape {
  external factory Shape({
    String type,
    String xref,
    String yref,
    String layer,
    num x0,
    num y0,
    num x1,
    num y1,
    Line line,
    String fillcolor,
    num opacity,
  });

  external String get type;
  external String get xref;
  external String get yref;
  external String get layer;
  external num get x0;
  external num get y0;
  external num get x1;
  external num get y1;
  external Line get line;
  external String get fillcolor;
  external num get opacity;
}

@JS()
@anonymous
class Legend {
  external factory Legend({
    String orientation,
    num x,
    num y,
    Font font,
    String xanchor,
  });

  external String get orientation;
  external num get x;
  external num get y;
  external Font get font;
  external String get xanchor;
}

@JS()
@anonymous
class HoverLabel {
  external factory HoverLabel({
    String bgcolor,
    String bordercolor,
    Font font,
  });

  external String get bgcolor;
  external String get bordercolor;
  external Font get font;
}

@JS()
@anonymous
class Font {
  external factory Font({
    String family,
    String color,
    int size,
  });

  external String get family;
  external String get color;
  external int get size;
}

@JS()
@anonymous
class AxisLayout {
  external factory AxisLayout({
    String tickformat,
    String ticks,
    Title title,
    bool fixedrange,
    String type,
    bool autorange,
    String rangemode,
    List<num> range,
    RangeSlider rangeslider,
    RangeSelector rangeselector,
    bool showgrid,
    bool showticklabels,
    Font tickfont,
    int nticks,
    String tickmode,
    List<int> tickvals,
    List<int> ticktext,
    String exponentformat,
    String showticksuffix,
    String hoverformat,
    Font titlefont,
    List<num> domain,
    bool zeroline,
    String anchor,
    String side,
    bool showline,
    Legend legend,
    String gridcolor,
    int gridwidth,
  });

  external String get tickformat;
  external String get ticks;
  external Title get title;
  external bool get fixedrange;
  external String get type;
  external bool get autorange;
  external String get rangemode;
  external List<num> get range;
  external RangeSlider get rangeslider;
  external RangeSelector get rangeselector;
  external bool get showgrid;
  external bool get showticklabels;
  external Font get tickfont;
  external int get nticks;
  external String get tickmode;
  external List<int> get tickvals;
  external List<int> get ticktext;
  external String get exponentformat;
  external String get showticksuffix;
  external String get hoverformat;
  external String get hockerformat;
  external Font get titlefont;
  external List<num> get domain;
  external bool get zeroline;
  external String get anchor;
  external String get side;
  external bool get showline;
  external Legend get legend;
  external String get gridcolor;
  external int get gridwidth;
}

@JS()
@anonymous
class RangeSelector {
  external factory RangeSelector({
    List<Button> buttons,
  });

  external List<Button> get buttons;
}

@JS()
@anonymous
class Button {
  external factory Button({
    int count,
    String label,
    String step,
    String stepmode,
  });

  external int get count;
  external String get label;
  external String get step;
  external String get stepmode;
}

@JS()
@anonymous
class Margin {
  external factory Margin({
    int l,
    int r,
    int b,
    int t,
    int pad,
  });

  external int get l;
  external int get r;
  external int get b;
  external int get t;
  external int get pad;
}

@JS()
@anonymous
class RangeSlider {
  external factory RangeSlider({
    String bgcolor,
    String bordercolor,
    int borderwidth,
    bool autorange,
    List<num> range,
    num thickness,
    bool visible,
    String rangemode,
    Font tickfont,
  });

  external String get bgcolor;
  external String get bordercolor;
  external int get borderwidth;
  external bool get autorange;
  external List<num> get range;
  external num get thickness;
  external bool get visible;
  external String get rangemode;
  external Font get tickfont;
}

@JS()
@anonymous
class Configuration {
  external factory Configuration({
    bool displayModeBar,
    bool responsive,
    bool displaylogo,
    List<String> modeBarButtonsToRemove,
  });

  external bool get displayModeBar;
  external bool get responsive;
  external bool get displaylogo;
  external List<String> get modeBarButtonsToRemove;
}

@JS()
@anonymous
class DataEvent {
  external dynamic get event;
  external List<Point> get points;
}

@JS()
@anonymous
class LegendDataEvent {
  external dynamic get event;
  external int get curveNumber;
  external List<Data> get data;
  external int get expandedIndex;
}

@JS()
@anonymous
class Point {
  external factory Point({
    int curveNumber,
    Data data,
    int pointIndex,
    int pointNumber,
    AxisLayout xaxis,
    AxisLayout yaxis,
    num x,
    num y,
  });

  external int get curveNumber;
  external Data get data;
  external int get pointIndex;
  external int get pointNumber;
  external AxisLayout get xaxis;
  external AxisLayout get yaxis;
  external num get x;
  external num get y;
}

@JS()
@anonymous
class HoverFX {
  external factory HoverFX({
    int curveNumber,
    int pointNumber,
  });

  external int get curveNumber;
  external int get pointNumber;
}

void mouseClick(
  String domName,
  Function f,
) {
  // Hookup clicks in the plotly chart.
  _hookupPlotlyClick(domName, allowInterop(f));
}

void hoverOver(
  String domName,
  Function f,
) {
  _hookupPlotlyHover(domName, allowInterop(f));
}

bool legendClick(
  String domName,
  Function f,
) {
  // Hookup clicks in the legend in a plotly chart.
  return _hookupPlotlyLegendClick(domName, allowInterop(f));
}

void doubleClick(
  String domName,
  Function f,
) {
  _hookupPlotlyDoubleClick(domName, allowInterop(f));
}