@ni/nimble-components 20.5.1 → 20.5.3

package/dist/esm/src/utilities/models/converter.d.ts

@@ -1,2 +0,0 @@
-import type { ValueConverter } from '@microsoft/fast-element';
-export declare const optionalBooleanConverter: ValueConverter;

package/dist/esm/src/utilities/models/document-element-lang.d.ts

@@ -1,9 +0,0 @@
-/**
- * Observable class to subscribe to changes in the page's lang attribute
- */
-declare class DocumentElementLang {
-    lang: string;
-    constructor();
-}
-export declare const documentElementLang: DocumentElementLang;
-export {};

package/dist/esm/src/utilities/models/tracker.d.ts

@@ -1,21 +0,0 @@
-declare type ObjectFromList<T extends readonly string[]> = {
-    [K in T extends readonly (infer U)[] ? U : never]: boolean;
-};
-/**
- * Generic Tracker which sets or resets provided flags
- */
-export declare class Tracker<TrackedItemsList extends readonly string[]> {
-    private trackedItems;
-    constructor(trackedItemsList: TrackedItemsList);
-    getTrackedItems(): ObjectFromList<TrackedItemsList>;
-    isTracked(key: keyof ObjectFromList<TrackedItemsList>): boolean;
-    track(key: keyof ObjectFromList<TrackedItemsList>): void;
-    untrack(key: keyof ObjectFromList<TrackedItemsList>): void;
-    trackAll(): void;
-    untrackAll(): void;
-    allTracked(): boolean;
-    anyTracked(): boolean;
-    noneTracked(): boolean;
-    private setAllKeys;
-}
-export {};

package/dist/esm/src/utilities/models/update-tracker.d.ts

@@ -1,7 +0,0 @@
-import { Tracker } from './tracker';
-/**
- * Generic Update Tracker Utility which extends Tracker Utility with update logic
- */
-export declare abstract class UpdateTracker<TrackedProperties extends readonly string[]> extends Tracker<TrackedProperties> {
-    protected abstract queueUpdate(): void;
-}

package/dist/esm/src/utilities/models/validator.d.ts

@@ -1,11 +0,0 @@
-import { Tracker } from './tracker';
-export interface ValidityObject {
-    [key: string]: boolean;
-}
-/**
- * Generic Validator Utility extends Tracker Utility for validation purposes
- */
-export declare class Validator<ValidationFlags extends readonly string[]> extends Tracker<ValidationFlags> {
-    isValid(): boolean;
-    getValidationFlags(): ValidityObject;
-}

package/dist/esm/src/utilities/style/appearance.d.ts

@@ -1,11 +0,0 @@
-import type { Behavior, ElementStyles } from '@microsoft/fast-element';
-/**
- * Behavior that will conditionally apply a stylesheet based on the element's
- * appearance property
- *
- * @param value - The value or values of the appearance property
- * @param styles - The styles to be applied when condition matches
- *
- * @public
- */
-export declare function appearanceBehavior<AppearanceType>(value: AppearanceType | AppearanceType[], styles: ElementStyles): Behavior;

package/dist/esm/src/utilities/style/colors.d.ts

@@ -1,8 +0,0 @@
-/**
- * Convert a hexadecimal color string to an RGBA CSS color string
- * Example: '#ff0102' to 'rgba(255, 1, 2, 1)'
- * @param hexValue Hex color (with a starting '#')
- * @param alpha CSS alpha value between 0 (transparent) and 1 (opaque)
- * @returns An rgba()-formatted CSS color string
- */
-export declare function hexToRgbaCssColor(hexValue: string, alpha: number): string;

package/dist/esm/src/utilities/style/direction.d.ts

@@ -1,34 +0,0 @@
-import type { Behavior, ElementStyles, FASTElement } from '@microsoft/fast-element';
-/**
- * Behavior to conditionally apply LTR and RTL stylesheets. To determine which to apply,
- * the behavior will use the nearest DesignSystemProvider's 'direction' design system value.
- *
- * @public
- * @example
- * ```ts
- * import { css } from "@microsoft/fast-element";
- * import { DirectionalStyleSheetBehavior } from "@microsoft/fast-foundation";
- *
- * css`
- *  // ...
- * `.withBehaviors(new DirectionalStyleSheetBehavior(
- *   css`:host { content: "ltr"}`),
- *   css`:host { content: "rtl"}`),
- * )
- * ```
- */
-export declare class DirectionalStyleSheetBehavior implements Behavior {
-    private ltr;
-    private rtl;
-    private cache;
-    constructor(ltr: ElementStyles | null, rtl: ElementStyles | null);
-    /**
-     * @internal
-     */
-    bind(source: FASTElement & HTMLElement): void;
-    /**
-     * @internal
-     */
-    unbind(source: FASTElement & HTMLElement): void;
-    private attach;
-}

package/dist/esm/src/utilities/style/focus.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file is a workaround for: https://github.com/prettier/prettier/issues/11400
- */
-/**
- * The string representing the focus selector to be used. Value
- * will be ":focus-visible" when https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo
- * is supported and ":focus" when it is not.
- *
- * @public
- */
-export declare const focusVisible: string;

package/dist/esm/src/utilities/style/multivalue-property-stylesheet-behavior.d.ts

@@ -1,37 +0,0 @@
-import { Behavior, ElementStyles, FASTElement } from '@microsoft/fast-element';
-/**
- * A behavior to add or remove a stylesheet from an element based on a property. The behavior ensures that
- * styles are applied while the property matches and that styles are not applied if the property does
- * not match.
- *
- * @public
- */
-export declare class MultivaluePropertyStyleSheetBehavior<PropertyType> implements Behavior {
-    private readonly propertyName;
-    private readonly value;
-    private readonly styles;
-    /**
-     * Constructs a {@link MultivaluePropertyStyleSheetBehavior} instance.
-     * @param propertyName - The property name to operate from.
-     * @param value - The property value or values to operate from.
-     * @param styles - The styles to coordinate with the property.
-     */
-    constructor(propertyName: string, value: PropertyType | PropertyType[], styles: ElementStyles);
-    /**
-     * Binds the behavior to the element.
-     * @param elementInstance - The element for which the property is applied.
-     */
-    bind(elementInstance: FASTElement): void;
-    /**
-     * Unbinds the behavior from the element.
-     * @param source - The element for which the behavior is unbinding.
-     */
-    unbind(source: FASTElement & HTMLElement): void;
-    /**
-     * Change event for the provided element.
-     * @param source - the element for which to attach or detach styles.
-     * @param key - the key to lookup to know if the element already has the styles
-     * @internal
-     */
-    handleChange(source: FASTElement, key: string): void;
-}

package/dist/esm/src/utilities/style/prefers-reduced-motion.d.ts

@@ -1,4 +0,0 @@
-/**
- * Singleton utility to watch the prefers-reduced-motion media value
- */
-export declare const prefersReducedMotionMediaQuery: MediaQueryList;

package/dist/esm/src/utilities/style/theme.d.ts

@@ -1,37 +0,0 @@
-import type { Behavior, ElementStyles, FASTElement } from '@microsoft/fast-element';
-import type { Theme } from '../../theme-provider/types';
-/**
- * Behavior to conditionally apply theme-based stylesheets.
- */
-declare class ThemeStyleSheetBehavior implements Behavior {
-    private readonly theme;
-    private readonly styles;
-    private readonly cache;
-    constructor(theme: Theme | Theme[], styles: ElementStyles);
-    /**
-     * @internal
-     */
-    bind(source: FASTElement & HTMLElement): void;
-    /**
-     * @internal
-     */
-    unbind(source: FASTElement & HTMLElement): void;
-}
-/**
- * Behavior to conditionally apply theme-based stylesheets. To determine which to apply,
- * the behavior will use the nearest ThemeProvider's 'theme' design system value.
- *
- * @public
- * @example
- * ```ts
- * css`
- *     // ...
- * `.withBehaviors(
- *     themeBehavior(Theme.light, css` ... `),
- *     // Apply style for both dark and color theme
- *     themeBehavior([Theme.dark, Theme.color], css` ... `)
- * )
- * ```
- */
-export declare const themeBehavior: (theme: Theme | Theme[], styles: ElementStyles) => ThemeStyleSheetBehavior;
-export {};

package/dist/esm/src/utilities/style/user-select.d.ts

@@ -1,5 +0,0 @@
-/**
- * Set user-select: none in a way that works across all supported browsers.
- * https://developer.mozilla.org/en-US/docs/Web/CSS/user-select#browser_compatibility
- */
-export declare const userSelectNone: import("@microsoft/fast-element").CSSDirective;

package/dist/esm/src/wafer-map/index.d.ts

@@ -1,123 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { ZoomTransform } from 'd3-zoom';
-import { DataManager } from './modules/data-manager';
-import { RenderingModule } from './modules/rendering';
-import { HoverDieOpacity, WaferMapColorScale, WaferMapColorScaleMode, WaferMapDie, WaferMapOrientation, WaferMapOriginLocation, WaferMapValidity } from './types';
-import { WaferMapUpdateTracker } from './modules/wafer-map-update-tracker';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-wafer-map': WaferMap;
-    }
-}
-/**
- * A nimble-styled WaferMap
- */
-export declare class WaferMap extends FoundationElement {
-    /**
-     * @internal
-     * needs to be initialized before the properties trigger changes
-     */
-    readonly waferMapUpdateTracker: WaferMapUpdateTracker;
-    originLocation: WaferMapOriginLocation;
-    gridMinX?: number;
-    gridMaxX?: number;
-    gridMinY?: number;
-    gridMaxY?: number;
-    orientation: WaferMapOrientation;
-    maxCharacters: number;
-    dieLabelsHidden: boolean;
-    dieLabelsSuffix: string;
-    colorScaleMode: WaferMapColorScaleMode;
-    /**
-     * @internal
-     */
-    readonly canvas: HTMLCanvasElement;
-    /**
-     * @internal
-     */
-    canvasContext: CanvasRenderingContext2D;
-    /**
-     * @internal
-     */
-    readonly zoomContainer: HTMLElement;
-    /**
-     * @internal
-     */
-    readonly dataManager: DataManager;
-    /**
-     * @internal
-     */
-    readonly renderer: RenderingModule;
-    /**
-     * @internal
-     */
-    renderQueued: boolean;
-    /**
-     * @internal
-     */
-    canvasWidth: number;
-    /**
-     * @internal
-     */
-    canvasHeight: number;
-    /**
-     * @internal
-     */
-    transform: ZoomTransform;
-    /**
-     * @internal
-     */
-    hoverTransform: string;
-    /**
-     * @internal
-     */
-    hoverOpacity: HoverDieOpacity;
-    /**
-     * @internal
-     */
-    hoverWidth: number;
-    /**
-     * @internal
-     */
-    hoverHeight: number;
-    /**
-     * @internal
-     */
-    hoverDie: WaferMapDie | undefined;
-    highlightedValues: string[];
-    dies: WaferMapDie[];
-    colorScale: WaferMapColorScale;
-    private readonly eventCoordinator;
-    private readonly resizeObserver;
-    private readonly waferMapValidator;
-    get validity(): WaferMapValidity;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    /**
-     * @internal
-     * Update function called when an update is queued.
-     * It will check which updates are needed based on which properties have changed.
-     * Each update represents a different starting point of the same sequential update flow.
-     * The updates snowball one after the other, this function only choses the 'altitude'.
-     * The hover does not require an event update, but it's also the last update in the sequence.
-     */
-    update(): void;
-    private createResizeObserver;
-    private originLocationChanged;
-    private gridMinXChanged;
-    private gridMaxXChanged;
-    private gridMinYChanged;
-    private gridMaxYChanged;
-    private maxCharactersChanged;
-    private dieLabelsHiddenChanged;
-    private dieLabelsSuffixChanged;
-    private colorScaleModeChanged;
-    private highlightedValuesChanged;
-    private diesChanged;
-    private colorScaleChanged;
-    private transformChanged;
-    private canvasWidthChanged;
-    private canvasHeightChanged;
-    private hoverDieChanged;
-}
-export declare const waferMapTag: string;

package/dist/esm/src/wafer-map/modules/computations.d.ts

@@ -1,39 +0,0 @@
-import { ScaleBand, ScaleQuantile } from 'd3-scale';
-import type { WaferMap } from '..';
-import { Dimensions, Margin } from '../types';
-/**
- * Computations calculates and stores different measures which are used in the Wafermap
- */
-export declare class Computations {
-    private readonly wafermap;
-    get containerDimensions(): Dimensions;
-    get dieDimensions(): Dimensions;
-    get radius(): number;
-    get margin(): Margin;
-    get horizontalScale(): ScaleBand<number>;
-    get verticalScale(): ScaleBand<number>;
-    get invertedHorizontalScale(): ScaleQuantile<number, number>;
-    get invertedVerticalScale(): ScaleQuantile<number, number>;
-    private _containerDimensions;
-    private _dieDimensions;
-    private _radius;
-    private _margin;
-    private _horizontalScale;
-    private _verticalScale;
-    private _invertedHorizontalScale;
-    private _invertedVerticalScale;
-    private readonly defaultPadding;
-    private readonly baseMarginPercentage;
-    constructor(wafermap: WaferMap);
-    updateContainerDimensions(): void;
-    updateScales(): void;
-    private gridDimensionsValidAndDefined;
-    private calculateGridDimensionsFromBoundingBox;
-    private calculateGridDimensionsFromDies;
-    private calculateContainerDimensions;
-    private createHorizontalScale;
-    private createInvertedHorizontalScale;
-    private createVerticalScale;
-    private createInvertedVerticalScale;
-    private calculateMarginAddition;
-}

package/dist/esm/src/wafer-map/modules/data-manager.d.ts

@@ -1,30 +0,0 @@
-import type { ScaleBand, ScaleQuantile } from 'd3-scale';
-import type { WaferMap } from '..';
-import type { Dimensions, Margin, DieRenderInfo, WaferMapDie, PointCoordinates } from '../types';
-/**
- * Data Manager uses Computations and Prerendering modules in order and exposes the results
- */
-export declare class DataManager {
-    private readonly wafermap;
-    get containerDimensions(): Dimensions;
-    get dieDimensions(): Dimensions;
-    get radius(): number;
-    get margin(): Margin;
-    get horizontalScale(): ScaleBand<number>;
-    get invertedHorizontalScale(): ScaleQuantile<number, number>;
-    get verticalScale(): ScaleBand<number>;
-    get invertedVerticalScale(): ScaleQuantile<number, number>;
-    get labelsFontSize(): number;
-    get diesRenderInfo(): DieRenderInfo[];
-    get data(): Map<string, WaferMapDie>;
-    private readonly computations;
-    private readonly prerendering;
-    private dataMap;
-    constructor(wafermap: WaferMap);
-    updateContainerDimensions(): void;
-    updateScales(): void;
-    updateLabelsFontSize(): void;
-    updateDiesRenderInfo(): void;
-    getWaferMapDie(point: PointCoordinates): WaferMapDie | undefined;
-    private updateDataMap;
-}

package/dist/esm/src/wafer-map/modules/event-coordinator.d.ts

@@ -1,19 +0,0 @@
-import type { WaferMapDie } from '../types';
-import type { WaferMap } from '..';
-export interface EventCoordinatorCallbacks {
-    dieSelected: (die: WaferMapDie) => void;
-}
-/**
- * EventCoordinator deals with user interactions and events
- */
-export declare class EventCoordinator {
-    private readonly wafermap;
-    private readonly zoomHandler;
-    private readonly hoverHandler;
-    constructor(wafermap: WaferMap);
-    attachEvents(): void;
-    detachEvents(): void;
-    private readonly onWheelMove;
-    private readonly onMouseMove;
-    private readonly onMouseOut;
-}

package/dist/esm/src/wafer-map/modules/hover-handler.d.ts

@@ -1,12 +0,0 @@
-import type { WaferMap } from '..';
-/**
- * HoverHandler deals with user interactions and events like hovering
- */
-export declare class HoverHandler {
-    private readonly wafermap;
-    constructor(wafermap: WaferMap);
-    mousemove(event: MouseEvent): void;
-    mouseout(): void;
-    private calculateDieCoordinates;
-    private hoversOverDie;
-}

package/dist/esm/src/wafer-map/modules/prerendering.d.ts

@@ -1,31 +0,0 @@
-import { ScaleLinear, ScaleOrdinal } from 'd3-scale';
-import type { DieRenderInfo } from '../types';
-import type { WaferMap } from '..';
-import type { DataManager } from './data-manager';
-/**
- * Prerendering prepares render-ready dies data to be used by the rendering module
- */
-export declare class Prerendering {
-    private readonly wafermap;
-    private readonly dataManager;
-    get labelsFontSize(): number;
-    get diesRenderInfo(): DieRenderInfo[];
-    d3ColorScale: ScaleOrdinal<string, string> | ScaleLinear<string, string>;
-    private _labelsFontSize;
-    private _diesRenderInfo;
-    private readonly fontSizeFactor;
-    private readonly nonHighlightedOpacity;
-    private readonly emptyDieColor;
-    private readonly nanDieColor;
-    constructor(wafermap: WaferMap, dataManager: Readonly<DataManager>);
-    updateLabelsFontSize(): void;
-    updateDiesRenderInfo(): void;
-    private calculateLabelsFontSize;
-    private createD3ColorScale;
-    private dieHasData;
-    private buildLabel;
-    private calculateOpacity;
-    private isColorScaleLinear;
-    private isColorScaleOrdinal;
-    private calculateFillStyle;
-}

package/dist/esm/src/wafer-map/modules/rendering.d.ts

@@ -1,19 +0,0 @@
-import type { WaferMap } from '..';
-/**
- * Responsible for drawing the dies inside the wafer map, adding dieText and scaling the canvas
- */
-export declare class RenderingModule {
-    private readonly wafermap;
-    private dies;
-    private readonly minDieDim;
-    constructor(wafermap: WaferMap);
-    updateSortedDiesAndDrawWafer(): void;
-    drawWafer(): void;
-    renderHover(): void;
-    private calculateHoverTransform;
-    private renderDies;
-    private renderText;
-    private clearCanvas;
-    private scaleCanvas;
-    private isDieVisible;
-}

package/dist/esm/src/wafer-map/modules/wafer-map-update-tracker.d.ts

@@ -1,25 +0,0 @@
-import type { WaferMap } from '..';
-import { UpdateTracker } from '../../utilities/models/update-tracker';
-declare const trackedItems: readonly ["canvasWidth", "canvasHeight", "originLocation", "gridMinX", "gridMaxX", "gridMinY", "gridMaxY", "dies", "maxCharacters", "colorScale", "colorScaleMode", "highlightedValues", "dieLabelsHidden", "dieLabelsSuffix", "transform", "hoverDie"];
-/**
- * Helper class to track what updates are needed to the wafer based on configuration
- * changes.
- */
-export declare class WaferMapUpdateTracker extends UpdateTracker<typeof trackedItems> {
-    private readonly wafermap;
-    private updateQueued;
-    constructor(wafermap: WaferMap);
-    get requiresEventsUpdate(): boolean;
-    get requiresContainerDimensionsUpdate(): boolean;
-    get requiresScalesUpdate(): boolean;
-    get requiresLabelsFontSizeUpdate(): boolean;
-    get requiresDiesRenderInfoUpdate(): boolean;
-    get requiresDrawnWaferUpdate(): boolean;
-    get requiresRenderHoverUpdate(): boolean;
-    /**
-     * Queues an update using the DOM and until the update is run no other updates are queued.
-     * After the update is finished, all the tracked items are reset.
-     */
-    queueUpdate(): void;
-}
-export {};

package/dist/esm/src/wafer-map/modules/wafer-map-validator.d.ts

@@ -1,14 +0,0 @@
-import type { WaferMap } from '..';
-import type { WaferMapValidity } from '../types';
-/**
- * Helper class for the nimble-wafer-map to validate that the wafer maps's grid dimensions
- * configuration is valid and report which aspects of the configuration are valid or invalid.
- */
-export declare class WaferMapValidator {
-    private readonly wafermap;
-    private invalidGridDimensions;
-    constructor(wafermap: WaferMap);
-    getValidity(): WaferMapValidity;
-    isValid(): boolean;
-    validateGridDimensions(): boolean;
-}

package/dist/esm/src/wafer-map/modules/zoom-handler.d.ts

@@ -1,16 +0,0 @@
-import type { WaferMap } from '..';
-/**
- * ZoomHandler deals with user interactions and events like zooming
- */
-export declare class ZoomHandler {
-    private readonly wafermap;
-    private zoomTransform;
-    private readonly minScale;
-    private readonly minExtentPoint;
-    private readonly extentPadding;
-    private zoomBehavior;
-    constructor(wafermap: WaferMap);
-    createZoomBehavior(): void;
-    private rescale;
-    private getZoomMax;
-}

package/dist/esm/src/wafer-map/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/wafer-map/template.d.ts

@@ -1,2 +0,0 @@
-import type { WaferMap } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<WaferMap, any>;

package/dist/esm/src/wafer-map/types.d.ts

@@ -1,67 +0,0 @@
-import type { DataManager } from './modules/data-manager';
-export declare const WaferMapOriginLocation: {
-    readonly bottomLeft: "bottom-left";
-    readonly bottomRight: "bottom-right";
-    readonly topLeft: "top-left";
-    readonly topRight: "top-right";
-};
-export declare type WaferMapOriginLocation = (typeof WaferMapOriginLocation)[keyof typeof WaferMapOriginLocation];
-export declare const WaferMapOrientation: {
-    readonly top: "top";
-    readonly bottom: "bottom";
-    readonly left: "left";
-    readonly right: "right";
-};
-export declare type WaferMapOrientation = (typeof WaferMapOrientation)[keyof typeof WaferMapOrientation];
-export declare const HoverDieOpacity: {
-    readonly show: "show";
-    readonly hide: "hide";
-};
-export declare type HoverDieOpacity = (typeof HoverDieOpacity)[keyof typeof HoverDieOpacity];
-export declare const WaferMapColorScaleMode: {
-    readonly linear: "linear";
-    readonly ordinal: "ordinal";
-};
-export declare type WaferMapColorScaleMode = (typeof WaferMapColorScaleMode)[keyof typeof WaferMapColorScaleMode];
-export interface WaferMapDie {
-    value: string;
-    x: number;
-    y: number;
-    metadata?: unknown;
-}
-export interface WaferMapColorScale {
-    colors: string[];
-    values: string[];
-}
-export interface HoverHandlerData {
-    canvas: HTMLCanvasElement;
-    rect: HTMLElement;
-    dataManager: DataManager;
-    originLocation: WaferMapOriginLocation;
-}
-export interface Dimensions {
-    readonly width: number;
-    readonly height: number;
-}
-export interface Margin {
-    readonly top: number;
-    readonly right: number;
-    readonly bottom: number;
-    readonly left: number;
-}
-export interface DieRenderInfo {
-    readonly x: number;
-    readonly y: number;
-    readonly fillStyle: string;
-    readonly text: string;
-}
-export interface PointCoordinates {
-    readonly x: number;
-    readonly y: number;
-}
-export interface ValidityObject {
-    [key: string]: boolean;
-}
-export interface WaferMapValidity extends ValidityObject {
-    readonly invalidGridDimensions: boolean;
-}