@syncfusion/ej2-treemap 20.4.48 → 21.1.37

package/src/treemap/model/base.js

@@ -23,7 +23,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { Property, ChildProperty, Complex, Collection } from '@syncfusion/ej2-base';
 import { defaultFont } from './constants';
 /**
- * Sets and gets the options for customizing the color and width of the border in treemap component.
+ * Sets and gets the options for customizing the color and width of the border in treemap.
  */
 var Border = /** @class */ (function (_super) {
     __extends(Border, _super);
@@ -40,7 +40,7 @@ var Border = /** @class */ (function (_super) {
 }(ChildProperty));
 export { Border };
 /**
- * Sets and gets the margin for the treemap component.
+ * Sets and gets the margin for the treemap.
  */
 var Margin = /** @class */ (function (_super) {
     __extends(Margin, _super);
@@ -63,7 +63,7 @@ var Margin = /** @class */ (function (_super) {
 }(ChildProperty));
 export { Margin };
 /**
- * Sets and gets the options to customize the style of the text contents in the treemap component.
+ * Sets and gets the options to customize the style of the text contents in the treemap.
  */
 var Font = /** @class */ (function (_super) {
     __extends(Font, _super);
@@ -92,7 +92,7 @@ var Font = /** @class */ (function (_super) {
 }(ChildProperty));
 export { Font };
 /**
- * Sets and gets the options for customizing the common title of the treemap component.
+ * Sets and gets the options for customizing the title of the treemap.
  */
 var CommonTitleSettings = /** @class */ (function (_super) {
     __extends(CommonTitleSettings, _super);
@@ -109,7 +109,7 @@ var CommonTitleSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { CommonTitleSettings };
 /**
- * Sets and gets the options for customizing the subtitle of the treemap component.
+ * Sets and gets the options for customizing the subtitle of the treemap.
  */
 var SubTitleSettings = /** @class */ (function (_super) {
     __extends(SubTitleSettings, _super);
@@ -126,7 +126,7 @@ var SubTitleSettings = /** @class */ (function (_super) {
 }(CommonTitleSettings));
 export { SubTitleSettings };
 /**
- * Sets and gets the options for customizing the title of the treemap component.
+ * Sets and gets the options for customizing the title of the treemap.
  */
 var TitleSettings = /** @class */ (function (_super) {
     __extends(TitleSettings, _super);
@@ -146,7 +146,7 @@ var TitleSettings = /** @class */ (function (_super) {
 }(CommonTitleSettings));
 export { TitleSettings };
 /**
- * Sets and gets the options to customize the color-mapping in treemap component.
+ * Sets and gets the options to customize the color-mapping in treemap.
  */
 var ColorMapping = /** @class */ (function (_super) {
     __extends(ColorMapping, _super);
@@ -181,7 +181,7 @@ var ColorMapping = /** @class */ (function (_super) {
 }(ChildProperty));
 export { ColorMapping };
 /**
- * Sets and gets the options for customizing the legend of the treemap component.
+ * Sets and gets the options for customizing the legend of the treemap.
  */
 var LegendSettings = /** @class */ (function (_super) {
     __extends(LegendSettings, _super);
@@ -273,7 +273,7 @@ var LegendSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { LegendSettings };
 /**
- * Sets and gets the settings for drill to visualize the treemap rendered in the initial state.
+ * Sets and gets the settings for drill down to visualize the treemap rendered in the initial state.
  */
 var InitialDrillSettings = /** @class */ (function (_super) {
     __extends(InitialDrillSettings, _super);
@@ -290,7 +290,7 @@ var InitialDrillSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { InitialDrillSettings };
 /**
- * Sets and gets the options for customizing the leaf item of the treemap component.
+ * Sets and gets the options for customizing the leaf item of the treemap.
  */
 var LeafItemSettings = /** @class */ (function (_super) {
     __extends(LeafItemSettings, _super);
@@ -346,7 +346,7 @@ var LeafItemSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { LeafItemSettings };
 /**
- * Sets and gets the options for customizing the tooltip of the treemap component.
+ * Sets and gets the options for customizing the tooltip of the treemap.
  */
 var TooltipSettings = /** @class */ (function (_super) {
     __extends(TooltipSettings, _super);
@@ -381,7 +381,7 @@ var TooltipSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { TooltipSettings };
 /**
- * Sets and gets the options for customizing the selection of the leaf items in treemap component.
+ * Sets and gets the options for customizing the selection of the leaf items in treemap.
  */
 var SelectionSettings = /** @class */ (function (_super) {
     __extends(SelectionSettings, _super);
@@ -434,7 +434,7 @@ var HighlightSettings = /** @class */ (function (_super) {
 }(ChildProperty));
 export { HighlightSettings };
 /**
- * Sets and gets the options for customizing the levels of the treemap component.
+ * Sets and gets the options for customizing the level leaf items of the treemap.
  */
 var LevelSettings = /** @class */ (function (_super) {
     __extends(LevelSettings, _super);

package/src/treemap/model/constants.d.ts

@@ -110,7 +110,7 @@ export declare const legendRendering: string;
  */
 export declare const resize: string;
 /**
- * Define the font family in treemap component.
+ * Define the font family in treemap.
  *
  * @private
  */

package/src/treemap/model/constants.js

@@ -110,7 +110,7 @@ export var legendRendering = 'legendRendering';
  */
 export var resize = 'resize';
 /**
- * Define the font family in treemap component.
+ * Define the font family in treemap.
  *
  * @private
  */

package/src/treemap/model/interface.d.ts

@@ -3,7 +3,7 @@ import { BorderModel, FontModel } from '../model/base-model';
 import { LegendShape, LegendPosition } from '../utils/enum';
 import { Size } from '../utils/helper';
 /**
- * Specifies the event argument for the treemap component.
+ * Specifies the event argument for the treemap.
  *
  * @private
  */
@@ -26,7 +26,7 @@ export interface IPrintEventArgs extends ITreeMapEventArgs {
     htmlContent: Element;
 }
 /**
- * Specifies the event arguments for on load event in treemap.
+ * Specifies the event arguments for load event in treemap.
  */
 export interface ILoadEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -44,7 +44,7 @@ export interface ILoadedEventArgs extends ITreeMapEventArgs {
 
      */
     treemap?: TreeMap;
-    /** Defines isResized argument.
+    /** Specifies whether the treemap is resized or not.
      */
     isResized: boolean;
 }
@@ -52,7 +52,7 @@ export interface ILoadedEventArgs extends ITreeMapEventArgs {
  * Specifies the event arguments in item rendering event in treemap.
  */
 export interface IItemRenderingEventArgs extends ITreeMapEventArgs {
-    /** Defines the current treemap instance
+    /** Defines the current treemap instance.
      *
 
      */
@@ -70,7 +70,7 @@ export interface IItemRenderingEventArgs extends ITreeMapEventArgs {
      */
     options: Object;
     /**
-     * Defines the header text of the treemap item.
+     * Defines the label of the treemap item.
      */
     text: string;
 }
@@ -84,7 +84,7 @@ export interface IDrillStartEventArgs extends ITreeMapEventArgs {
      */
     treemap?: TreeMap;
     /**
-     * Defines the current drill-down.
+     * Defines the current drill-down item.
      */
     item: Object;
     /**
@@ -100,11 +100,11 @@ export interface IDrillStartEventArgs extends ITreeMapEventArgs {
      */
     groupName: string;
     /**
-     * Returns a boolean value whether it is right click or not.
+     * Returns whether the right click is performed or not.
      */
     rightClick: boolean;
     /**
-     * Defines the child values of the item in the drill start event.
+     * Defines the details of the child level items in the drill start event.
      */
     childItems: Object;
 }
@@ -118,7 +118,7 @@ export interface IDrillEndEventArgs extends ITreeMapEventArgs {
      */
     treemap?: TreeMap;
     /**
-     * Defines all the items for rendering.
+     * Defines all the items which is rendered after drill down.
      */
     renderItems: Object[];
 }
@@ -142,24 +142,25 @@ export interface IItemClickEventArgs extends ITreeMapEventArgs {
      */
     mouseEvent: PointerEvent;
     /**
-     * Defines the level of the current treemap item.
+     * Defines the index of the level of the current treemap item.
      */
     groupIndex: number;
     /**
-     * Defines the parent name of the current treemap item.
+     * Defines the name of the parent item of the current treemap item.
      */
     groupName: string;
     /**
-     * Defines the header name of the current treemap item.
+     * Defines the label of the current treemap item.
      */
     text: string;
     /**
-     * Defines the template of the treemap item which is used to add it in the treemap control.
+     * Defines the template of the treemap item which is added as custom element for the labels in the treemap.
      */
     contentItemTemplate: string;
 }
 /**
  * Defines the event argument of the treemap item data.
+ * @private
  */
 export interface IItemDataEventArgs {
     /**
@@ -200,7 +201,7 @@ export interface IItemDataEventArgs {
     rect?: Object;
 }
 /**
- * Specifies the event arguments available on performing mouse move on the treemap items.
+ * Specifies the event arguments available when mouse move action is performed on the treemap items.
  */
 export interface IItemMoveEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -209,18 +210,18 @@ export interface IItemMoveEventArgs extends ITreeMapEventArgs {
      */
     treemap?: TreeMap;
     /**
-     * Defines the current item move.
+     * Defines the current item on which mouse is moved.
      *
      * @isGenericType true
      */
     item: Object;
     /**
-     * Defines the original mouse event arguments.
+     * Defines the original mouse event argument.
      */
     mouseEvent: PointerEvent;
 }
 /**
- * Specifies the event arguments available on performing click event on the treemap items.
+ * Specifies the event arguments available when click event is performed on the treemap items.
  */
 export interface IClickEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -234,7 +235,7 @@ export interface IClickEventArgs extends ITreeMapEventArgs {
     mouseEvent: PointerEvent;
 }
 /**
- * Specifies the event arguments available on performing double click event on the treemap items.
+ * Specifies the event arguments available when double click action is performed on the treemap items.
  */
 export interface IDoubleClickEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -248,7 +249,7 @@ export interface IDoubleClickEventArgs extends ITreeMapEventArgs {
     mouseEvent: PointerEvent;
 }
 /**
- * Specifies the event arguments available on performing right click event on the treemap items.
+ * Specifies the event arguments available when right click action is performed on the treemap items.
  */
 export interface IRightClickEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -262,7 +263,7 @@ export interface IRightClickEventArgs extends ITreeMapEventArgs {
     mouseEvent: PointerEvent;
 }
 /**
- * Specifies the event arguments available on performing mouse over on the treemap items.
+ * Specifies the event arguments available when mouse action is performed on the treemap items.
  */
 export interface IMouseMoveEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -276,7 +277,7 @@ export interface IMouseMoveEventArgs extends ITreeMapEventArgs {
     mouseEvent: PointerEvent;
 }
 /**
- * Specifies the event arguments available when the item is selected in the treemap component.
+ * Specifies the event arguments available when the leaf item is selected in the treemap.
  */
 export interface IItemSelectedEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -293,16 +294,16 @@ export interface IItemSelectedEventArgs extends ITreeMapEventArgs {
      */
     elements: Element[];
     /**
-     * Defines the text used in the label contents.
+     * Defines the label of the current selected item.
      */
     text: string;
     /**
-     * Defines the template of the treemap item which is used to add it in the treemap control.
+     * Defines the template of the treemap item which is added as custom element for the labels in the treemap.
      */
     contentItemTemplate: string;
 }
 /**
- * Specifies the event arguments available when the item is highlighted in the treemap component.
+ * Specifies the event arguments available when the item is highlighted in the treemap.
  */
 export interface IItemHighlightEventArgs extends ITreeMapEventArgs {
     /**
@@ -321,7 +322,7 @@ export interface IItemHighlightEventArgs extends ITreeMapEventArgs {
     elements: Element[];
 }
 /**
- * Specifies the event arguments available when the tooltip is rendered in the treemap component.
+ * Specifies the event arguments available when the tooltip is rendered in the treemap.
  */
 export interface ITreeMapTooltipRenderEventArgs extends ITreeMapEventArgs {
     /** Defines the current treemap instance.
@@ -338,7 +339,7 @@ export interface ITreeMapTooltipRenderEventArgs extends ITreeMapEventArgs {
      */
     options: Object;
     /**
-     * Defines the current tooltip element.
+     * Defines the element of the current item on which tooltip is rendered.
      */
     element?: Element;
     /**
@@ -347,7 +348,8 @@ export interface ITreeMapTooltipRenderEventArgs extends ITreeMapEventArgs {
     eventArgs: PointerEvent;
 }
 /**
- * Specifies the event arguments available for the tooltip events in the treemap component.
+ * Specifies the event arguments available for the tooltip events in the treemap.
+ * @private
  */
 export interface ITreeMapTooltipArgs extends ITreeMapEventArgs {
     /**
@@ -372,7 +374,7 @@ export interface ITreeMapTooltipArgs extends ITreeMapEventArgs {
     template: string;
 }
 /**
- * Specifies the event arguments available when rendering each legend item in the treemap component.
+ * Specifies the event arguments available when rendering each legend item in the treemap.
  */
 export interface ILegendItemRenderingEventArgs extends ITreeMapEventArgs {
     /**
@@ -382,7 +384,7 @@ export interface ILegendItemRenderingEventArgs extends ITreeMapEventArgs {
      */
     treemap?: TreeMap;
     /**
-     * Specifies the shape color of the legend.
+     * Specifies the shape color of the current legend item.
      */
     fill?: string;
     /**
@@ -390,16 +392,16 @@ export interface ILegendItemRenderingEventArgs extends ITreeMapEventArgs {
      */
     shapeBorder?: BorderModel;
     /**
-     * Defines the legend shape of the treemap.
+     * Defines the shape of the current legend item.
      */
     shape?: LegendShape;
     /**
-     * Defines the URL of the legend if the shape is rendered as image.
+     * Defines the URL of the legend if the shape is set as image.
      */
     imageUrl?: string;
 }
 /**
- * Specifies the event arguments available when rendering the legend in the treemap component.
+ * Specifies the event arguments available when rendering the legend in the treemap.
  */
 export interface ILegendRenderingEventArgs extends ITreeMapEventArgs {
     /**
@@ -409,21 +411,21 @@ export interface ILegendRenderingEventArgs extends ITreeMapEventArgs {
      */
     treemap?: TreeMap;
     /**
-     * Specifies the position of the legend in the treemap component.
+     * Specifies the position of the legend in the treemap.
      */
     position?: LegendPosition;
     /**
-     * Specifies the position of the legend in the treemap component.
+     * Specifies the position of the legend in the treemap.
      */
     _changePosition?: LegendPosition;
 }
 /**
- * Specifies the event arguments available for resize event of the treemap component.
+ * Specifies the event arguments available for resize event of the treemap.
  */
 export interface IResizeEventArgs extends ITreeMapEventArgs {
-    /** Defines the size of the treemap before resizing. */
+    /** Defines the size of the treemap before resizing the window. */
     previousSize: Size;
-    /** Defines the size of the treemap after resizing. */
+    /** Defines the size of the treemap after resizing the window. */
     currentSize: Size;
     /** Defines the treemap instance.
      *
@@ -449,7 +451,8 @@ export interface IShapes {
     functionName?: string;
 }
 /**
- * Defines the theme supported for treemap component.
+ * Defines the theme supported for treemap.
+ * @private
  */
 export interface IThemeStyle {
     /**

package/src/treemap/model/pdf-export.d.ts

@@ -19,7 +19,7 @@ export declare class PdfExport {
      * @param {TreeMap} treeMap - Specifies the treemap instance.
      * @param {ExportType} type - Specifies the type of the document.
      * @param {string} fileName - Specifies the name of the document.
-     * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document to export the component.
+     * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document to export the treemap.
      * @param {boolean} allowDownload - Specifies whether to download the document or not.
      * @returns {Promise} - Returns the string.
      * @private

package/src/treemap/model/pdf-export.js

@@ -20,7 +20,7 @@ var PdfExport = /** @class */ (function () {
      * @param {TreeMap} treeMap - Specifies the treemap instance.
      * @param {ExportType} type - Specifies the type of the document.
      * @param {string} fileName - Specifies the name of the document.
-     * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document to export the component.
+     * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document to export the treemap.
      * @param {boolean} allowDownload - Specifies whether to download the document or not.
      * @returns {Promise} - Returns the string.
      * @private

package/src/treemap/treemap-model.d.ts

@@ -28,14 +28,14 @@ export interface TreeMapModel extends ComponentModel{
     allowPdfExport?: boolean;
 
     /**
-     * Sets and gets the width of the treemap component.
+     * Sets and gets the width of the treemap.
      *
      * @default null
      */
     width?: string;
 
     /**
-     * Sets and gets the height of the treemap component.
+     * Sets and gets the height of the treemap.
      *
      * @default null
      */
@@ -47,32 +47,38 @@ export interface TreeMapModel extends ComponentModel{
     border?: BorderModel;
 
     /**
-     * Sets and gets the options for customizing the margin in the treemap component.
+     * Sets and gets the options for customizing the margin in the treemap.
      */
     margin?: MarginModel;
 
     /**
      * Sets and gets the background color of the treemap.
+     * 
+     * @default null
      */
     background?: string;
 
     /**
-     * Sets and gets the options for customizing the theme of the treemap component.
+     * Sets and gets the theme styles supported for treemap. When the theme is set, the styles associated with the theme will be set in the treemap.
+     * 
+     * @default Material
      */
     theme?: TreeMapTheme;
 
     /**
-     * Sets and gets the options for customizing the title of the treemap component.
+     * Sets and gets the options for customizing the title of the treemap.
      */
     titleSettings?: TitleSettingsModel;
 
     /**
-     * Specifies the rendering type of layout of the treemap component.
+     * Specifies the rendering type for the layout of the treemap.
+     * 
+     * @default 'Squarified'
      */
     layoutType?: LayoutMode;
 
     /**
-     * Sets and gets the data source for the treemap component.
+     * Sets and gets the data source for the treemap.
      *
      * @isGenericType true
      * @isObservable true
@@ -89,27 +95,39 @@ export interface TreeMapModel extends ComponentModel{
     query?: Query;
 
     /**
-     * Sets and gets the value path of the weight from the data source, based on which the map item is rendered.
+     * Sets and gets the value path of the weight from the data source, based on which the treemap item is rendered.
+     * 
+     * @default null
      */
     weightValuePath?: string;
 
     /**
      * Sets and gets the value path from the data source, based on it color is filled in treemap.
+     * This property is used when range color mapping is set in the treemap.
+     * 
+     * @default ''
      */
     rangeColorValuePath?: string;
 
     /**
      * Sets and gets the value path from the data source, based on it color is filled in treemap.
+     * This property is used when equal color mapping is set in the treemap.
+     * 
+     * @default ''
      */
     equalColorValuePath?: string;
 
     /**
      * Sets and gets the value path from the data source, based on it color is filled in treemap.
+     * 
+     * @default null
      */
     colorValuePath?: string;
 
     /**
-     * Sets and gets the set of colors to apply in the treemap items.
+     * Sets and gets a set of colors to apply in the treemap items.
+     * 
+     * @default []
      */
     palette?: string[];
 
@@ -122,21 +140,29 @@ export interface TreeMapModel extends ComponentModel{
 
     /**
      * Enables or disables the drill down functionality in treemap.
+     * 
+     * @default false
      */
     enableDrillDown?: boolean;
 
     /**
-     * Enables or disables the connection text in the header of the treemap.
+     * Enables or disables the connection text in the header of the treemap when drill down is enabled.
+     * 
+     * @default false
      */
     enableBreadcrumb?: boolean;
 
     /**
-     * Specifies the connection between the two words.
+     * Specifies the symbol to show connection between the two words in the header of the treemap during drill down.
+     * 
+     * @default ' - '
      */
     breadcrumbConnector?: string;
 
     /**
      * Enables or disables the initial drill in the treemap.
+     * 
+     * @default false
      */
     drillDownView?: boolean;
 
@@ -151,17 +177,17 @@ export interface TreeMapModel extends ComponentModel{
     leafItemSettings?: LeafItemSettingsModel;
 
     /**
-     * Sets and gets the options for customizing the levels of the treemap.
+     * Sets and gets the options to configure and customize the levels of treemap items.
      */
     levels?: LevelSettingsModel[];
 
     /**
-     * Sets and gets the options for customizing the highlight of the treemap item on mouse over on the treemap component.
+     * Sets and gets the options to customize the highlight functionality of the treemap.
      */
     highlightSettings?: HighlightSettingsModel;
 
     /**
-     * Sets and gets the options for customizing the selection of the treemap item on click event on the treemap component.
+     * Sets and gets the options for customizing the selection functionality of the treemap.
      */
     selectionSettings?: SelectionSettingsModel;
 
@@ -197,21 +223,21 @@ export interface TreeMapModel extends ComponentModel{
     tabIndex?: number;
 
     /**
-     * Sets and gets format for the texts in the treemap.
+     * Sets and gets format for the texts in the treemap. This property accepts any global string format like 'C', 'N1', 'P' etc.
      *
      * @default null
      */
     format?: string;
 
     /**
-     * Triggers when the treemap is on load.
+     * Triggers before the treemap is rendered.
      *
      * @event load
      */
     load?: EmitType<ILoadEventArgs>;
 
     /**
-     * Triggers before the prints gets started.
+     * Triggers before the print gets started.
      *
      * @event beforePrint
      */
@@ -225,7 +251,7 @@ export interface TreeMapModel extends ComponentModel{
     loaded?: EmitType<ILoadedEventArgs>;
 
     /**
-     * Triggers before item rendering in the treemap component.
+     * Triggers before item rendering in the treemap.
      *
      * @event itemRendering
      */
@@ -260,7 +286,7 @@ export interface TreeMapModel extends ComponentModel{
     itemHighlight?: EmitType<IItemHighlightEventArgs>;
 
     /**
-     * Triggers on rendering of the tooltip in the treemap component.
+     * Triggers on rendering of the tooltip in the treemap.
      *
      * @event tooltipRendering
      */
@@ -309,7 +335,7 @@ export interface TreeMapModel extends ComponentModel{
     mouseMove?: EmitType<IMouseMoveEventArgs>;
 
     /**
-     * Triggers after resizing the treemap component.
+     * Triggers to notify the resize of the treemap when the window is resized.
      *
      * @event resize
      */