@syncfusion/ej2-treemap 20.4.48 → 21.1.37

package/src/treemap/user-interaction/highlight-selection.js

@@ -22,6 +22,7 @@ var TreeMapHighlight = /** @class */ (function () {
      *
      * @param {PointerEvent} e - Specifies the pointer argument.
      * @returns {boolean} - return the highlight process is true or false.
+     * @private
      */
     TreeMapHighlight.prototype.mouseMove = function (e) {
         var treemap = this.treemap;
@@ -233,6 +234,7 @@ var TreeMapSelection = /** @class */ (function () {
      *
      * @param {PointerEvent} e - Specifies the pointer argument.
      * @returns {void}
+     * @private
      */
     TreeMapSelection.prototype.mouseDown = function (e) {
         var targetEle = e.target;

package/src/treemap/user-interaction/tooltip.d.ts

@@ -16,10 +16,12 @@ export declare class TreeMapTooltip {
     removeTooltip(): void;
     /**
      * To bind events for tooltip module
+     * @private
      */
     addEventListener(): void;
     /**
      * To unbind events for tooltip module
+     * @private
      */
     removeEventListener(): void;
     /**

package/src/treemap/user-interaction/tooltip.js

@@ -8,7 +8,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 import { Tooltip } from '@syncfusion/ej2-svg-base';
-import { Browser, createElement, isNullOrUndefined } from '@syncfusion/ej2-base';
+import { Browser, createElement, isNullOrUndefined, SanitizeHtmlHelper } from '@syncfusion/ej2-base';
 import { getMousePosition, textFormatter, formatValue } from '../utils/helper';
 import { tooltipRendering } from '../model/constants';
 /**
@@ -60,12 +60,12 @@ var TreeMapTooltip = /** @class */ (function () {
                     markerFill = item['options']['fill'];
                 }
                 if (this.treemap.enableRtl) {
-                    tooltipContent = [textFormatter(this.tooltipSettings.format, toolTipData, this.treemap) ||
-                            formatValue(value, this.treemap) + ' : ' + this.treemap.weightValuePath.toString()];
+                    tooltipContent = [SanitizeHtmlHelper.sanitize(textFormatter(this.tooltipSettings.format, toolTipData, this.treemap)) ||
+                            SanitizeHtmlHelper.sanitize(formatValue(value, this.treemap) + ' : ' + this.treemap.weightValuePath.toString())];
                 }
                 else {
-                    tooltipContent = [textFormatter(this.tooltipSettings.format, toolTipData, this.treemap) ||
-                            this.treemap.weightValuePath.toString() + ' : ' + formatValue(value, this.treemap)];
+                    tooltipContent = [SanitizeHtmlHelper.sanitize(textFormatter(this.tooltipSettings.format, toolTipData, this.treemap)) ||
+                            SanitizeHtmlHelper.sanitize(this.treemap.weightValuePath.toString() + ' : ' + formatValue(value, this.treemap))];
                 }
                 if (document.getElementById(this.tooltipId)) {
                     tooltipEle = document.getElementById(this.tooltipId);
@@ -163,6 +163,7 @@ var TreeMapTooltip = /** @class */ (function () {
     // eslint-disable-next-line valid-jsdoc
     /**
      * To bind events for tooltip module
+     * @private
      */
     TreeMapTooltip.prototype.addEventListener = function () {
         if (this.treemap.isDestroyed) {
@@ -174,6 +175,7 @@ var TreeMapTooltip = /** @class */ (function () {
     // eslint-disable-next-line valid-jsdoc
     /**
      * To unbind events for tooltip module
+     * @private
      */
     TreeMapTooltip.prototype.removeEventListener = function () {
         if (this.treemap.isDestroyed) {

package/src/treemap/utils/enum.d.ts

@@ -2,35 +2,35 @@
  * Defines the position of the label in treemap leaf node.
  */
 export declare type LabelPosition = 
-/** To show the position of the label based on the top and left of the treemap leaf nodes.  */
+/** Specifies to show the position of the label based on the top and left of the treemap leaf nodes.  */
 'TopLeft' | 
-/** To show the position of the label based on the top and center of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the top and center of the treemap leaf nodes. */
 'TopCenter' | 
-/** To show the position of the label based on the top and right of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the top and right of the treemap leaf nodes. */
 'TopRight' | 
-/** To show the position of the label based on the center and left of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the center and left of the treemap leaf nodes. */
 'CenterLeft' | 
-/** To show the position of the label based on the center of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the center of the treemap leaf nodes. */
 'Center' | 
-/** To show the position of the label based on the center and right of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the center and right of the treemap leaf nodes. */
 'CenterRight' | 
-/** To show the position of the label based on the bottom and left of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the bottom and left of the treemap leaf nodes. */
 'BottomLeft' | 
-/** To show the position of the label based on the bottom and center of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the bottom and center of the treemap leaf nodes. */
 'BottomCenter' | 
-/** To show the position of the label based on the bottom and right of the treemap leaf nodes. */
+/** Specifies to show the position of the label based on the bottom and right of the treemap leaf nodes. */
 'BottomRight';
 /**
  * Specifies the layout rendering mode of the treemap.
  */
 export declare type LayoutMode = 
-/** This visualizes the treemap as the nested rectangles having size proportionate to weight value */
+/** This visualizes the treemap as the nested rectangles having size proportionate to weight value. */
 'Squarified' | 
-/** This visualizes the treemap as the horizontal rectangles having size proportionate to weight value */
+/** This visualizes the treemap as the horizontal rectangles having size proportionate to weight value. */
 'SliceAndDiceHorizontal' | 
-/** This visualizes the treemap as the vertical rectangles having size proportionate to weight value */
+/** This visualizes the treemap as the vertical rectangles having size proportionate to weight value. */
 'SliceAndDiceVertical' | 
-/** This visualizes the treemap as the auto rectangles having size proportionate to weight value */
+/** This visualizes the treemap rectangles having size proportionate to weight value. This type automatically provides the orientation based on the size of the treemap. */
 'SliceAndDiceAuto';
 /**
  * Specifies the alignment of the elements in the treemap.
@@ -48,11 +48,11 @@ export declare type Alignment =
 export declare type HighLightMode = 
 /** Highlights the treemap item when the mouse over is done on the treemap item. */
 'Item' | 
-/** Highlights the treemap item and level when the mouse over is done on the treemap item. */
+/** Highlights the treemap item and all its children when the mouse over is done on the treemap item. */
 'Child' | 
-/** Highlights the treemap item and parent level when the mouse over is done on the treemap item. */
+/** Highlights the treemap item and all its parent levels when the mouse over is done on the treemap item. */
 'Parent' | 
-/** Highlights all the related nodes when the mouse over is done on the treemap item. */
+/** Highlights all the related nodes such as child and parent when the mouse over is done on the treemap item. */
 'All';
 /**
  * Specifies the element which must be selected when click event is performed in treemap.
@@ -60,38 +60,38 @@ export declare type HighLightMode =
 export declare type SelectionMode = 
 /** Selects the treemap item when the click operation is done on the treemap item. */
 'Item' | 
-/** Selects the treemap item and level when the click operation is done on the treemap item. */
+/** Selects the treemap item and all its children when the click operation is done on the treemap item. */
 'Child' | 
-/** Selects the treemap item and parent level when the click operation is done on the treemap item.. */
+/** Selects the treemap item and all its parent levels when the click operation is done on the treemap item.. */
 'Parent' | 
-/** Selects all the related nodes when the click operation is done on the treemap item. */
+/** Selects all the related nodes such as child and parent when the click operation is done on the treemap item. */
 'All';
 /**
- * Specifies the export type for the treemap
+ * Specifies the export type for the treemap.
  */
 export declare type ExportType = 
-/** Specifies the rendered treemap to be exported in the png format. */
+/** Specifies that the rendered treemap is to be exported in the PNG format. */
 'PNG' | 
-/** Specifies the rendered treemap to be exported in the jpeg format. */
+/** Specifies that the rendered treemap is to be exported in the JPEG format. */
 'JPEG' | 
-/** Specifies the rendered treemap to be exported in the svg format. */
+/** Specifies that the rendered treemap is to be exported in the SVG format. */
 'SVG' | 
-/** Specifies the rendered treemap to be exported in the pdf format. */
+/** Specifies that the rendered treemap is to be exported in the PDF format. */
 'PDF';
 /**
- * Defines the text to be placed within the defined margins.
+ * Defines the action of the label to be placed within the defined margins.
  */
 export declare type LabelAlignment = 
-/** Specifies that the data label will trim if exceeded the defined margins. */
+/** Specifies that the label will be trimmed if it exceeds the defined margins. */
 'Trim' | 
-/** Specifies that the data label will hide if exceeded the defined margins. */
+/** Specifies that the label will be hidden if it exceeds the defined margins. */
 'Hide' | 
-/** Specifies the word to force all text to fit within the defined margins. */
+/** Specifies that the label will be wrapped by word to fit within the defined margins. */
 'WrapByWord' | 
 /** Specifies to wrap the data label if exceed the defined margins. */
 'Wrap';
 /**
- * Defines the shape of legend in the treemap component.
+ * Defines the shape of legend item in the treemap.
  */
 export declare type LegendShape = 
 /** Defines the legend shape as circle. */
@@ -117,7 +117,7 @@ export declare type LegendShape =
 /** Defines the legend shape as image. */
 'Image';
 /**
- * Defines the position of the legend in the treemap component.
+ * Defines the position of the legend in the treemap.
  */
 export declare type LegendPosition = 
 /** Specifies to place the legend at the top of the treemap. */
@@ -128,17 +128,17 @@ export declare type LegendPosition =
 'Bottom' | 
 /** Specifies to place the legend on the right of the treemap. */
 'Right' | 
-/** Specifies to place the legend based on given x and y positions. */
+/** Specifies to place the legend based on given custom positions. */
 'Float' | 
-/** Specifies to place the legend based on width and height. */
+/** Specifies to place the legend in a automatic position based on width and height. */
 'Auto';
 /**
- * Defines the legend rendering modes. The modes are default and interactive modes.
+ * Defines the modes for rendering the legend.
  */
 export declare type LegendMode = 
-/** Specifies the legend as static. */
+/** Sets the legend as fixed, and has the option to add different shapes showcasing legend items. */
 'Default' | 
-/** Specifies the legend as interactive. */
+/** Set the legend as interactive, which is rectangular in shape with an indicator showcasing legend items. */
 'Interactive';
 /**
  * Specifies the orientation of the legend in the treemap.
@@ -146,19 +146,19 @@ export declare type LegendMode =
 export declare type LegendOrientation = 
 /** Defines the legend renders with default behavior. */
 'None' | 
-/** Defines the legend renders with items places horizontally. */
+/** Defines the legend rendered with items placed horizontally. */
 'Horizontal' | 
-/** Defines the legend renders with items places vertically. */
+/** Defines the legend rendered with items placed vertically. */
 'Vertical';
 /**
- * Defines the label intersect action in treemap component.
+ * Defines the action to perform when the labels intersect each other in the treemap.
  */
 export declare type LabelIntersectAction = 
 /** Specifies that no action will be taken when the label contents intersect. */
 'None' | 
-/** Specifies the data label to be trimmed when it intersects. */
+/** Specifies that the data label should be trimmed when it intersects. */
 'Trim' | 
-/** Specifies the data label to be hidden when it intersects. */
+/** Specifies that the data label should be hidden when it intersects. */
 'Hide';
 /**
  * Defines the placement type of the label.
@@ -172,23 +172,23 @@ export declare type LabelPlacement =
  * Defines the theme supported for treemap.
  */
 export declare type TreeMapTheme = 
-/** Render a treemap with material theme. */
+/** Render a treemap with Material theme. */
 'Material' | 
-/** Render a treemap with fabric theme. */
+/** Render a treemap with Fabric theme. */
 'Fabric' | 
-/** Render a treemap with highcontrast light theme. */
+/** Render a treemap with HighContrast light theme. */
 'HighContrastLight' | 
-/** Render a treemap with bootstrap theme. */
+/** Render a treemap with Bootstrap theme. */
 'Bootstrap' | 
-/** Render a treemap with material dark theme. */
+/** Render a treemap with Material dark theme. */
 'MaterialDark' | 
-/** Render a treemap with fabric dark theme. */
+/** Render a treemap with Fabric dark theme. */
 'FabricDark' | 
-/** Render a treemap with highcontrast dark theme. */
+/** Render a treemap with HighContrast dark theme. */
 'HighContrast' | 
-/** Render a treemap with bootstrap dark theme. */
+/** Render a treemap with Bootstrap dark theme. */
 'BootstrapDark' | 
-/** Render a treemap with bootstrap4 theme. */
+/** Render a treemap with Bootstrap4 theme. */
 'Bootstrap4' | 
 /**  Render a treemap with Tailwind theme. */
 'Tailwind' | 
@@ -214,3 +214,28 @@ export declare type RenderingMode =
 'BottomRightTopLeft' | 
 /** Renders the treemap items from top left to bottom right direction */
 'TopLeftBottomRight';
+/**
+ * Defines the shape of the marker in the tooltip of the treemap.
+ * @private
+ */
+export declare type MarkerShape = 
+/** Renders circle shape marker in the tooltip. */
+'Circle' | 
+/** Renders rectangle shape marker in the tooltip. */
+'Rectangle' | 
+/** Renders triangle shape marker in the tooltip. */
+'Triangle' | 
+/** Renders diamond shape marker in the tooltip. */
+'Diamond' | 
+/** Renders cross shape marker in the tooltip. */
+'Cross' | 
+/** Renders horizontal line shape marker in the tooltip. */
+'HorizontalLine' | 
+/** Renders vertical line shape marker in the tooltip. */
+'VerticalLine' | 
+/** Renders pentagon shape marker in the tooltip. */
+'Pentagon' | 
+/** Renders inverted triangle shape marker in the tooltip. */
+'InvertedTriangle' | 
+/** Renders image marker in the tooltip. */
+'Image';

package/src/treemap/utils/helper.d.ts

@@ -5,15 +5,15 @@ import { TreeMap } from '../treemap';
 import { IShapes } from '../model/interface';
 import { ExportType } from '../utils/enum';
 /**
- * Create the class for size
+ * Specifies the size parameters.
  */
 export declare class Size {
     /**
-     * height of the size
+     * Defines the height in the size object.
      */
     height: number;
     /**
-     * width of the size
+     * Defines the width in the size object.
      */
     width: number;
     constructor(width: number, height: number);
@@ -101,15 +101,15 @@ export declare class TextOption {
  */
 export declare function textTrim(maxWidth: number, text: string, font: FontModel): string;
 /**
- * Map internal class for Point
+ * Specifies the location parameters.
  */
 export declare class Location {
     /**
-     * To calculate x value for location
+     * Defines the horizontal position.
      */
     x: number;
     /**
-     * To calculate y value for location
+     * Defines the vertical position.
      */
     y: number;
     constructor(x: number, y: number);
@@ -122,6 +122,7 @@ export declare class Location {
  * @param {Size} textSize - Specifies the size of the text.
  * @param {type} type - Specifies whether the provided text is title or subtitle.
  * @returns {Location} - Returns the location of text.
+ * @private
  */
 export declare function findPosition(location: Rect, alignment: Alignment, textSize: Size, type: string): Location;
 /**
@@ -340,6 +341,7 @@ export declare function textWrap(maxWidth: number, label: string, font: FontMode
  * @param {string} text - Specifies the text.
  * @param {FontModel} font - Specifies the font.
  * @returns {string} - Returns the hidden text.
+ * @private
  */
 export declare function hide(maxWidth: number, maxHeight: number, text: string, font: FontModel): string;
 /**
@@ -455,18 +457,18 @@ export declare function renderLegendShape(location: Location, size: Size, shape:
  */
 export declare function isParentItem(data: any[], item: any): boolean;
 /**
- * Ajax support for treemap
+ * Specifies the data to be received through Ajax request for treemap.
  */
 export declare class TreeMapAjax {
-    /** options for data */
+    /** Defines the options for the data for treemap. */
     dataOptions: string | any;
-    /** type of data */
+    /** Defines the type of the data. */
     type: string;
-    /** async value */
+    /** Specifies whether the request is asynchronous or not. */
     async: boolean;
-    /** type of the content */
+    /** Defines the type of the content. */
     contentType: string;
-    /** sending data */
+    /** Defines the data to be sent through the request. */
     sendData: string | any;
     constructor(options: string | any, type?: string, async?: boolean, contentType?: string, sendData?: string | any);
 }
@@ -530,6 +532,7 @@ export declare function pushCollection(collection: any[], index: number, number:
  * @param {string} url - Specifies the url
  * @param {boolean} isDownload - Specifies the boolean value
  * @returns {void}
+ * @private
  */
 export declare function triggerDownload(fileName: string, type: ExportType, url: string, isDownload: boolean): void;
 /**

package/src/treemap/utils/helper.js

@@ -1,7 +1,7 @@
-import { createElement, compile, merge, isNullOrUndefined, remove } from '@syncfusion/ej2-base';
+import { createElement, compile, merge, isNullOrUndefined, remove, SanitizeHtmlHelper } from '@syncfusion/ej2-base';
 import { SvgRenderer } from '@syncfusion/ej2-svg-base';
 /**
- * Create the class for size
+ * Specifies the size parameters.
  */
 var Size = /** @class */ (function () {
     function Size(width, height) {
@@ -86,7 +86,7 @@ export function measureText(text, font) {
         measureObject = createElement('text', { id: 'treeMapMeasureText' });
         document.body.appendChild(measureObject);
     }
-    measureObject.innerHTML = text;
+    measureObject.innerHTML = SanitizeHtmlHelper.sanitize(text);
     measureObject.style.position = 'absolute';
     measureObject.style.fontSize = font.size;
     measureObject.style.fontWeight = font.fontWeight;
@@ -150,7 +150,7 @@ export function textTrim(maxWidth, text, font) {
     return label;
 }
 /**
- * Map internal class for Point
+ * Specifies the location parameters.
  */
 var Location = /** @class */ (function () {
     function Location(x, y) {
@@ -168,6 +168,7 @@ export { Location };
  * @param {Size} textSize - Specifies the size of the text.
  * @param {type} type - Specifies whether the provided text is title or subtitle.
  * @returns {Location} - Returns the location of text.
+ * @private
  */
 export function findPosition(location, alignment, textSize, type) {
     var x;
@@ -851,6 +852,7 @@ export function textWrap(maxWidth, label, font) {
  * @param {string} text - Specifies the text.
  * @param {FontModel} font - Specifies the font.
  * @returns {string} - Returns the hidden text.
+ * @private
  */
 export function hide(maxWidth, maxHeight, text, font) {
     var hideText = text;
@@ -1174,7 +1176,7 @@ export function isParentItem(data, item) {
     return isParentItem;
 }
 /**
- * Ajax support for treemap
+ * Specifies the data to be received through Ajax request for treemap.
  */
 var TreeMapAjax = /** @class */ (function () {
     function TreeMapAjax(options, type, async, contentType, sendData) {
@@ -1296,6 +1298,7 @@ export function pushCollection(collection, index, number, legendElement, shapeEl
  * @param {string} url - Specifies the url
  * @param {boolean} isDownload - Specifies the boolean value
  * @returns {void}
+ * @private
  */
 export function triggerDownload(fileName, type, url, isDownload) {
     createElement('a', {