igniteui-webcomponents-charts/esm2015/lib/igc-category-highlight-layer-component.js

Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.

import { IgcCategoryAxisBaseComponent } from "./igc-category-axis-base-component";
import { IgcAnnotationLayerComponent } from "./igc-annotation-layer-component";
import { CategoryHighlightLayer } from "./CategoryHighlightLayer";
import { getAllPropertyNames, toSpinal, ensureBool } from "igniteui-webcomponents-core";
import { RegisterElementHelper } from "igniteui-webcomponents-core";
/**
 * Represents an annotation layer that targets a category axis, or all category axes in the chart.
 * If the axis contains any series that are aligned between major gridlines of the axis (column, waterfall, etc) this will render a shape that fills the current category.
 * Otherwise it will render a band with an adjustable thickness at the closest gridline to the pointer position.
 * Setting UseIterpolation to true will cause the x position in the latter case to become affixed to the x position of the pointer.
*/
export let IgcCategoryHighlightLayerComponent = /*@__PURE__*/ (() => {
    class IgcCategoryHighlightLayerComponent extends IgcAnnotationLayerComponent {
        createImplementation() {
            return new CategoryHighlightLayer();
        }
        /**
                                     * @hidden
                                     */
        get i() {
            return this._implementation;
        }
        constructor() {
            super();
        }
        connectedCallback() {
            if (super["connectedCallback"]) {
                super["connectedCallback"]();
            }
            if (this.i.connectedCallback) {
                this.i.connectedCallback();
            }
            if (!this._attached) {
                this._attached = true;
                this._flushQueuedAttributes();
            }
        }
        disconnectedCallback() {
            if (super["disconnectedCallback"]) {
                super["disconnectedCallback"]();
            }
            if (this.i.disconnectedCallback) {
                this.i.disconnectedCallback();
            }
            if (this._attached) {
                this._attached = false;
            }
        }
        static get observedAttributes() {
            if (IgcCategoryHighlightLayerComponent._observedAttributesIgcCategoryHighlightLayerComponent == null) {
                let names = getAllPropertyNames(IgcCategoryHighlightLayerComponent);
                for (let i = 0; i < names.length; i++) {
                    names[i] = toSpinal(names[i]);
                }
                IgcCategoryHighlightLayerComponent._observedAttributesIgcCategoryHighlightLayerComponent = names;
            }
            return IgcCategoryHighlightLayerComponent._observedAttributesIgcCategoryHighlightLayerComponent;
        }
        static register() {
            if (!IgcCategoryHighlightLayerComponent._isElementRegistered) {
                IgcCategoryHighlightLayerComponent._isElementRegistered = true;
                RegisterElementHelper.registerElement(IgcCategoryHighlightLayerComponent.htmlTagName, IgcCategoryHighlightLayerComponent);
            }
        }
        /**
         * Gets whether the series is an annotation layer displayed only when hovering over the chart.
        */
        get isAnnotationHoverLayer() {
            return this.i.et;
        }
        /**
         * Gets or sets the axis to target this annotation to. If null, this annotation targets all category axes simultaneously.
        */
        get targetAxis() {
            const r = this.i.aaa;
            if (r == null) {
                return null;
            }
            if (!r.externalObject) {
                let e = IgcCategoryAxisBaseComponent._createFromInternal(r);
                if (e) {
                    e._implementation = r;
                }
                r.externalObject = e;
            }
            return r.externalObject;
        }
        set targetAxis(v) {
            if (v != null && this._stylingContainer && v._styling)
                v._styling(this._stylingContainer, this, this);
            v == null ? this.i.aaa = null : this.i.aaa = v.i;
        }
        /**
         * Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position.
        */
        get useInterpolation() {
            return this.i.aad;
        }
        set useInterpolation(v) {
            this.i.aad = ensureBool(v);
            this._a("useInterpolation", this.i.aad);
        }
        /**
         * Gets or sets the width to use for the highlight region if drawing a band rather than filling a category.
        */
        get bandHighlightWidth() {
            return this.i.aae;
        }
        set bandHighlightWidth(v) {
            this.i.aae = +v;
            this._a("bandHighlightWidth", this.i.aae);
        }
        findByName(name) {
            var baseResult = super.findByName(name);
            if (baseResult) {
                return baseResult;
            }
            if (this.targetAxis && this.targetAxis.name && this.targetAxis.name == name) {
                return this.targetAxis;
            }
            return null;
        }
        _styling(container, component, parent) {
            super._styling(container, component, parent);
            this._inStyling = true;
            if (this.targetAxis && this.targetAxis._styling) {
                this.targetAxis._styling(container, component, this);
            }
            this._inStyling = false;
        }
    }
    IgcCategoryHighlightLayerComponent._observedAttributesIgcCategoryHighlightLayerComponent = null;
    IgcCategoryHighlightLayerComponent.htmlTagName = "igc-category-highlight-layer";
    IgcCategoryHighlightLayerComponent._isElementRegistered = false;
    return IgcCategoryHighlightLayerComponent;
})();