@arcgis/core/renderers/visualVariables/support/VisualVariableLegendOptions.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type { ClonableMixin } from "../../../core/Clonable.js";
import type { JSONSupport } from "../../../core/JSONSupport.js";

/** @since 5.0 */
export interface VisualVariableLegendOptionsProperties extends Partial<Pick<VisualVariableLegendOptions, "showLegend" | "title">> {}

/** @since 5.0 */
export default class VisualVariableLegendOptions extends VisualVariableLegendOptionsSuperclass {
  constructor(properties?: VisualVariableLegendOptionsProperties);
  /**
   * Indicates whether to show the visual variable in the legend.
   *
   * @since 5.0
   */
  accessor showLegend: boolean | null | undefined;
  /**
   * The title describing the visualization of
   *   the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/). This takes precedence over
   *   a field alias or [VisualVariable.valueExpressionTitle](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/VisualVariable/#valueExpressionTitle).
   *
   * @since 5.0
   */
  accessor title: string | null | undefined;
}
declare const VisualVariableLegendOptionsSuperclass: typeof JSONSupport & typeof ClonableMixin