com.wavefront.slug.chart.ChartSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slug-generator Show documentation
A library to generate RISON slugs for Wavefront charts
The newest version!
/*
 * Copyright 2019 VMware, Inc.
 * SPDX-License-Identifier: Apache-2.0
 */

package com.wavefront.slug.chart;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import java.util.List;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.extern.jackson.Jacksonized;

/**
 * Internal POJO represents a chart's settings with RISON compatible property name, used in
 * {@link Chart}.
 *
 * @deprecated This object is deprecated and only properties below are supported, all of other
 * properties should be added into chartAttributes section, which is a general JSON structure in
 * {@link Chart}.
 *
 * @author Yutian Wu ([email protected])
 */
@Deprecated
@Builder
@Jacksonized
@AllArgsConstructor
@JsonPropertyOrder(alphabetic = true)
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ChartSettings {
  @JsonProperty
  @Builder.Default
  private final String type = "line";

  @JsonProperty
  private final Double max;
  @JsonProperty
  private final Double min;

  @JsonProperty
  private final String lineType;
  @JsonProperty
  private final String stackType;

  @JsonProperty
  private final Long expectedDataSpacing;

  @JsonProperty
  private final String windowing;
  @JsonProperty
  private final Long windowSize;

  @JsonProperty
  private final Boolean showHosts;
  @JsonProperty
  private final Boolean showLabels;
  @JsonProperty
  private final Boolean showRawValues;

  // one of "all", "top", "custom"
  @JsonProperty
  private final String tagMode;
  @JsonProperty
  private final Integer numTags;
  @JsonProperty
  private final List customTags;

  @JsonProperty
  private final Boolean groupBySource;

  // table
  @JsonProperty
  private final Boolean sortValuesDescending;
  @JsonProperty
  private final String defaultSortColumn;

  @JsonProperty
  private final Double y1Max;
  @JsonProperty
  private final Double y1Min;
  @JsonProperty
  private final String y1Units;

  @JsonProperty
  private final Boolean y0ScaleSIBy1024;
  @JsonProperty
  private final Boolean y1ScaleSIBy1024;
  @JsonProperty
  private final Boolean y0UnitAutoscaling;
  @JsonProperty
  private final Boolean y1UnitAutoscaling;

  @JsonProperty
  private final Boolean invertDynamicLegendHoverControl;

  // legend
  @JsonProperty
  private final Boolean fixedLegendEnabled;
  @JsonProperty
  private final Boolean fixedLegendUseRawStats;
  @JsonProperty
  private final String fixedLegendPosition;
  @JsonProperty
  private final List fixedLegendDisplayStats;
  @JsonProperty
  private final String fixedLegendFilterSort;
  @JsonProperty
  private final Boolean fixedLegendShowSourceName;
  @JsonProperty
  private final Boolean fixedLegendShowMetricName;
  @JsonProperty
  private final Integer fixedLegendFilterLimit;
  @JsonProperty
  private final String fixedLegendFilterField;

  // scatterplot XY
  @JsonProperty
  private final Double xMax;
  @JsonProperty
  private final Double xMin;
  @JsonProperty
  private final Double yMax;
  @JsonProperty
  private final Double yMin;
  @JsonProperty
  private final Boolean timeBasedColoring;

  // text widgets
  @JsonProperty
  private final String markdownContent;
  @JsonProperty
  private final String plainMarkdownContent;

  // sparkline
  @JsonProperty
  private final String sparklineDisplayValueType;
  @JsonProperty
  private final String sparklineDisplayColor;
  @JsonProperty
  private final String sparklineDisplayVerticalPosition;
  @JsonProperty
  private final String sparklineDisplayHorizontalPosition;
  @JsonProperty
  private final String sparklineDisplayFontSize;
  @JsonProperty
  private final String sparklineDisplayPrefix;
  @JsonProperty
  private final String sparklineDisplayPostfix;
  @JsonProperty
  private final String sparklineSize;
  @JsonProperty
  private final String sparklineLineColor;
  @JsonProperty
  private final String sparklineFillColor;
  @JsonProperty
  private final List sparklineValueColorMapColors;
  @JsonProperty
  private final List sparklineValueColorMapValuesV2;

  // we expect this to form a chain of [ color | value | color | value | color ] (so colors should
  // always have 1 more element than values)
  @JsonProperty
  private final String sparklineValueColorMapApplyTo;
  @JsonProperty
  private final Integer sparklineDecimalPrecision;

  @JsonProperty
  private final List sparklineValueTextMapText;
  @JsonProperty
  private final List sparklineValueTextMapThresholds;

  @JsonProperty
  private final String chartDefaultColor;
}