@syncfusion/ej2-heatmap/src/heatmap/series/series-model.d.ts

Feature rich data visulization control used to visualize the matrix data where the individual values are represented as colors

import { Property, ChildProperty, extend, merge, Complex, Browser, isNullOrUndefined, createElement, SanitizeHtmlHelper} from '@syncfusion/ej2-base';import { HeatMap } from '../heatmap';import { Rect, TextBasic, textWrap, textTrim, Path, PathAttributes, RectOption, CircleOption, TextOption, CurrentRect, DrawSvgCanvas, createLabelTemplate} from '../utils/helper';import { convertHexToColor, colorNameToHex, formatValue, removeElement} from '../utils/helper';import { CellColor, RgbColor } from '../utils/colorMapping';import { BorderModel, FontModel, BubbleSizeModel } from '../model/base-model';import { Border, Font, BubbleTooltipData, BubbleSize } from '../model/base';import { ICellEventArgs } from '../model/interface';import { Theme} from '../model/theme';import { CellType, BubbleType } from '../utils/enum';import { DataModel } from '../datasource/adaptor-model';import { Axis } from '../axis/axis';

/**
 * Interface for a class CellSettings
 */
export interface CellSettingsModel {

    /**
     * Gets or sets the template that will be used to render custom elements for cell values.
     *
     * @default null
     * @aspType string
     */

    labelTemplate?: string | Function;

    /**
     * Enables or disables the visibility of data label over the heatmap cells.
     *
     * @default true
     */

    showLabel?: boolean;

    /**
     * Used to format the label in the heatmap cells.
     *
     * @default ''
     */

    format?: string;

    /**
     * Enable or disable the cell highlighting on mouse hover.
     *
     * @default true
     */
    enableCellHighlighting?: boolean;

    /**
     * Specifies the minimum and maximum radius value of the cell in percentage.
     *
     * @default ''
     */
    bubbleSize?: BubbleSizeModel;

    /**
     * Sets and gets the options to customize the cell border style.
     *
     * @default ''
     */
    border?: BorderModel;

    /**
     * Sets and gets the options to customize the cell label style.
     *
     * @default ''
     */
    textStyle?: FontModel;

    /**
     * Sets and gets the type of the cells in heatmap. The available types are,
     * * Rect: Renders the heatmap cells in rectangle shape.
     * * Bubble: Renders the heatmap cells in bubble shape.
     *
     * @default 'Rect'
     */
    tileType?: CellType;

    /**
     * Specifies the type of the bubble heatmap. The available types are,
     * * Size: The bubble heatmap will be rendered in size variations based on the provided data.
     * * Color: The bubble heatmap will be rendered in color variations based on the provided data.
     * * Sector: The bubble heatmap will be rendered as sectors based on the provided data.
     * * SizeAndColor: The bubble heatmap will be rendered in size and color variations based on the provided data.
     *
     * @default 'Color'
     */
    bubbleType?: BubbleType;

    /**
     * Enable or disable the bubble to display in inverse when `Size` and `SizeAndColor` bubble types are set.
     *
     * @default false
     */
    isInversedBubbleSize?: boolean;

}

/**
 * Interface for a class Series
 */
export interface SeriesModel {

}