{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/all-components.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/anchor/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchor", "name": "Anchor", "members": [ { "kind": "field", "name": "underlineHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "appearance", "type": { "text": "AnchorAppearance" }, "privacy": "public" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "contentEditable", "type": { "text": "string" }, "privacy": "public" } ], "attributes": [ { "name": "underline-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "underlineHidden" }, { "name": "appearance", "type": { "text": "AnchorAppearance" }, "fieldName": "appearance" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" }, { "name": "contenteditable", "type": { "text": "string" }, "fieldName": "contentEditable" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorTag", "type": { "text": "string" }, "default": "'nimble-anchor'" } ], "exports": [ { "kind": "js", "name": "Anchor", "declaration": { "name": "Anchor", "module": "src/anchor/index.ts" } }, { "kind": "js", "name": "anchorTag", "declaration": { "name": "anchorTag", "module": "src/anchor/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor/types.ts", "declarations": [ { "kind": "variable", "name": "AnchorAppearance", "type": { "text": "{\n default: undefined,\n prominent: 'prominent'\n}" }, "default": "{ default: undefined, prominent: 'prominent' }", "description": "Anchor appearance states", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "AnchorAppearance", "declaration": { "name": "AnchorAppearance", "module": "src/anchor/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-base/index.ts", "declarations": [ { "kind": "class", "description": "Exported base class of link-like types", "name": "AnchorBase", "superclass": { "name": "FoundationAnchor", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "AnchorBase", "declaration": { "name": "AnchorBase", "module": "src/anchor-base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-button/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchor button", "name": "AnchorButton", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "ButtonAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceVariant", "type": { "text": "ButtonAppearanceVariant" }, "privacy": "public" }, { "kind": "field", "name": "contentHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "attributes": [ { "name": "appearance", "type": { "text": "ButtonAppearance" }, "fieldName": "appearance" }, { "name": "appearance-variant", "type": { "text": "ButtonAppearanceVariant" }, "fieldName": "appearanceVariant" }, { "name": "content-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "contentHidden" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorButtonTag", "type": { "text": "string" }, "default": "'nimble-anchor-button'" } ], "exports": [ { "kind": "js", "name": "AnchorButton", "declaration": { "name": "AnchorButton", "module": "src/anchor-button/index.ts" } }, { "kind": "js", "name": "anchorButtonTag", "declaration": { "name": "anchorButtonTag", "module": "src/anchor-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-button/types.ts", "declarations": [], "exports": [ { "kind": "js", "name": "ButtonAppearance", "declaration": { "name": "ButtonAppearance", "module": "../patterns/button/types" } }, { "kind": "js", "name": "ButtonAppearanceVariant", "declaration": { "name": "ButtonAppearanceVariant", "module": "../patterns/button/types" } } ] }, { "kind": "javascript-module", "path": "src/anchor-menu-item/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchor menu-item", "name": "AnchorMenuItem", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "method", "name": "setAttribute", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "qualifiedName", "type": { "text": "string" } }, { "name": "value", "type": { "text": "string" } } ] }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorMenuItemTag", "type": { "text": "string" }, "default": "'nimble-anchor-menu-item'" } ], "exports": [ { "kind": "js", "name": "AnchorMenuItem", "declaration": { "name": "AnchorMenuItem", "module": "src/anchor-menu-item/index.ts" } }, { "kind": "js", "name": "anchorMenuItemTag", "declaration": { "name": "anchorMenuItemTag", "module": "src/anchor-menu-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-step/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchor step for a stepper", "name": "AnchorStep", "members": [ { "kind": "field", "name": "severity", "type": { "text": "Severity" }, "privacy": "public", "description": "The severity state of the element", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "severityText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The severity text that will be displayed when a component is not in the default severity state", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } }, { "kind": "field", "name": "severityHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } } ], "attributes": [ { "name": "severity", "type": { "text": "AnchorStepSeverity" }, "fieldName": "severity" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "readOnly" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "mixins": [ { "name": "mixinSeverityPattern", "module": "/src/patterns/severity/types" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorStepTag", "type": { "text": "string" }, "default": "'nimble-anchor-step'" } ], "exports": [ { "kind": "js", "name": "AnchorStep", "declaration": { "name": "AnchorStep", "module": "src/anchor-step/index.ts" } }, { "kind": "js", "name": "anchorStepTag", "declaration": { "name": "anchorStepTag", "module": "src/anchor-step/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-step/types.ts", "declarations": [ { "kind": "variable", "name": "AnchorStepSeverity", "default": "Severity" } ], "exports": [ { "kind": "js", "name": "AnchorStepSeverity", "declaration": { "name": "AnchorStepSeverity", "module": "src/anchor-step/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-tab/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled link tab", "name": "AnchorTab", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information." }, { "kind": "field", "name": "ariaSelected", "type": { "text": "string" }, "privacy": "public", "default": "'false'", "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information.", "fieldName": "disabled" }, { "name": "aria-selected", "type": { "text": "string" }, "default": "'false'", "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected", "fieldName": "ariaSelected" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorTabTag", "type": { "text": "string" }, "default": "'nimble-anchor-tab'" } ], "exports": [ { "kind": "js", "name": "AnchorTab", "declaration": { "name": "AnchorTab", "module": "src/anchor-tab/index.ts" } }, { "kind": "js", "name": "anchorTabTag", "declaration": { "name": "anchorTabTag", "module": "src/anchor-tab/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-tabs/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled set of anchor tabs", "name": "AnchorTabs", "members": [ { "kind": "field", "name": "activeid", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The id of the active tab" }, { "kind": "field", "name": "activetab", "type": { "text": "HTMLElement | undefined" }, "privacy": "public", "description": "A reference to the active tab" }, { "kind": "field", "name": "tabListResizeObserver", "type": { "text": "ResizeObserver" }, "privacy": "private", "readonly": true, "default": "new ResizeObserver(entries => { let tabListVisibleWidth = entries[0]?.contentRect.width; if (tabListVisibleWidth !== undefined) { const buttonWidth = this.leftScrollButton?.clientWidth ?? 0; tabListVisibleWidth = Math.ceil(tabListVisibleWidth); if (this.showScrollButtons) { tabListVisibleWidth += buttonWidth * 2; } this.showScrollButtons = tabListVisibleWidth < this.tablist.scrollWidth; } })" }, { "kind": "field", "name": "tabIds", "type": { "text": "string[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "isDisabledElement", "privacy": "private", "readonly": true }, { "kind": "field", "name": "isHiddenElement", "privacy": "private", "readonly": true }, { "kind": "field", "name": "isFocusableElement", "privacy": "private", "readonly": true }, { "kind": "field", "name": "setTabs", "privacy": "private", "readonly": true }, { "kind": "method", "name": "getTabIds", "privacy": "private", "return": { "type": { "text": "string[]" } } }, { "kind": "field", "name": "handleTabClick", "privacy": "private", "readonly": true }, { "kind": "field", "name": "handleTabKeyDown", "privacy": "private", "readonly": true }, { "kind": "method", "name": "focusFirstOrLast", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "focusLast", "type": { "text": "boolean" } } ] }, { "kind": "field", "name": "adjustForward", "privacy": "private", "readonly": true }, { "kind": "field", "name": "adjustBackward", "privacy": "private", "readonly": true }, { "kind": "field", "name": "focusTabByIndex", "privacy": "private", "readonly": true }, { "kind": "method", "name": "getTabAnchor", "privacy": "private", "return": { "type": { "text": "HTMLAnchorElement" } }, "parameters": [ { "name": "tab", "type": { "text": "AnchorTab" } } ] } ], "attributes": [ { "name": "activeid", "type": { "text": "string | undefined" }, "description": "The id of the active tab", "fieldName": "activeid" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "anchorTabsTag", "type": { "text": "string" }, "default": "'nimble-anchor-tabs'" } ], "exports": [ { "kind": "js", "name": "AnchorTabs", "declaration": { "name": "AnchorTabs", "module": "src/anchor-tabs/index.ts" } }, { "kind": "js", "name": "anchorTabsTag", "declaration": { "name": "anchorTabsTag", "module": "src/anchor-tabs/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchor-tree-item/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchor tree item", "name": "AnchorTreeItem", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, the control will appear selected by user interaction." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information." }, { "kind": "method", "name": "isNestedItem", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Whether the tree is nested" }, { "kind": "method", "name": "selectedChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "boolean | undefined" } }, { "name": "_next", "type": { "text": "boolean" } } ] } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "When true, the control will appear selected by user interaction.", "fieldName": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information.", "fieldName": "disabled" } ], "superclass": { "name": "AnchorBase", "module": "/src/anchor-base" } }, { "kind": "variable", "name": "anchorTreeItemTag", "type": { "text": "string" }, "default": "'nimble-anchor-tree-item'" } ], "exports": [ { "kind": "js", "name": "AnchorTreeItem", "declaration": { "name": "AnchorTreeItem", "module": "src/anchor-tree-item/index.ts" } }, { "kind": "js", "name": "anchorTreeItemTag", "declaration": { "name": "anchorTreeItemTag", "module": "src/anchor-tree-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/anchored-region/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled anchored region control.", "name": "AnchoredRegion", "superclass": { "name": "FoundationAnchoredRegion", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "anchoredRegionTag", "type": { "text": "string" }, "default": "'nimble-anchored-region'" } ], "exports": [ { "kind": "js", "name": "AnchoredRegion", "declaration": { "name": "AnchoredRegion", "module": "src/anchored-region/index.ts" } }, { "kind": "js", "name": "anchoredRegionTag", "declaration": { "name": "anchoredRegionTag", "module": "src/anchored-region/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/banner/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled notification banner for persistent messages.", "name": "Banner", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "severity", "type": { "text": "BannerSeverity" }, "privacy": "public" }, { "kind": "field", "name": "titleHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "preventDismiss", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" }, { "name": "severity", "type": { "text": "BannerSeverity" }, "fieldName": "severity" }, { "name": "title-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "titleHidden" }, { "name": "prevent-dismiss", "type": { "text": "boolean" }, "default": "false", "fieldName": "preventDismiss" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "bannerTag", "type": { "text": "string" }, "default": "'nimble-banner'" } ], "exports": [ { "kind": "js", "name": "Banner", "declaration": { "name": "Banner", "module": "src/banner/index.ts" } }, { "kind": "js", "name": "bannerTag", "declaration": { "name": "bannerTag", "module": "src/banner/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/banner/types.ts", "declarations": [ { "kind": "variable", "name": "BannerSeverity", "type": { "text": "{\n default: undefined,\n error: 'error',\n warning: 'warning',\n information: 'information'\n}" }, "default": "{ default: undefined, error: 'error', warning: 'warning', information: 'information' }", "description": "Severities of banners.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "BannerSeverity", "declaration": { "name": "BannerSeverity", "module": "src/banner/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled breadcrumb", "name": "Breadcrumb", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "BreadcrumbAppearance" }, "privacy": "public" }, { "kind": "field", "name": "listResizeObserver", "type": { "text": "ResizeObserver" }, "privacy": "private", "readonly": true, "default": "new ResizeObserver(entries => { let listVisibleWidth = entries[0]?.contentRect.width; if (listVisibleWidth !== undefined) { const buttonWidth = this.leftScrollButton?.clientWidth ?? 0; listVisibleWidth = Math.ceil(listVisibleWidth); if (this.showScrollButtons) { listVisibleWidth += buttonWidth * 2; } this.showScrollButtons = listVisibleWidth < this.list.scrollWidth; } })" } ], "attributes": [ { "name": "appearance", "type": { "text": "BreadcrumbAppearance" }, "fieldName": "appearance" } ], "superclass": { "name": "FoundationBreadcrumb", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "breadcrumbTag", "type": { "text": "string" }, "default": "'nimble-breadcrumb'" } ], "exports": [ { "kind": "js", "name": "Breadcrumb", "declaration": { "name": "Breadcrumb", "module": "src/breadcrumb/index.ts" } }, { "kind": "js", "name": "breadcrumbTag", "declaration": { "name": "breadcrumbTag", "module": "src/breadcrumb/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb/types.ts", "declarations": [ { "kind": "variable", "name": "BreadcrumbAppearance", "type": { "text": "{\n default: undefined,\n prominent: 'prominent'\n}" }, "default": "{ default: undefined, prominent: 'prominent' }", "description": "Predefined icon appearance states", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "BreadcrumbAppearance", "declaration": { "name": "BreadcrumbAppearance", "module": "src/breadcrumb/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/breadcrumb-item/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled breadcrumb item", "name": "BreadcrumbItem", "superclass": { "name": "FoundationBreadcrumbItem", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "breadcrumbItemTag", "type": { "text": "string" }, "default": "'nimble-breadcrumb-item'" } ], "exports": [ { "kind": "js", "name": "BreadcrumbItem", "declaration": { "name": "BreadcrumbItem", "module": "src/breadcrumb-item/index.ts" } }, { "kind": "js", "name": "breadcrumbItemTag", "declaration": { "name": "breadcrumbItemTag", "module": "src/breadcrumb-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/button/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML button", "name": "Button", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "ButtonAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceVariant", "type": { "text": "ButtonAppearanceVariant" }, "privacy": "public" }, { "kind": "field", "name": "contentHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" } ], "attributes": [ { "name": "appearance", "type": { "text": "ButtonAppearance" }, "fieldName": "appearance" }, { "name": "appearance-variant", "type": { "text": "ButtonAppearanceVariant" }, "fieldName": "appearanceVariant" }, { "name": "content-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "contentHidden" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "superclass": { "name": "FoundationButton", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "buttonTag", "type": { "text": "string" }, "default": "'nimble-button'" } ], "exports": [ { "kind": "js", "name": "Button", "declaration": { "name": "Button", "module": "src/button/index.ts" } }, { "kind": "js", "name": "buttonTag", "declaration": { "name": "buttonTag", "module": "src/button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/button/types.ts", "declarations": [], "exports": [ { "kind": "js", "name": "ButtonAppearance", "declaration": { "name": "ButtonAppearance", "module": "../patterns/button/types" } }, { "kind": "js", "name": "ButtonAppearanceVariant", "declaration": { "name": "ButtonAppearanceVariant", "module": "../patterns/button/types" } } ] }, { "kind": "javascript-module", "path": "src/card/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled card", "name": "Card", "superclass": { "name": "FoundationCard", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "cardTag", "type": { "text": "string" }, "default": "'nimble-card'" } ], "exports": [ { "kind": "js", "name": "Card", "declaration": { "name": "Card", "module": "src/card/index.ts" } }, { "kind": "js", "name": "cardTag", "declaration": { "name": "cardTag", "module": "src/card/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/card-button/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled card button", "name": "CardButton", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" } ], "superclass": { "name": "FoundationButton", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "cardButtonTag", "type": { "text": "string" }, "default": "'nimble-card-button'" } ], "exports": [ { "kind": "js", "name": "CardButton", "declaration": { "name": "CardButton", "module": "src/card-button/index.ts" } }, { "kind": "js", "name": "cardButtonTag", "declaration": { "name": "cardButtonTag", "module": "src/card-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/checkbox/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled checkbox control.", "name": "Checkbox", "members": [ { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } } ], "attributes": [ { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" } ], "superclass": { "name": "FoundationCheckbox", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "checkboxTag", "type": { "text": "string" }, "default": "'nimble-checkbox'" } ], "exports": [ { "kind": "js", "name": "Checkbox", "declaration": { "name": "Checkbox", "module": "src/checkbox/index.ts" } }, { "kind": "js", "name": "checkboxTag", "declaration": { "name": "checkboxTag", "module": "src/checkbox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/chip/index.ts", "declarations": [ { "kind": "class", "description": "A Nimble chip component", "name": "Chip", "members": [ { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "appearance", "type": { "text": "ChipAppearance" }, "privacy": "public" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" } ], "attributes": [ { "name": "removable", "type": { "text": "boolean" }, "default": "false", "fieldName": "removable" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "appearance", "type": { "text": "ChipAppearance" }, "fieldName": "appearance" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "chipTag", "type": { "text": "string" }, "default": "'nimble-chip'" } ], "exports": [ { "kind": "js", "name": "Chip", "declaration": { "name": "Chip", "module": "src/chip/index.ts" } }, { "kind": "js", "name": "chipTag", "declaration": { "name": "chipTag", "module": "src/chip/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/chip/types.ts", "declarations": [ { "kind": "variable", "name": "ChipAppearance", "type": { "text": "{\n outline: 'outline',\n block: 'block'\n}" }, "default": "{ outline: 'outline', block: 'block' }" } ], "exports": [ { "kind": "js", "name": "ChipAppearance", "declaration": { "name": "ChipAppearance", "module": "src/chip/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/combobox/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styed HTML combobox", "name": "Combobox", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "DropdownAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceReadOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "autocomplete", "type": { "text": "ComboboxAutocomplete | undefined" }, "privacy": "public", "description": "The autocomplete attribute." }, { "kind": "field", "name": "positionAttribute", "type": { "text": "SelectPosition | undefined" }, "privacy": "public", "description": "The placement for the listbox when the combobox is open." }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The open attribute." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "Sets the placeholder value of the element, generally used to provide a hint to the user." }, { "kind": "field", "name": "position", "type": { "text": "SelectPosition | undefined" }, "privacy": "public", "description": "The current state of the calculated position of the listbox." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "privacy": "public" }, { "kind": "field", "name": "options", "type": { "text": "ListboxOption[]" }, "privacy": "public", "description": "The list of options.\n\nOverrides `Listbox.options`." }, { "kind": "field", "name": "valueUpdatedByInput", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "valueBeforeTextUpdate", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "filter", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "forcedPosition", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "The initial state of the position attribute." }, { "kind": "field", "name": "isAutocompleteInline", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "isAutocompleteList", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "isAutocompleteBoth", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "slottedOptionsChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "HTMLElement[]" } }, { "name": "next", "type": { "text": "HTMLElement[]" } } ] }, { "kind": "method", "name": "keydownHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "validate", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "{@inheritDoc (FormAssociated:interface).validate}" }, { "kind": "method", "name": "openChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "placeholderChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "positionChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_", "type": { "text": "SelectPosition | undefined" } }, { "name": "next", "type": { "text": "SelectPosition | undefined" } } ] }, { "kind": "method", "name": "regionChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "AnchoredRegion | undefined" } }, { "name": "_next", "type": { "text": "AnchoredRegion | undefined" } } ] }, { "kind": "method", "name": "controlWrapperChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "HTMLElement | undefined" } }, { "name": "_next", "type": { "text": "HTMLElement | undefined" } } ] }, { "kind": "method", "name": "ariaLabelChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_oldValue", "type": { "text": "string" } }, { "name": "_newValue", "type": { "text": "string" } } ] }, { "kind": "method", "name": "updateValue", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "shouldEmit", "optional": true, "type": { "text": "boolean" } } ], "description": "Sets the value and to match the first selected option." }, { "kind": "method", "name": "setInputToSelection", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Focus and set the content of the control based on the first selected option." }, { "kind": "method", "name": "setInlineSelection", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Focus, set and select the content of the control based on the first selected option." }, { "kind": "method", "name": "clearSelectionRange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "syncValue", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Determines if a value update should involve emitting a change event, then updates the value." }, { "kind": "method", "name": "updateInputAriaLabel", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "emitChangeIfValueUpdated", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "This will only emit a `change` event after text entry where the text in the input prior to\ntyping is different than the text present upon an attempt to commit (e.g. pressing ).\nSo, for a concrete example:\n1) User types 'Sue' (when Combobox input was blank).\n2) User presses -> 'change' event fires\n3) User deletes 'Sue'\n4) User re-types 'Sue'\n5) User presses -> NO 'change' event is fired" }, { "kind": "method", "name": "findIndexOfValidOption", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "optionText", "type": { "text": "string" } } ] }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ], "attributes": [ { "name": "appearance", "type": { "text": "DropdownAppearance" }, "fieldName": "appearance" }, { "name": "appearance-readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "appearanceReadOnly" }, { "name": "full-bleed", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullBleed" }, { "name": "autocomplete", "type": { "text": "ComboboxAutocomplete | undefined" }, "description": "The autocomplete attribute.", "fieldName": "autocomplete" }, { "name": "position", "type": { "text": "SelectPosition | undefined" }, "description": "The placement for the listbox when the combobox is open.", "fieldName": "positionAttribute" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "The open attribute.", "fieldName": "open" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Sets the placeholder value of the element, generally used to provide a hint to the user.", "fieldName": "placeholder" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FormAssociatedCombobox", "module": "/src/combobox/models/combobox-form-associated" } }, { "kind": "variable", "name": "comboboxTag", "type": { "text": "string" }, "default": "'nimble-combobox'" } ], "exports": [ { "kind": "js", "name": "Combobox", "declaration": { "name": "Combobox", "module": "src/combobox/index.ts" } }, { "kind": "js", "name": "comboboxTag", "declaration": { "name": "comboboxTag", "module": "src/combobox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/combobox/types.ts", "declarations": [], "exports": [ { "kind": "js", "name": "ComboboxAutocomplete", "declaration": { "name": "ComboboxAutocomplete", "module": "src/combobox/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/dialog/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled dialog.", "name": "Dialog", "members": [ { "kind": "field", "name": "UserDismissed", "privacy": "public", "static": true, "readonly": true, "default": "UserDismissed" }, { "kind": "field", "name": "preventDismiss", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "headerHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "footerHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "description": "True if the dialog is open/showing, false otherwise", "readonly": true }, { "kind": "field", "name": "resolveShow", "type": { "text": "(reason: CloseReason | UserDismissed) => void | undefined" }, "privacy": "private" }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "" } }, "description": "Opens the dialog" }, { "kind": "method", "name": "close", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "type": { "text": "CloseReason" }, "description": "An optional value indicating how/why the dialog was closed." } ], "description": "Closes the dialog" }, { "kind": "method", "name": "slottedFooterElementsChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "HTMLElement[] | undefined" } }, { "name": "next", "type": { "text": "HTMLElement[] | undefined" } } ] }, { "kind": "method", "name": "doResolveShow", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "type": { "text": "CloseReason | UserDismissed" } } ] } ], "attributes": [ { "name": "prevent-dismiss", "type": { "text": "boolean" }, "default": "false", "fieldName": "preventDismiss" }, { "name": "header-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "headerHidden" }, { "name": "footer-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "footerHidden" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "dialogTag", "type": { "text": "string" }, "default": "'nimble-dialog'" } ], "exports": [ { "kind": "js", "name": "UserDismissed", "declaration": { "name": "UserDismissed", "module": "src/dialog/index.ts" } }, { "kind": "js", "name": "Dialog", "declaration": { "name": "Dialog", "module": "src/dialog/index.ts" } }, { "kind": "js", "name": "dialogTag", "declaration": { "name": "dialogTag", "module": "src/dialog/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/drawer/index.ts", "declarations": [ { "kind": "class", "description": "Drawer control. Shows content in a panel on the left / right side of the screen,\nwhich animates to be visible with a slide-in / slide-out animation.", "name": "Drawer", "members": [ { "kind": "field", "name": "UserDismissed", "privacy": "public", "static": true, "readonly": true, "default": "UserDismissed" }, { "kind": "field", "name": "location", "type": { "text": "DrawerLocation" }, "privacy": "public" }, { "kind": "field", "name": "preventDismiss", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "dialog", "type": { "text": "HTMLDialogElement" }, "privacy": "public" }, { "kind": "field", "name": "closing", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "resolveShow", "type": { "text": "(reason: CloseReason | UserDismissed) => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "closeReason", "type": { "text": "CloseReason | UserDismissed" }, "privacy": "private" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "description": "True if the drawer is open, opening, or closing. Otherwise, false.", "readonly": true }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "" } }, "description": "Opens the drawer" }, { "kind": "method", "name": "close", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "type": { "text": "CloseReason" }, "description": "An optional value indicating how/why the drawer was closed." } ], "description": "Closes the drawer" }, { "kind": "method", "name": "doResolveShow", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "type": { "text": "CloseReason | UserDismissed" } } ] }, { "kind": "field", "name": "animationEndHandlerFunction", "privacy": "private", "readonly": true }, { "kind": "method", "name": "openDialog", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "closeDialog", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "triggerAnimation", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "animationEndHandler", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "location", "type": { "text": "DrawerLocation" }, "fieldName": "location" }, { "name": "prevent-dismiss", "type": { "text": "boolean" }, "default": "false", "fieldName": "preventDismiss" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "drawerTag", "type": { "text": "string" }, "default": "'nimble-drawer'" } ], "exports": [ { "kind": "js", "name": "UserDismissed", "declaration": { "name": "UserDismissed", "module": "src/drawer/index.ts" } }, { "kind": "js", "name": "Drawer", "declaration": { "name": "Drawer", "module": "src/drawer/index.ts" } }, { "kind": "js", "name": "drawerTag", "declaration": { "name": "drawerTag", "module": "src/drawer/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/drawer/types.ts", "declarations": [ { "kind": "variable", "name": "DrawerLocation", "type": { "text": "{\n left: 'left',\n right: 'right'\n}" }, "default": "{ left: 'left', right: 'right' }" } ], "exports": [ { "kind": "js", "name": "DrawerLocation", "declaration": { "name": "DrawerLocation", "module": "src/drawer/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/icon-base/index.ts", "declarations": [ { "kind": "class", "description": "The base class for icon components. Implementors:\n- Should not increase the API surface area, consumers of icons would not expect additional attributes to configure\n- Should not add interactive components to the template, expect to be visual only\n- Should respond well to sizing of the element\n- Should respond to configuration of the severity attribute and other tokens such as theme", "name": "Icon", "members": [ { "kind": "field", "name": "severity", "type": { "text": "IconSeverity" }, "privacy": "public" } ], "attributes": [ { "name": "severity", "type": { "text": "IconSeverity" }, "fieldName": "severity" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "Icon", "declaration": { "name": "Icon", "module": "src/icon-base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/icon-base/types.ts", "declarations": [ { "kind": "variable", "name": "IconSeverity", "type": { "text": "{\n default: undefined,\n error: 'error',\n warning: 'warning',\n success: 'success',\n information: 'information'\n}" }, "default": "{ default: undefined, error: 'error', warning: 'warning', success: 'success', information: 'information' }", "description": "Predefined icon appearance states", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "IconSeverity", "declaration": { "name": "IconSeverity", "module": "src/icon-base/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/icon-svg/index.ts", "declarations": [ { "kind": "class", "description": "Icon base class for the standard nimble icon set", "name": "IconSvg", "superclass": { "name": "Icon", "module": "/src/icon-base" }, "attributes": [ { "name": "severity", "type": { "text": "IconSeverity" }, "fieldName": "severity", "inheritedFrom": { "name": "Icon", "module": "src/icon-base/index.ts" } } ], "members": [ { "kind": "field", "name": "severity", "type": { "text": "IconSeverity" }, "privacy": "public", "inheritedFrom": { "name": "Icon", "module": "src/icon-base/index.ts" } } ] }, { "kind": "function", "name": "registerIconSvg", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "baseName", "type": { "text": "string" } }, { "name": "iconClass", "type": { "text": "typeof IconSvg" } } ] } ], "exports": [ { "kind": "js", "name": "IconSvg", "declaration": { "name": "IconSvg", "module": "src/icon-svg/index.ts" } }, { "kind": "js", "name": "registerIconSvg", "declaration": { "name": "registerIconSvg", "module": "src/icon-svg/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/list-option/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML listbox option", "name": "ListOption", "members": [ { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The hidden state of the element." }, { "kind": "method", "name": "getListOptionOwner", "privacy": "private", "return": { "type": { "text": "ListOptionOwner | undefined" } } }, { "kind": "method", "name": "isListOptionOwner", "privacy": "private", "return": { "type": { "text": "parent is ListOptionOwner" } }, "parameters": [ { "name": "parent", "type": { "text": "HTMLElement | null" } } ] } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "The hidden state of the element.", "fieldName": "hidden" } ], "superclass": { "name": "FoundationListboxOption", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "listOptionTag", "type": { "text": "string" }, "default": "'nimble-list-option'" } ], "exports": [ { "kind": "js", "name": "ListOption", "declaration": { "name": "ListOption", "module": "src/list-option/index.ts" } }, { "kind": "js", "name": "listOptionTag", "declaration": { "name": "listOptionTag", "module": "src/list-option/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/list-option-group/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML listbox option group", "name": "ListOptionGroup", "members": [ { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The label for the group." }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The hidden state of the element." }, { "kind": "field", "name": "hiddenOptions", "type": { "text": "Set" }, "privacy": "private", "readonly": true, "default": "new Set()" }, { "kind": "method", "name": "listOptionsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "ListOption[] | undefined" } }, { "name": "next", "type": { "text": "ListOption[]" } } ] } ], "attributes": [ { "name": "label", "type": { "text": "string | undefined" }, "description": "The label for the group.", "fieldName": "label" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "The hidden state of the element.", "fieldName": "hidden" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "listOptionGroupTag", "type": { "text": "string" }, "default": "'nimble-list-option-group'" } ], "exports": [ { "kind": "js", "name": "ListOptionGroup", "declaration": { "name": "ListOptionGroup", "module": "src/list-option-group/index.ts" } }, { "kind": "js", "name": "listOptionGroupTag", "declaration": { "name": "listOptionGroupTag", "module": "src/list-option-group/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/menu/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled menu", "name": "Menu", "superclass": { "name": "FoundationMenu", "module": "/src/menu/menu.foundation" } }, { "kind": "variable", "name": "menuTag", "type": { "text": "string" }, "default": "'nimble-menu'" } ], "exports": [ { "kind": "js", "name": "Menu", "declaration": { "name": "Menu", "module": "src/menu/index.ts" } }, { "kind": "js", "name": "menuTag", "declaration": { "name": "menuTag", "module": "src/menu/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/menu/menu.foundation.ts", "declarations": [ { "kind": "class", "description": "A Menu Custom HTML Element.\nImplements the https://www.w3.org/TR/wai-aria-1.1/#menu | ARIA menu .", "name": "Menu", "slots": [ { "description": "The default slot for the menu items", "name": "" } ], "members": [ { "kind": "field", "name": "focusableElementRoles", "type": { "text": "{ [key: string]: string }" }, "privacy": "private", "static": true, "readonly": true, "default": "roleForMenuItem" }, { "kind": "field", "name": "menuItems", "type": { "text": "Element[] | undefined" }, "privacy": "private" }, { "kind": "field", "name": "expandedItem", "type": { "text": "MenuItem | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "focusIndex", "type": { "text": "number" }, "privacy": "private", "default": "-1", "description": "The index of the focusable element in the items array\ndefaults to -1" }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Focuses the first item in the menu." }, { "kind": "method", "name": "collapseExpandedItem", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Collapses any expanded menu items." }, { "kind": "field", "name": "handleItemFocus", "privacy": "private", "readonly": true }, { "kind": "field", "name": "handleExpandedChanged", "privacy": "private", "readonly": true }, { "kind": "field", "name": "removeItemListeners", "privacy": "private", "readonly": true }, { "kind": "method", "name": "itemsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "itemIconsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "oldIcons", "type": { "text": "Element[]" } }, { "name": "newIcons", "type": { "text": "Element[]" } } ] }, { "kind": "field", "name": "setItems", "privacy": "private", "readonly": true }, { "kind": "field", "name": "changeHandler", "privacy": "private", "readonly": true, "description": "handle change from child element" }, { "kind": "method", "name": "domChildren", "privacy": "private", "return": { "type": { "text": "Element[]" } }, "description": "get an array of valid DOM children" }, { "kind": "field", "name": "isMenuItemElement", "privacy": "private", "readonly": true, "description": "check if the item is a menu item" }, { "kind": "field", "name": "isFocusableElement", "privacy": "private", "readonly": true, "description": "check if the item is focusable" }, { "kind": "method", "name": "setFocus", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "focusIndex", "type": { "text": "number" } }, { "name": "adjustment", "type": { "text": "number" } } ] } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "Menu", "declaration": { "name": "Menu", "module": "src/menu/menu.foundation.ts" } } ] }, { "kind": "javascript-module", "path": "src/menu-button/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled menu button control.", "name": "MenuButton", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "ButtonAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceVariant", "type": { "text": "ButtonAppearanceVariant" }, "privacy": "public" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "contentHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Specifies whether or not the menu is open." }, { "kind": "field", "name": "position", "type": { "text": "MenuButtonPosition" }, "privacy": "public", "description": "Configures where the menu should be placed relative to the button that opens the menu." }, { "kind": "field", "name": "focusLastItemWhenOpened", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "Used to maintain the internal state of whether the last menu item should be focused instead\nof the first menu item the next time the menu is opened." }, { "kind": "method", "name": "toggleButtonChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "ToggleButton | undefined" } }, { "name": "_next", "type": { "text": "ToggleButton | undefined" } } ] }, { "kind": "method", "name": "regionChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "AnchoredRegion | undefined" } }, { "name": "_next", "type": { "text": "AnchoredRegion | undefined" } } ] }, { "kind": "method", "name": "openChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "boolean | undefined" } }, { "name": "_next", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "regionLoadedHandler", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focusoutHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "toggleButtonCheckedChangeHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "toggleButtonKeyDownHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "menuKeyDownHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "setOpen", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newValue", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "getMenu", "privacy": "private", "return": { "type": { "text": "HTMLElement | undefined" } } }, { "kind": "method", "name": "isSlotElement", "privacy": "private", "return": { "type": { "text": "element is HTMLSlotElement" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement | undefined" } } ] }, { "kind": "method", "name": "focusMenu", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focusLastMenuItem", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "menuChangeHandler", "privacy": "private", "readonly": true } ], "attributes": [ { "name": "appearance", "type": { "text": "ButtonAppearance" }, "fieldName": "appearance" }, { "name": "appearance-variant", "type": { "text": "ButtonAppearanceVariant" }, "fieldName": "appearanceVariant" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "content-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "contentHidden" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Specifies whether or not the menu is open.", "fieldName": "open" }, { "name": "position", "type": { "text": "MenuButtonPosition" }, "description": "Configures where the menu should be placed relative to the button that opens the menu.", "fieldName": "position" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "menuButtonTag", "type": { "text": "string" }, "default": "'nimble-menu-button'" } ], "exports": [ { "kind": "js", "name": "MenuButton", "declaration": { "name": "MenuButton", "module": "src/menu-button/index.ts" } }, { "kind": "js", "name": "menuButtonTag", "declaration": { "name": "menuButtonTag", "module": "src/menu-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/menu-button/types.ts", "declarations": [ { "kind": "variable", "name": "MenuButtonPosition", "type": { "text": "{\n above: 'above',\n below: 'below',\n auto: 'auto'\n}" }, "default": "{ above: 'above', below: 'below', auto: 'auto' }", "description": "The options of where to position the menu relative to the menu button." } ], "exports": [ { "kind": "js", "name": "ButtonAppearance", "declaration": { "name": "ButtonAppearance", "module": "../patterns/button/types" } }, { "kind": "js", "name": "ButtonAppearanceVariant", "declaration": { "name": "ButtonAppearanceVariant", "module": "../patterns/button/types" } }, { "kind": "js", "name": "MenuButtonPosition", "declaration": { "name": "MenuButtonPosition", "module": "src/menu-button/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/menu-item/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled menu-item", "name": "MenuItem", "superclass": { "name": "FoundationMenuItem", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "menuItemTag", "type": { "text": "string" }, "default": "'nimble-menu-item'" } ], "exports": [ { "kind": "js", "name": "MenuItem", "declaration": { "name": "MenuItem", "module": "src/menu-item/index.ts" } }, { "kind": "js", "name": "menuItemTag", "declaration": { "name": "menuItemTag", "module": "src/menu-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/number-field/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML number input", "name": "NumberField", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "NumberFieldAppearance" }, "privacy": "public" }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "appearanceReadOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "decimalSeparator", "type": { "text": "string" }, "privacy": "private", "default": "'.'" }, { "kind": "field", "name": "inputFilterRegExp", "privacy": "private" }, { "kind": "field", "name": "langSubscriber", "type": { "text": "DesignTokenSubscriber" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => this.updateDecimalSeparatorAndInputFilter() }" }, { "kind": "method", "name": "sanitizeInput", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "inputText", "type": { "text": "string" } } ] }, { "kind": "method", "name": "syncValueFromInnerControl", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "syncValueToInnerControl", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateDecimalSeparatorAndInputFilter", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getSeparatorForLanguange", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "language", "type": { "text": "string" } } ] }, { "kind": "method", "name": "buildFilterRegExp", "privacy": "private", "return": { "type": { "text": "RegExp" } }, "parameters": [ { "name": "decimalSeparator", "type": { "text": "string" } } ] }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ], "attributes": [ { "name": "appearance", "type": { "text": "NumberFieldAppearance" }, "fieldName": "appearance" }, { "name": "full-bleed", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullBleed" }, { "name": "appearance-readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "appearanceReadOnly" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FoundationNumberField", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "numberFieldTag", "type": { "text": "string" }, "default": "'nimble-number-field'" } ], "exports": [ { "kind": "js", "name": "NumberField", "declaration": { "name": "NumberField", "module": "src/number-field/index.ts" } }, { "kind": "js", "name": "numberFieldTag", "declaration": { "name": "numberFieldTag", "module": "src/number-field/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/number-field/types.ts", "declarations": [ { "kind": "variable", "name": "NumberFieldAppearance", "type": { "text": "{\n underline: 'underline',\n outline: 'outline',\n block: 'block',\n frameless: 'frameless'\n}" }, "default": "{ underline: 'underline', outline: 'outline', block: 'block', frameless: 'frameless' }", "description": "Values for the 'appearance' property of the number field" } ], "exports": [ { "kind": "js", "name": "NumberFieldAppearance", "declaration": { "name": "NumberFieldAppearance", "module": "src/number-field/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/radio/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled radio button", "name": "Radio", "superclass": { "name": "FoundationRadio", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "radioTag", "type": { "text": "string" }, "default": "'nimble-radio'" } ], "exports": [ { "kind": "js", "name": "Radio", "declaration": { "name": "Radio", "module": "src/radio/index.ts" } }, { "kind": "js", "name": "radioTag", "declaration": { "name": "radioTag", "module": "src/radio/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/radio-group/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled grouping element for radio buttons", "name": "RadioGroup", "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FoundationRadioGroup", "package": "@ni/fast-foundation" }, "members": [ { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ] }, { "kind": "variable", "name": "radioGroupTag", "type": { "text": "string" }, "default": "'nimble-radio-group'" } ], "exports": [ { "kind": "js", "name": "Orientation", "declaration": { "name": "Orientation", "module": "src/radio-group/index.ts" } }, { "kind": "js", "name": "RadioGroup", "declaration": { "name": "RadioGroup", "module": "src/radio-group/index.ts" } }, { "kind": "js", "name": "radioGroupTag", "declaration": { "name": "radioGroupTag", "module": "src/radio-group/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/select/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML select.", "name": "Select", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "DropdownAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceReadOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "positionAttribute", "type": { "text": "SelectPosition | undefined" }, "privacy": "public", "description": "Reflects the placement for the listbox when the select is open." }, { "kind": "field", "name": "filterMode", "type": { "text": "FilterMode" }, "privacy": "public" }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "loadingVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "position", "type": { "text": "SelectPosition | undefined" }, "privacy": "public", "description": "Holds the current state for the calculated position of the listbox." }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "forcedPosition", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "openActiveIndex", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "selectedOptionObserver", "privacy": "private", "readonly": true, "default": "new MutationObserver(() => { this.updateDisplayValue(); })" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "privacy": "public" }, { "kind": "method", "name": "multipleChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "boolean | undefined" }, "description": "the previous multiple value" }, { "name": "next", "type": { "text": "boolean" }, "description": "the current multiple value" } ], "description": "Sets the multiple property on the proxy element." }, { "kind": "method", "name": "setSelectedOptions", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focusAndScrollOptionIntoView", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getTypeaheadMatches", "privacy": "protected", "return": { "type": { "text": "ListboxOption[]" } } }, { "kind": "method", "name": "positionChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_", "type": { "text": "SelectPosition | undefined" } }, { "name": "next", "type": { "text": "SelectPosition | undefined" } } ] }, { "kind": "method", "name": "openChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getSlottedOptions", "privacy": "private", "return": { "type": { "text": "ListboxOption[]" } }, "parameters": [ { "name": "slottedElements", "type": { "text": "Element[] | undefined" } } ] }, { "kind": "method", "name": "setActiveOption", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newActiveIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "focusAndScrollActiveOptionIntoView", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getPlaceholderOption", "privacy": "private", "return": { "type": { "text": "ListOption | undefined" } } }, { "kind": "method", "name": "setPositioning", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateAdjacentSeparatorState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "ListOptionGroup | ListOption" } } ] }, { "kind": "method", "name": "setTopSeparatorState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "ListOptionGroup | ListOption | null" } }, { "name": "visible", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "setBottomSeparatorState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "ListOptionGroup | ListOption | null" } }, { "name": "visible", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "getPreviousVisibleOptionOrGroup", "privacy": "private", "return": { "type": { "text": "ListOption | ListOptionGroup | null" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "getNextVisibleOptionOrGroup", "privacy": "private", "return": { "type": { "text": "ListOption | ListOptionGroup | null" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "isOptionHiddenOrFilteredOut", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "option", "type": { "text": "ListOption" } } ] }, { "kind": "method", "name": "filterMatchesText", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "filterOptions", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Filter available options by text value." }, { "kind": "method", "name": "getGroupOptions", "privacy": "private", "return": { "type": { "text": "ListOption[]" } }, "parameters": [ { "name": "group", "type": { "text": "ListOptionGroup" } } ] }, { "kind": "method", "name": "clearSelect", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "filterChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "emitFilterInputEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "initializeOpenState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "observeSelectedOptionTextContent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ], "attributes": [ { "name": "appearance", "type": { "text": "DropdownAppearance" }, "fieldName": "appearance" }, { "name": "appearance-readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "appearanceReadOnly" }, { "name": "full-bleed", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullBleed" }, { "name": "position", "type": { "text": "SelectPosition | undefined" }, "description": "Reflects the placement for the listbox when the select is open.", "fieldName": "positionAttribute" }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode" }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "fieldName": "clearable" }, { "name": "loading-visible", "type": { "text": "boolean" }, "default": "false", "fieldName": "loadingVisible" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FormAssociatedSelect", "module": "/src/select/models/select-form-associated" } }, { "kind": "variable", "name": "selectTag", "type": { "text": "string" }, "default": "'nimble-select'" } ], "exports": [ { "kind": "js", "name": "Select", "declaration": { "name": "Select", "module": "src/select/index.ts" } }, { "kind": "js", "name": "selectTag", "declaration": { "name": "selectTag", "module": "src/select/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/select/types.ts", "declarations": [ { "kind": "variable", "name": "FilterMode", "type": { "text": "{\n none: undefined,\n standard: 'standard',\n manual: 'manual'\n}" }, "default": "{ none: undefined, standard: 'standard', manual: 'manual' }", "description": "Types of select filter mode.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "DropdownAppearance", "declaration": { "name": "DropdownAppearance", "module": "../patterns/dropdown/types" } }, { "kind": "js", "name": "FilterMode", "declaration": { "name": "FilterMode", "module": "src/select/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/spinner/index.ts", "declarations": [ { "kind": "class", "description": "A Nimble-styled spinner component.\nA spinner is an animating indicator that can be placed in a particular region of a page to represent loading progress, or an ongoing operation, of an indeterminate / unknown duration.", "name": "Spinner", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "SpinnerAppearance" }, "privacy": "public" } ], "attributes": [ { "name": "appearance", "type": { "text": "SpinnerAppearance" }, "fieldName": "appearance" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "spinnerTag", "type": { "text": "string" }, "default": "'nimble-spinner'" } ], "exports": [ { "kind": "js", "name": "Spinner", "declaration": { "name": "Spinner", "module": "src/spinner/index.ts" } }, { "kind": "js", "name": "spinnerTag", "declaration": { "name": "spinnerTag", "module": "src/spinner/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/spinner/types.ts", "declarations": [ { "kind": "variable", "name": "SpinnerAppearance", "type": { "text": "{\n default: undefined,\n accent: 'accent'\n}" }, "default": "{ default: undefined, accent: 'accent' }", "description": "Types of spinner appearance.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "SpinnerAppearance", "declaration": { "name": "SpinnerAppearance", "module": "src/spinner/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/step/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled step for a stepper", "name": "Step", "members": [ { "kind": "field", "name": "severity", "type": { "text": "Severity" }, "privacy": "public", "description": "The severity state of the element", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "severityText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The severity text that will be displayed when a component is not in the default severity state", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } }, { "kind": "field", "name": "severityHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } } ], "attributes": [ { "name": "severity", "type": { "text": "StepSeverity" }, "fieldName": "severity" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "readOnly" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "mixins": [ { "name": "mixinSeverityPattern", "module": "/src/patterns/severity/types" } ], "superclass": { "name": "FoundationButton", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "stepTag", "type": { "text": "string" }, "default": "'nimble-step'" } ], "exports": [ { "kind": "js", "name": "Step", "declaration": { "name": "Step", "module": "src/step/index.ts" } }, { "kind": "js", "name": "stepTag", "declaration": { "name": "stepTag", "module": "src/step/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/step/types.ts", "declarations": [ { "kind": "variable", "name": "StepSeverity", "default": "Severity" } ], "exports": [ { "kind": "js", "name": "StepSeverity", "declaration": { "name": "StepSeverity", "module": "src/step/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/stepper/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled stepper", "name": "Stepper", "members": [ { "kind": "field", "name": "orientation", "type": { "text": "StepperOrientation" }, "privacy": "public" }, { "kind": "field", "name": "listIntersectionObserver", "type": { "text": "IntersectionObserver | undefined" }, "privacy": "private" }, { "kind": "method", "name": "orientationChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stepsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateStepInternals", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleListOverflow", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "orientation", "type": { "text": "StepperOrientation" }, "fieldName": "orientation" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "stepperTag", "type": { "text": "string" }, "default": "'nimble-stepper'" } ], "exports": [ { "kind": "js", "name": "Stepper", "declaration": { "name": "Stepper", "module": "src/stepper/index.ts" } }, { "kind": "js", "name": "stepperTag", "declaration": { "name": "stepperTag", "module": "src/stepper/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/stepper/types.ts", "declarations": [ { "kind": "variable", "name": "StepperOrientation", "default": "Orientation" } ], "exports": [ { "kind": "js", "name": "StepperOrientation", "declaration": { "name": "StepperOrientation", "module": "src/stepper/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/switch/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled switch control.", "name": "Switch", "superclass": { "name": "FoundationSwitch", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "switchTag", "type": { "text": "string" }, "default": "'nimble-switch'" } ], "exports": [ { "kind": "js", "name": "Switch", "declaration": { "name": "Switch", "module": "src/switch/index.ts" } }, { "kind": "js", "name": "switchTag", "declaration": { "name": "switchTag", "module": "src/switch/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tab/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled HTML tab", "name": "Tab", "superclass": { "name": "FoundationTab", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "tabTag", "type": { "text": "string" }, "default": "'nimble-tab'" } ], "exports": [ { "kind": "js", "name": "Tab", "declaration": { "name": "Tab", "module": "src/tab/index.ts" } }, { "kind": "js", "name": "tabTag", "declaration": { "name": "tabTag", "module": "src/tab/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tab-panel/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled tab panel", "name": "TabPanel", "superclass": { "name": "FoundationTabPanel", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "tabPanelTag", "type": { "text": "string" }, "default": "'nimble-tab-panel'" } ], "exports": [ { "kind": "js", "name": "TabPanel", "declaration": { "name": "TabPanel", "module": "src/tab-panel/index.ts" } }, { "kind": "js", "name": "tabPanelTag", "declaration": { "name": "tabPanelTag", "module": "src/tab-panel/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled table.", "name": "Table", "members": [ { "kind": "field", "name": "idFieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "parentIdFieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "selectionMode", "type": { "text": "TableRowSelectionMode" }, "privacy": "public" }, { "kind": "field", "name": "actionMenusPreserveSelection", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "validity", "type": { "text": "TableValidity" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "windowShiftKeyDown", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "table", "type": { "text": "TanStackTable>" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "options", "type": { "text": "TanStackTableOptionsResolved>" }, "privacy": "private", "default": "{ data: [], onStateChange: (_: TanStackUpdater) => {}, onRowSelectionChange: this.handleRowSelectionChange, onExpandedChange: this.handleExpandedChange, getCoreRowModel: tanStackGetCoreRowModel(), getSortedRowModel: tanStackGetSortedRowModel(), getGroupedRowModel: tanStackGetGroupedRowModel(), getExpandedRowModel: tanStackGetExpandedRowModel(), getRowCanExpand: this.getRowCanExpand, getIsRowExpanded: this.getIsRowExpanded, getSubRows: r => r.subRows, columns: [], state: { rowSelection: {}, grouping: [], expanded: true // Workaround until we can apply a fix to TanStack regarding leveraging our getIsRowExpanded implementation }, enableRowSelection: row => !row.getIsGrouped(), enableMultiRowSelection: false, enableSubRowSelection: false, enableSorting: true, enableGrouping: true, renderFallbackValue: null, autoResetAll: false }" }, { "kind": "field", "name": "tableValidator", "privacy": "private", "readonly": true, "default": "new TableValidator()" }, { "kind": "field", "name": "tableUpdateTracker", "privacy": "private", "readonly": true, "default": "new TableUpdateTracker(this)" }, { "kind": "field", "name": "selectionManager", "type": { "text": "InteractiveSelectionManager" }, "privacy": "private", "readonly": true, "default": "new InteractiveSelectionManager( this.table, this.selectionMode, this.actionMenusPreserveSelection )" }, { "kind": "field", "name": "dataHierarchyManager", "type": { "text": "DataHierarchyManager | undefined" }, "privacy": "private" }, { "kind": "field", "name": "expansionManager", "type": { "text": "ExpansionManager" }, "privacy": "private", "readonly": true, "default": "new ExpansionManager(this.table)" }, { "kind": "field", "name": "columnNotifiers", "type": { "text": "Notifier[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "layoutManagerNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_rowHeight", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "isInitialized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "ignoreSelectionChangeEvents", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "requestedSlots", "type": { "text": "Map<\n string,\n { recordId: string, uniqueSlot: string }\n >" }, "privacy": "private", "readonly": true, "default": "new Map()" }, { "kind": "field", "name": "borderWidthSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof borderWidth\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateRowHeight(); } }" }, { "kind": "field", "name": "controlHeightSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof controlHeight\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateRowHeight(); } }" }, { "kind": "field", "name": "actionMenuSlots", "type": { "text": "string[]" }, "privacy": "private", "default": "[]" }, { "kind": "method", "name": "setData", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "newData", "type": { "text": "readonly TData[]" } } ] }, { "kind": "method", "name": "getSelectedRecordIds", "privacy": "public", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "setSelectedRecordIds", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "recordIds", "type": { "text": "readonly string[]" } } ] }, { "kind": "method", "name": "setRecordHierarchyOptions", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "hierarchyOptions", "type": { "text": "TableSetRecordHierarchyOptions[]" } } ] }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "ariaMultiSelectable", "type": { "text": "'true' | 'false' | null" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "selectionModeChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "string | undefined" } }, { "name": "_next", "type": { "text": "string | undefined" } } ] }, { "kind": "method", "name": "actionMenusPreserveSelectionChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "boolean" } }, { "name": "_next", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "idFieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "string | undefined" } }, { "name": "_next", "type": { "text": "string | undefined" } } ] }, { "kind": "method", "name": "parentIdFieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "string | undefined" } }, { "name": "_next", "type": { "text": "string | undefined" } } ] }, { "kind": "method", "name": "columnsChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_prev", "type": { "text": "TableColumn[] | undefined" } }, { "name": "_next", "type": { "text": "TableColumn[]" } } ] }, { "kind": "method", "name": "updateRequestedSlotsForOpeningActionMenu", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "openActionMenuRecordId", "type": { "text": "string" } } ] }, { "kind": "method", "name": "handleActionMenuBeforeToggleEvent", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "rowIndex", "type": { "text": "number" } }, { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleRowActionMenuToggleEvent", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "getActionMenuToggleEventDetail", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "originalEvent", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "onViewPortScroll", "privacy": "private", "readonly": true }, { "kind": "field", "name": "onKeyDown", "privacy": "private", "readonly": true }, { "kind": "field", "name": "onKeyUp", "privacy": "private", "readonly": true }, { "kind": "field", "name": "onBlur", "privacy": "private", "readonly": true }, { "kind": "method", "name": "removeColumnObservers", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "initialize", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "processPendingUpdates", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "observeColumns", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getColumnsParticipatingInSorting", "privacy": "private", "return": { "type": { "text": "TableColumn[]" } } }, { "kind": "method", "name": "getColumnsParticipatingInGrouping", "privacy": "private", "return": { "type": { "text": "TableColumn[]" } } }, { "kind": "method", "name": "childItemsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnsFromChildItems", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "updateTanStack", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateActionMenuSlots", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validateWithData", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "data", "type": { "text": "readonly TData[]" } } ] }, { "kind": "method", "name": "emitColumnConfigurationChangeEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "emitSelectionChangeEvent", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "selectionStateChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectionCheckboxChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setSelectionCheckboxState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isHierarchyEnabled", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "refreshRows", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getRequestedSlotsByRecordId", "privacy": "private", "return": { "type": { "text": "{\n [recordId: string]: SlotMetadata[]\n }" } } }, { "kind": "method", "name": "getTableSelectionState", "privacy": "private", "return": { "type": { "text": "TableRowSelectionState" } } }, { "kind": "method", "name": "getRowSelectionState", "privacy": "private", "return": { "type": { "text": "TableRowSelectionState" } }, "parameters": [ { "name": "row", "type": { "text": "TanStackRow>" } } ] }, { "kind": "method", "name": "getGroupedRowSelectionState", "privacy": "private", "return": { "type": { "text": "TableRowSelectionState" } }, "parameters": [ { "name": "groupedRow", "type": { "text": "TanStackRow>" } } ] }, { "kind": "method", "name": "getGroupRowColumn", "privacy": "private", "return": { "type": { "text": "TableColumn | undefined" } }, "parameters": [ { "name": "row", "type": { "text": "TanStackRow>" } } ] }, { "kind": "method", "name": "updateTableOptions", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "updatedOptions", "type": { "text": "Partial>>" } } ] }, { "kind": "field", "name": "getRowCanExpand", "privacy": "private", "readonly": true }, { "kind": "field", "name": "getIsRowExpanded", "privacy": "private", "readonly": true }, { "kind": "field", "name": "handleRowSelectionChange", "type": { "text": "TanStackOnChangeFn" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "handleExpandedChange", "type": { "text": "TanStackOnChangeFn" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "toggleRowExpanded", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "rowIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "calculateTanStackSortState", "privacy": "private", "return": { "type": { "text": "TanStackSortingState" } } }, { "kind": "method", "name": "calculateTanStackGroupingState", "privacy": "private", "return": { "type": { "text": "TanStackGroupingState" } } }, { "kind": "method", "name": "calculateTanStackRowIdFunction", "privacy": "private", "return": { "type": { "text": "((\n originalRow: TableNode,\n index: number,\n parent?: TanStackRow>\n ) => string)\n | undefined" } } }, { "kind": "method", "name": "calculateTanStackColumns", "privacy": "private", "return": { "type": { "text": "TanStackColumnDef>[]" } } }, { "kind": "method", "name": "calculateTanStackSelectionState", "privacy": "private", "return": { "type": { "text": "TanStackRowSelectionState" } }, "parameters": [ { "name": "recordIdsToSelect", "type": { "text": "readonly string[]" } } ] }, { "kind": "method", "name": "updateRowHeight", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "virtualizer", "default": "new Virtualizer(this, this.table)" }, { "kind": "field", "name": "keyboardNavigationManager", "default": "new KeyboardNavigationManager( this, this.virtualizer )" }, { "kind": "field", "name": "layoutManager", "default": "new TableLayoutManager(this)" } ], "attributes": [ { "name": "id-field-name", "type": { "text": "string | undefined" }, "fieldName": "idFieldName" }, { "name": "parent-id-field-name", "type": { "text": "string | undefined" }, "fieldName": "parentIdFieldName" }, { "name": "selection-mode", "type": { "text": "TableRowSelectionMode" }, "fieldName": "selectionMode" }, { "name": "action-menus-preserve-selection", "type": { "text": "boolean" }, "default": "false", "fieldName": "actionMenusPreserveSelection" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "isGroupRow" }, { "kind": "variable", "name": "tableTag", "type": { "text": "string" }, "default": "'nimble-table'" } ], "exports": [ { "kind": "js", "name": "Table", "declaration": { "name": "Table", "module": "src/table/index.ts" } }, { "kind": "js", "name": "tableTag", "declaration": { "name": "tableTag", "module": "src/table/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/types.ts", "declarations": [ { "kind": "variable", "name": "TableRecordDelayedHierarchyState", "type": { "text": "{\n none: undefined,\n canLoadChildren: 'can-load-children',\n loadingChildren: 'loading-children'\n}" }, "default": "{ none: undefined, canLoadChildren: 'can-load-children', loadingChildren: 'loading-children' }" }, { "kind": "variable", "name": "TableColumnSortDirection", "type": { "text": "{\n none: undefined,\n ascending: 'ascending',\n descending: 'descending'\n}" }, "default": "{ none: undefined, ascending: 'ascending', descending: 'descending' }", "description": "The possible directions a table column can be sorted in." }, { "kind": "variable", "name": "TableRowSelectionMode", "type": { "text": "{\n none: undefined,\n single: 'single',\n multiple: 'multiple'\n}" }, "default": "{ none: undefined, single: 'single', multiple: 'multiple' }", "description": "The selection modes of rows in the table." }, { "kind": "variable", "name": "TableFocusType", "type": { "text": "{\n none: 'none',\n columnHeader: 'columnHeader',\n headerActions: 'headerActions',\n row: 'row',\n rowSelectionCheckbox: 'rowSelectionCheckbox',\n cell: 'cell',\n cellActionMenu: 'cellActionMenu',\n cellContent: 'cellContent'\n}" }, "default": "{ none: 'none', columnHeader: 'columnHeader', headerActions: 'headerActions', row: 'row', rowSelectionCheckbox: 'rowSelectionCheckbox', cell: 'cell', cellActionMenu: 'cellActionMenu', cellContent: 'cellContent' }", "description": "Table keyboard focus types" } ], "exports": [ { "kind": "js", "name": "TableRecordDelayedHierarchyState", "declaration": { "name": "TableRecordDelayedHierarchyState", "module": "src/table/types.ts" } }, { "kind": "js", "name": "TableColumnSortDirection", "declaration": { "name": "TableColumnSortDirection", "module": "src/table/types.ts" } }, { "kind": "js", "name": "TableRowSelectionMode", "declaration": { "name": "TableRowSelectionMode", "module": "src/table/types.ts" } }, { "kind": "js", "name": "TableFocusType", "declaration": { "name": "TableFocusType", "module": "src/table/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/tabs/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled tabs control", "name": "Tabs", "members": [ { "kind": "field", "name": "tabListResizeObserver", "type": { "text": "ResizeObserver" }, "privacy": "private", "readonly": true, "default": "new ResizeObserver(entries => { let tabListVisibleWidth = entries[0]?.contentRect.width; if (tabListVisibleWidth !== undefined) { const buttonWidth = this.leftScrollButton?.clientWidth ?? 0; tabListVisibleWidth = Math.ceil(tabListVisibleWidth); if (this.showScrollButtons) { tabListVisibleWidth += buttonWidth * 2; } this.showScrollButtons = tabListVisibleWidth < this.tablist.scrollWidth; } })" }, { "kind": "field", "name": "activeindicator", "type": { "text": "boolean" }, "default": "false" } ], "superclass": { "name": "FoundationTabs", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "tabsTag", "type": { "text": "string" }, "default": "'nimble-tabs'" } ], "exports": [ { "kind": "js", "name": "Tabs", "declaration": { "name": "Tabs", "module": "src/tabs/index.ts" } }, { "kind": "js", "name": "tabsTag", "declaration": { "name": "tabsTag", "module": "src/tabs/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tabs-toolbar/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled container for toolbar content next to tabs.", "name": "TabsToolbar", "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "tabsToolbarTag", "type": { "text": "string" }, "default": "'nimble-tabs-toolbar'" } ], "exports": [ { "kind": "js", "name": "TabsToolbar", "declaration": { "name": "TabsToolbar", "module": "src/tabs-toolbar/index.ts" } }, { "kind": "js", "name": "tabsToolbarTag", "declaration": { "name": "tabsToolbarTag", "module": "src/tabs-toolbar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/text-area/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styed HTML text area", "name": "TextArea", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "TextAreaAppearance" }, "privacy": "public", "description": "The appearance the text area should have." }, { "kind": "field", "name": "appearanceReadOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver | undefined" }, "privacy": "private" }, { "kind": "field", "name": "updateScrollbarWidthQueued", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "onResize", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "queueUpdateScrollbarWidth", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateScrollbarWidth", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ], "attributes": [ { "name": "appearance", "type": { "text": "TextAreaAppearance" }, "description": "The appearance the text area should have.", "fieldName": "appearance" }, { "name": "appearance-readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "appearanceReadOnly" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FoundationTextArea", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "textAreaTag", "type": { "text": "string" }, "default": "'nimble-text-area'" } ], "exports": [ { "kind": "js", "name": "TextArea", "declaration": { "name": "TextArea", "module": "src/text-area/index.ts" } }, { "kind": "js", "name": "textAreaTag", "declaration": { "name": "textAreaTag", "module": "src/text-area/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/text-area/types.ts", "declarations": [ { "kind": "variable", "name": "TextAreaAppearance", "type": { "text": "{\n outline: 'outline',\n block: 'block'\n}" }, "default": "{ outline: 'outline', block: 'block' }" } ], "exports": [ { "kind": "js", "name": "TextAreaResize", "declaration": { "name": "TextAreaResize", "module": "src/text-area/types.ts" } }, { "kind": "js", "name": "TextAreaAppearance", "declaration": { "name": "TextAreaAppearance", "module": "src/text-area/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/text-field/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styed HTML text input", "name": "TextField", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "TextFieldAppearance" }, "privacy": "public", "description": "The appearance the text field should have." }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "appearanceReadOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ], "attributes": [ { "name": "appearance", "type": { "text": "TextFieldAppearance" }, "description": "The appearance the text field should have.", "fieldName": "appearance" }, { "name": "full-bleed", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullBleed" }, { "name": "appearance-readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "appearanceReadOnly" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" }, { "name": "mixinRequiredVisiblePattern", "module": "/src/patterns/required-visible/types" } ], "superclass": { "name": "FoundationTextField", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "textFieldTag", "type": { "text": "string" }, "default": "'nimble-text-field'" } ], "exports": [ { "kind": "js", "name": "TextField", "declaration": { "name": "TextField", "module": "src/text-field/index.ts" } }, { "kind": "js", "name": "textFieldTag", "declaration": { "name": "textFieldTag", "module": "src/text-field/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/text-field/types.ts", "declarations": [ { "kind": "variable", "name": "TextFieldAppearance", "type": { "text": "{\n underline: 'underline',\n outline: 'outline',\n block: 'block',\n frameless: 'frameless'\n}" }, "default": "{ underline: 'underline', outline: 'outline', block: 'block', frameless: 'frameless' }", "description": "Values for the 'appearance' property of the text field" } ], "exports": [ { "kind": "js", "name": "TextFieldType", "declaration": { "name": "TextFieldType", "module": "src/text-field/types.ts" } }, { "kind": "js", "name": "TextFieldAppearance", "declaration": { "name": "TextFieldAppearance", "module": "src/text-field/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/theme-provider/index.ts", "declarations": [ { "kind": "variable", "name": "lang" }, { "kind": "variable", "name": "direction" }, { "kind": "variable", "name": "theme" }, { "kind": "variable", "name": "themeProviderTag", "type": { "text": "string" }, "default": "'nimble-theme-provider'" } ], "exports": [ { "kind": "js", "name": "Direction", "declaration": { "name": "Direction", "module": "src/theme-provider/index.ts" } }, { "kind": "js", "name": "lang", "declaration": { "name": "lang", "module": "src/theme-provider/index.ts" } }, { "kind": "js", "name": "direction", "declaration": { "name": "direction", "module": "src/theme-provider/index.ts" } }, { "kind": "js", "name": "theme", "declaration": { "name": "theme", "module": "src/theme-provider/index.ts" } }, { "kind": "js", "name": "themeProviderTag", "declaration": { "name": "themeProviderTag", "module": "src/theme-provider/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/theme-provider/types.ts", "declarations": [ { "kind": "variable", "name": "Theme", "type": { "text": "{\n light: 'light',\n dark: 'dark',\n color: 'color'\n}" }, "default": "{ light: 'light', dark: 'dark', color: 'color' }" } ], "exports": [ { "kind": "js", "name": "Theme", "declaration": { "name": "Theme", "module": "src/theme-provider/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/toggle-button/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled toggle button control.", "name": "ToggleButton", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "ButtonAppearance" }, "privacy": "public" }, { "kind": "field", "name": "appearanceVariant", "type": { "text": "ButtonAppearanceVariant" }, "privacy": "public" }, { "kind": "field", "name": "contentHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "tabIndex", "type": { "text": "number" }, "privacy": "public" } ], "attributes": [ { "name": "appearance", "type": { "text": "ButtonAppearance" }, "fieldName": "appearance" }, { "name": "appearance-variant", "type": { "text": "ButtonAppearanceVariant" }, "fieldName": "appearanceVariant" }, { "name": "content-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "contentHidden" }, { "name": "tabindex", "type": { "text": "number" }, "fieldName": "tabIndex" } ], "superclass": { "name": "FoundationSwitch", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "toggleButtonTag", "type": { "text": "string" }, "default": "'nimble-toggle-button'" } ], "exports": [ { "kind": "js", "name": "ToggleButton", "declaration": { "name": "ToggleButton", "module": "src/toggle-button/index.ts" } }, { "kind": "js", "name": "toggleButtonTag", "declaration": { "name": "toggleButtonTag", "module": "src/toggle-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/toggle-button/types.ts", "declarations": [], "exports": [ { "kind": "js", "name": "ButtonAppearance", "declaration": { "name": "ButtonAppearance", "module": "../patterns/button/types" } }, { "kind": "js", "name": "ButtonAppearanceVariant", "declaration": { "name": "ButtonAppearanceVariant", "module": "../patterns/button/types" } } ] }, { "kind": "javascript-module", "path": "src/toolbar/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled Toolbar", "name": "Toolbar", "superclass": { "name": "FoundationToolbar", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "toolbarTag", "type": { "text": "string" }, "default": "'nimble-toolbar'" } ], "exports": [ { "kind": "js", "name": "Toolbar", "declaration": { "name": "Toolbar", "module": "src/toolbar/index.ts" } }, { "kind": "js", "name": "toolbarTag", "declaration": { "name": "toolbarTag", "module": "src/toolbar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tooltip/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled tooltip control.", "name": "Tooltip", "members": [ { "kind": "field", "name": "severity", "type": { "text": "TooltipSeverity" }, "privacy": "public" }, { "kind": "field", "name": "iconVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "attributes": [ { "name": "severity", "type": { "text": "TooltipSeverity" }, "fieldName": "severity" }, { "name": "icon-visible", "type": { "text": "boolean" }, "default": "false", "fieldName": "iconVisible" } ], "superclass": { "name": "FoundationTooltip", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "tooltipTag", "type": { "text": "string" }, "default": "'nimble-tooltip'" } ], "exports": [ { "kind": "js", "name": "Tooltip", "declaration": { "name": "Tooltip", "module": "src/tooltip/index.ts" } }, { "kind": "js", "name": "tooltipTag", "declaration": { "name": "tooltipTag", "module": "src/tooltip/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tooltip/types.ts", "declarations": [ { "kind": "variable", "name": "TooltipSeverity", "type": { "text": "{\n default: undefined,\n error: 'error',\n information: 'information'\n}" }, "default": "{ default: undefined, error: 'error', information: 'information' }", "description": "Types of tooltip appearance.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "TooltipSeverity", "declaration": { "name": "TooltipSeverity", "module": "src/tooltip/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/tree-item/index.ts", "declarations": [ { "kind": "class", "description": "A function that returns a nimble-tree-item registration for configuring the component with a DesignSystem.\nImplements @ni/fast-foundation#treeItemTemplate", "name": "TreeItem", "superclass": { "name": "FoundationTreeItem", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "treeItemTag", "type": { "text": "string" }, "default": "'nimble-tree-item'" } ], "exports": [ { "kind": "js", "name": "TreeItem", "declaration": { "name": "TreeItem", "module": "src/tree-item/index.ts" } }, { "kind": "js", "name": "treeItemTag", "declaration": { "name": "treeItemTag", "module": "src/tree-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tree-view/index.ts", "declarations": [ { "kind": "class", "description": "A function that returns a nimble-tree-view registration for configuring the component with a DesignSystem.\nImplements @ni/fast-foundation#treeViewTemplate", "name": "TreeView", "members": [ { "kind": "field", "name": "selectionMode", "type": { "text": "TreeViewSelectionMode" }, "privacy": "public" }, { "kind": "method", "name": "handleClick", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "canSelect", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "TreeItem" } } ] }, { "kind": "method", "name": "itemHasChildren", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "TreeItem" } } ] }, { "kind": "method", "name": "selectedItemsChanged", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "selection-mode", "type": { "text": "TreeViewSelectionMode" }, "fieldName": "selectionMode" } ], "superclass": { "name": "FoundationTreeView", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "treeViewTag", "type": { "text": "string" }, "default": "'nimble-tree-view'" } ], "exports": [ { "kind": "js", "name": "TreeView", "declaration": { "name": "TreeView", "module": "src/tree-view/index.ts" } }, { "kind": "js", "name": "treeViewTag", "declaration": { "name": "treeViewTag", "module": "src/tree-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/tree-view/types.ts", "declarations": [ { "kind": "variable", "name": "pinnedSelectedAttribute", "type": { "text": "string" }, "default": "'pinned-selected'" }, { "kind": "variable", "name": "groupSelectedAttribute", "type": { "text": "string" }, "default": "'group-selected'" }, { "kind": "variable", "name": "TreeViewSelectionMode", "type": { "text": "{\n all: 'all',\n leavesOnly: 'leaves-only',\n none: 'none'\n}" }, "default": "{ all: 'all', leavesOnly: 'leaves-only', none: 'none' }" } ], "exports": [ { "kind": "js", "name": "pinnedSelectedAttribute", "declaration": { "name": "pinnedSelectedAttribute", "module": "src/tree-view/types.ts" } }, { "kind": "js", "name": "groupSelectedAttribute", "declaration": { "name": "groupSelectedAttribute", "module": "src/tree-view/types.ts" } }, { "kind": "js", "name": "TreeViewSelectionMode", "declaration": { "name": "TreeViewSelectionMode", "module": "src/tree-view/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/index.ts", "declarations": [ { "kind": "class", "description": "A nimble-styled WaferMap", "name": "WaferMap", "members": [ { "kind": "field", "name": "Arrow", "type": { "text": "object" }, "privacy": "public", "static": true, "readonly": true, "default": "{ tableFromIPC }" }, { "kind": "field", "name": "originLocation", "type": { "text": "WaferMapOriginLocation" }, "privacy": "public" }, { "kind": "field", "name": "gridMinX", "type": { "text": "number | undefined" }, "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "gridMaxX", "type": { "text": "number | undefined" }, "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "gridMinY", "type": { "text": "number | undefined" }, "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "gridMaxY", "type": { "text": "number | undefined" }, "privacy": "public", "default": "undefined" }, { "kind": "field", "name": "orientation", "type": { "text": "WaferMapOrientation" }, "privacy": "public" }, { "kind": "field", "name": "maxCharacters", "type": { "text": "number" }, "privacy": "public", "default": "4" }, { "kind": "field", "name": "dieLabelsHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "dieLabelsSuffix", "type": { "text": "string" }, "privacy": "public", "default": "''" }, { "kind": "field", "name": "colorScaleMode", "type": { "text": "WaferMapColorScaleMode" }, "privacy": "public" }, { "kind": "field", "name": "computations", "type": { "text": "Computations" }, "privacy": "public", "readonly": true, "default": "new Computations( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "dataManager", "type": { "text": "DataManager" }, "privacy": "public", "default": "new DataManager( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "workerRenderer", "privacy": "public", "readonly": true, "default": "new WorkerRenderer( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "renderer", "type": { "text": "RenderingModule" }, "privacy": "public", "default": "new RenderingModule( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "highlightedTags", "type": { "text": "string[]" }, "privacy": "public", "default": "[]" }, { "kind": "field", "name": "dies", "type": { "text": "WaferMapDie[]" }, "privacy": "public", "default": "[]" }, { "kind": "field", "name": "diesTable", "type": { "text": "Table | undefined" }, "privacy": "public" }, { "kind": "field", "name": "colorScale", "type": { "text": "WaferMapColorScale" }, "privacy": "public", "default": "{ colors: [], values: [] }" }, { "kind": "field", "name": "hoverHandler", "type": { "text": "HoverHandler" }, "privacy": "private", "readonly": true, "default": "new HoverHandler( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "experimentalHoverHandler", "type": { "text": "ExperimentalHoverHandler" }, "privacy": "private", "readonly": true, "default": "new ExperimentalHoverHandler(this.asRequiredFieldsWaferMap)" }, { "kind": "field", "name": "zoomHandler", "type": { "text": "ZoomHandler" }, "privacy": "private", "readonly": true, "default": "new ZoomHandler( this.asRequiredFieldsWaferMap )" }, { "kind": "field", "name": "resizeObserver", "privacy": "private", "readonly": true }, { "kind": "field", "name": "waferMapValidator", "type": { "text": "WaferMapValidator" }, "privacy": "private", "readonly": true, "default": "new WaferMapValidator(this.asRequiredFieldsWaferMap)" }, { "kind": "field", "name": "validity", "type": { "text": "WaferMapValidity" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "setData", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "data", "type": { "text": "Table | WaferMapDie[]" } } ] }, { "kind": "method", "name": "createSnapshot", "privacy": "private", "return": { "type": { "text": "{\n canvasDimensions: Dimensions,\n renderConfig: RenderConfig,\n dieDimensions: Dimensions,\n transform: ZoomTransform,\n dieLabelsHidden: boolean,\n columnIndices: Int32Array,\n rowIndices: Int32Array,\n values: Float64Array\n }" } } }, { "kind": "method", "name": "validate", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "createResizeObserver", "privacy": "private", "return": { "type": { "text": "ResizeObserver" } } }, { "kind": "method", "name": "originLocationChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridMinXChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridMaxXChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridMinYChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridMaxYChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "maxCharactersChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "dieLabelsHiddenChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "dieLabelsSuffixChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "colorScaleModeChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "highlightedTagsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "diesChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "diesTableChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "colorScaleChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "transformChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "canvasWidthChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "canvasHeightChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hoverDieChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "asRequiredFieldsWaferMap", "type": { "text": "WaferMap" }, "privacy": "private", "readonly": true } ], "attributes": [ { "name": "origin-location", "type": { "text": "WaferMapOriginLocation" }, "fieldName": "originLocation" }, { "name": "grid-min-x", "type": { "text": "number | undefined" }, "default": "undefined", "fieldName": "gridMinX" }, { "name": "grid-max-x", "type": { "text": "number | undefined" }, "default": "undefined", "fieldName": "gridMaxX" }, { "name": "grid-min-y", "type": { "text": "number | undefined" }, "default": "undefined", "fieldName": "gridMinY" }, { "name": "grid-max-y", "type": { "text": "number | undefined" }, "default": "undefined", "fieldName": "gridMaxY" }, { "name": "orientation", "type": { "text": "WaferMapOrientation" }, "fieldName": "orientation" }, { "name": "max-characters", "type": { "text": "number" }, "default": "4", "fieldName": "maxCharacters" }, { "name": "die-labels-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "dieLabelsHidden" }, { "name": "die-labels-suffix", "type": { "text": "string" }, "default": "''", "fieldName": "dieLabelsSuffix" }, { "name": "color-scale-mode", "type": { "text": "WaferMapColorScaleMode" }, "fieldName": "colorScaleMode" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "waferMapTag", "type": { "text": "string" }, "default": "'nimble-wafer-map'" } ], "exports": [ { "kind": "js", "name": "WaferMap", "declaration": { "name": "WaferMap", "module": "src/wafer-map/index.ts" } }, { "kind": "js", "name": "waferMapTag", "declaration": { "name": "waferMapTag", "module": "src/wafer-map/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/types.ts", "declarations": [ { "kind": "variable", "name": "WaferMapOriginLocation", "type": { "text": "{\n bottomLeft: 'bottom-left',\n bottomRight: 'bottom-right',\n topLeft: 'top-left',\n topRight: 'top-right'\n}" }, "default": "{ bottomLeft: 'bottom-left', bottomRight: 'bottom-right', topLeft: 'top-left', topRight: 'top-right' }" }, { "kind": "variable", "name": "WaferMapOrientation", "type": { "text": "{\n top: 'top',\n bottom: 'bottom',\n left: 'left',\n right: 'right'\n}" }, "default": "{ top: 'top', bottom: 'bottom', left: 'left', right: 'right' }" }, { "kind": "variable", "name": "HoverDieOpacity", "type": { "text": "{\n show: 'show',\n hide: 'hide'\n}" }, "default": "{ show: 'show', hide: 'hide' }" }, { "kind": "variable", "name": "WaferMapColorScaleMode", "type": { "text": "{\n linear: 'linear',\n ordinal: 'ordinal'\n}" }, "default": "{ linear: 'linear', ordinal: 'ordinal' }" } ], "exports": [ { "kind": "js", "name": "WaferMapOriginLocation", "declaration": { "name": "WaferMapOriginLocation", "module": "src/wafer-map/types.ts" } }, { "kind": "js", "name": "WaferMapOrientation", "declaration": { "name": "WaferMapOrientation", "module": "src/wafer-map/types.ts" } }, { "kind": "js", "name": "HoverDieOpacity", "declaration": { "name": "HoverDieOpacity", "module": "src/wafer-map/types.ts" } }, { "kind": "js", "name": "WaferMapColorScaleMode", "declaration": { "name": "WaferMapColorScaleMode", "module": "src/wafer-map/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/base/index.ts", "declarations": [ { "kind": "class", "description": "Base class for label providers", "name": "LabelProviderBase", "members": [ { "kind": "field", "name": "supportedLabels", "type": { "text": "SupportedLabels" }, "privacy": "protected" }, { "kind": "field", "name": "propertyNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "themeProvider", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "method", "name": "handleChange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_element", "type": { "text": "LabelProviderBase" } }, { "name": "property", "type": { "text": "keyof LabelProviderBase" } } ] }, { "kind": "method", "name": "initializeThemeProvider", "privacy": "private", "return": { "type": { "text": "void" } } } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "LabelProviderBase", "declaration": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/core/index.ts", "declarations": [ { "kind": "class", "description": "Core label provider for Nimble", "name": "LabelProviderCore", "members": [ { "kind": "field", "name": "popupDismiss", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "numericDecrement", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "numericIncrement", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "popupIconError", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "popupIconWarning", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "popupIconCompleted", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "popupIconCurrent", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "popupIconInformation", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "filterSearch", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "filterNoResults", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "loading", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "scrollBackward", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "scrollForward", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "itemRemove", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "supportedLabels", "type": { "text": "SupportedLabels" }, "privacy": "protected", "readonly": true, "default": "{ popupDismiss: popupDismissLabel, numericDecrement: numericDecrementLabel, numericIncrement: numericIncrementLabel, popupIconError: popupIconErrorLabel, popupIconWarning: popupIconWarningLabel, popupIconCompleted: popupIconCompletedLabel, popupIconCurrent: popupIconCurrentLabel, popupIconInformation: popupIconInformationLabel, filterSearch: filterSearchLabel, filterNoResults: filterNoResultsLabel, loading: loadingLabel, scrollBackward: scrollBackwardLabel, scrollForward: scrollForwardLabel, itemRemove: itemRemoveLabel }", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "propertyNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "themeProvider", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "handleChange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_element", "type": { "text": "LabelProviderBase" } }, { "name": "property", "type": { "text": "keyof LabelProviderBase" } } ], "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "initializeThemeProvider", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } } ], "attributes": [ { "name": "popup-dismiss", "type": { "text": "string | undefined" }, "fieldName": "popupDismiss" }, { "name": "numeric-decrement", "type": { "text": "string | undefined" }, "fieldName": "numericDecrement" }, { "name": "numeric-increment", "type": { "text": "string | undefined" }, "fieldName": "numericIncrement" }, { "name": "popup-icon-error", "type": { "text": "string | undefined" }, "fieldName": "popupIconError" }, { "name": "popup-icon-warning", "type": { "text": "string | undefined" }, "fieldName": "popupIconWarning" }, { "name": "popup-icon-completed", "type": { "text": "string | undefined" }, "fieldName": "popupIconCompleted" }, { "name": "popup-icon-current", "type": { "text": "string | undefined" }, "fieldName": "popupIconCurrent" }, { "name": "popup-icon-information", "type": { "text": "string | undefined" }, "fieldName": "popupIconInformation" }, { "name": "filter-search", "type": { "text": "string | undefined" }, "fieldName": "filterSearch" }, { "name": "filter-no-results", "type": { "text": "string | undefined" }, "fieldName": "filterNoResults" }, { "name": "loading", "type": { "text": "string | undefined" }, "fieldName": "loading" }, { "name": "scroll-backward", "type": { "text": "string | undefined" }, "fieldName": "scrollBackward" }, { "name": "scroll-forward", "type": { "text": "string | undefined" }, "fieldName": "scrollForward" }, { "name": "item-remove", "type": { "text": "string | undefined" }, "fieldName": "itemRemove" } ], "superclass": { "name": "LabelProviderBase", "module": "/src/label-provider/base" } }, { "kind": "variable", "name": "labelProviderCoreTag", "type": { "text": "string" }, "default": "'nimble-label-provider-core'" } ], "exports": [ { "kind": "js", "name": "LabelProviderCore", "declaration": { "name": "LabelProviderCore", "module": "src/label-provider/core/index.ts" } }, { "kind": "js", "name": "labelProviderCoreTag", "declaration": { "name": "labelProviderCoreTag", "module": "src/label-provider/core/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/core/label-token-defaults.ts", "declarations": [ { "kind": "variable", "name": "coreLabelDefaults", "type": { "text": "{ readonly [key in TokenName]: string }" }, "default": "{ popupDismissLabel: 'Close', numericDecrementLabel: 'Decrement', numericIncrementLabel: 'Increment', popupIconErrorLabel: 'Error', popupIconWarningLabel: 'Warning', popupIconCompletedLabel: 'Completed', popupIconCurrentLabel: 'Current', popupIconInformationLabel: 'Information', filterSearchLabel: 'Search', filterNoResultsLabel: 'No items found', loadingLabel: 'Loading…', scrollBackwardLabel: 'Scroll backward', scrollForwardLabel: 'Scroll forward', itemRemoveLabel: 'Remove' }" } ], "exports": [ { "kind": "js", "name": "coreLabelDefaults", "declaration": { "name": "coreLabelDefaults", "module": "src/label-provider/core/label-token-defaults.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/core/label-tokens.ts", "declarations": [ { "kind": "variable", "name": "popupDismissLabel" }, { "kind": "variable", "name": "numericDecrementLabel" }, { "kind": "variable", "name": "numericIncrementLabel" }, { "kind": "variable", "name": "popupIconErrorLabel" }, { "kind": "variable", "name": "popupIconWarningLabel" }, { "kind": "variable", "name": "popupIconCompletedLabel" }, { "kind": "variable", "name": "popupIconCurrentLabel" }, { "kind": "variable", "name": "popupIconInformationLabel" }, { "kind": "variable", "name": "filterSearchLabel" }, { "kind": "variable", "name": "filterNoResultsLabel" }, { "kind": "variable", "name": "loadingLabel" }, { "kind": "variable", "name": "scrollBackwardLabel" }, { "kind": "variable", "name": "scrollForwardLabel" }, { "kind": "variable", "name": "itemRemoveLabel" } ], "exports": [ { "kind": "js", "name": "popupDismissLabel", "declaration": { "name": "popupDismissLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "numericDecrementLabel", "declaration": { "name": "numericDecrementLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "numericIncrementLabel", "declaration": { "name": "numericIncrementLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "popupIconErrorLabel", "declaration": { "name": "popupIconErrorLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "popupIconWarningLabel", "declaration": { "name": "popupIconWarningLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "popupIconCompletedLabel", "declaration": { "name": "popupIconCompletedLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "popupIconCurrentLabel", "declaration": { "name": "popupIconCurrentLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "popupIconInformationLabel", "declaration": { "name": "popupIconInformationLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "filterSearchLabel", "declaration": { "name": "filterSearchLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "filterNoResultsLabel", "declaration": { "name": "filterNoResultsLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "loadingLabel", "declaration": { "name": "loadingLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "scrollBackwardLabel", "declaration": { "name": "scrollBackwardLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "scrollForwardLabel", "declaration": { "name": "scrollForwardLabel", "module": "src/label-provider/core/label-tokens.ts" } }, { "kind": "js", "name": "itemRemoveLabel", "declaration": { "name": "itemRemoveLabel", "module": "src/label-provider/core/label-tokens.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/rich-text/index.ts", "declarations": [ { "kind": "class", "description": "Label provider for the Nimble rich text component", "name": "LabelProviderRichText", "members": [ { "kind": "field", "name": "toggleBold", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "toggleItalics", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "toggleBulletedList", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "toggleNumberedList", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "supportedLabels", "type": { "text": "SupportedLabels" }, "privacy": "protected", "readonly": true, "default": "{ toggleBold: richTextToggleBoldLabel, toggleItalics: richTextToggleItalicsLabel, toggleBulletedList: richTextToggleBulletedListLabel, toggleNumberedList: richTextToggleNumberedListLabel }", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "propertyNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "themeProvider", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "handleChange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_element", "type": { "text": "LabelProviderBase" } }, { "name": "property", "type": { "text": "keyof LabelProviderBase" } } ], "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "initializeThemeProvider", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } } ], "attributes": [ { "name": "toggle-bold", "type": { "text": "string | undefined" }, "fieldName": "toggleBold" }, { "name": "toggle-italics", "type": { "text": "string | undefined" }, "fieldName": "toggleItalics" }, { "name": "toggle-bulleted-list", "type": { "text": "string | undefined" }, "fieldName": "toggleBulletedList" }, { "name": "toggle-numbered-list", "type": { "text": "string | undefined" }, "fieldName": "toggleNumberedList" } ], "superclass": { "name": "LabelProviderBase", "module": "/src/label-provider/base" } }, { "kind": "variable", "name": "labelProviderRichTextTag", "type": { "text": "string" }, "default": "'nimble-label-provider-rich-text'" } ], "exports": [ { "kind": "js", "name": "LabelProviderRichText", "declaration": { "name": "LabelProviderRichText", "module": "src/label-provider/rich-text/index.ts" } }, { "kind": "js", "name": "labelProviderRichTextTag", "declaration": { "name": "labelProviderRichTextTag", "module": "src/label-provider/rich-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/rich-text/label-token-defaults.ts", "declarations": [ { "kind": "variable", "name": "richTextLabelDefaults", "type": { "text": "{\n readonly [key in TokenName]: string;\n}" }, "default": "{ richTextToggleBoldLabel: 'Bold', richTextToggleItalicsLabel: 'Italics', richTextToggleBulletedListLabel: 'Bulleted List', richTextToggleNumberedListLabel: 'Numbered List' }" } ], "exports": [ { "kind": "js", "name": "richTextLabelDefaults", "declaration": { "name": "richTextLabelDefaults", "module": "src/label-provider/rich-text/label-token-defaults.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/rich-text/label-tokens.ts", "declarations": [ { "kind": "variable", "name": "richTextToggleBoldLabel" }, { "kind": "variable", "name": "richTextToggleItalicsLabel" }, { "kind": "variable", "name": "richTextToggleBulletedListLabel" }, { "kind": "variable", "name": "richTextToggleNumberedListLabel" } ], "exports": [ { "kind": "js", "name": "richTextToggleBoldLabel", "declaration": { "name": "richTextToggleBoldLabel", "module": "src/label-provider/rich-text/label-tokens.ts" } }, { "kind": "js", "name": "richTextToggleItalicsLabel", "declaration": { "name": "richTextToggleItalicsLabel", "module": "src/label-provider/rich-text/label-tokens.ts" } }, { "kind": "js", "name": "richTextToggleBulletedListLabel", "declaration": { "name": "richTextToggleBulletedListLabel", "module": "src/label-provider/rich-text/label-tokens.ts" } }, { "kind": "js", "name": "richTextToggleNumberedListLabel", "declaration": { "name": "richTextToggleNumberedListLabel", "module": "src/label-provider/rich-text/label-tokens.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/table/index.ts", "declarations": [ { "kind": "class", "description": "Label provider for the Nimble table (and its sub-components and columns)", "name": "LabelProviderTable", "members": [ { "kind": "field", "name": "groupCollapse", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "groupExpand", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rowCollapse", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rowExpand", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "collapseAll", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "cellActionMenu", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnHeaderGrouped", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnHeaderSortedAscending", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnHeaderSortedDescending", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "selectAll", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "groupSelectAll", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rowSelect", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rowOperationColumn", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rowLoading", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "groupRowPlaceholderNoValue", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "groupRowPlaceholderEmpty", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "supportedLabels", "type": { "text": "SupportedLabels" }, "privacy": "protected", "readonly": true, "default": "{ groupCollapse: tableGroupCollapseLabel, groupExpand: tableGroupExpandLabel, rowCollapse: tableRowCollapseLabel, rowExpand: tableRowExpandLabel, collapseAll: tableCollapseAllLabel, cellActionMenu: tableCellActionMenuLabel, columnHeaderGrouped: tableColumnHeaderGroupedLabel, columnHeaderSortedAscending: tableColumnHeaderSortedAscendingLabel, columnHeaderSortedDescending: tableColumnHeaderSortedDescendingLabel, selectAll: tableSelectAllLabel, groupSelectAll: tableGroupSelectAllLabel, rowSelect: tableRowSelectLabel, rowOperationColumn: tableRowOperationColumnLabel, rowLoading: tableRowLoadingLabel, groupRowPlaceholderNoValue: tableGroupRowPlaceholderNoValueLabel, groupRowPlaceholderEmpty: tableGroupRowPlaceholderEmptyLabel }", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "propertyNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "field", "name": "themeProvider", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "handleChange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_element", "type": { "text": "LabelProviderBase" } }, { "name": "property", "type": { "text": "keyof LabelProviderBase" } } ], "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } }, { "kind": "method", "name": "initializeThemeProvider", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "LabelProviderBase", "module": "src/label-provider/base/index.ts" } } ], "attributes": [ { "name": "group-collapse", "type": { "text": "string | undefined" }, "fieldName": "groupCollapse" }, { "name": "group-expand", "type": { "text": "string | undefined" }, "fieldName": "groupExpand" }, { "name": "row-collapse", "type": { "text": "string | undefined" }, "fieldName": "rowCollapse" }, { "name": "row-expand", "type": { "text": "string | undefined" }, "fieldName": "rowExpand" }, { "name": "collapse-all", "type": { "text": "string | undefined" }, "fieldName": "collapseAll" }, { "name": "cell-action-menu", "type": { "text": "string | undefined" }, "fieldName": "cellActionMenu" }, { "name": "column-header-grouped", "type": { "text": "string | undefined" }, "fieldName": "columnHeaderGrouped" }, { "name": "column-header-sorted-ascending", "type": { "text": "string | undefined" }, "fieldName": "columnHeaderSortedAscending" }, { "name": "column-header-sorted-descending", "type": { "text": "string | undefined" }, "fieldName": "columnHeaderSortedDescending" }, { "name": "select-all", "type": { "text": "string | undefined" }, "fieldName": "selectAll" }, { "name": "group-select-all", "type": { "text": "string | undefined" }, "fieldName": "groupSelectAll" }, { "name": "row-select", "type": { "text": "string | undefined" }, "fieldName": "rowSelect" }, { "name": "row-operation-column", "type": { "text": "string | undefined" }, "fieldName": "rowOperationColumn" }, { "name": "row-loading", "type": { "text": "string | undefined" }, "fieldName": "rowLoading" }, { "name": "group-row-placeholder-no-value", "type": { "text": "string | undefined" }, "fieldName": "groupRowPlaceholderNoValue" }, { "name": "group-row-placeholder-empty", "type": { "text": "string | undefined" }, "fieldName": "groupRowPlaceholderEmpty" } ], "superclass": { "name": "LabelProviderBase", "module": "/src/label-provider/base" } }, { "kind": "variable", "name": "labelProviderTableTag", "type": { "text": "string" }, "default": "'nimble-label-provider-table'" } ], "exports": [ { "kind": "js", "name": "LabelProviderTable", "declaration": { "name": "LabelProviderTable", "module": "src/label-provider/table/index.ts" } }, { "kind": "js", "name": "labelProviderTableTag", "declaration": { "name": "labelProviderTableTag", "module": "src/label-provider/table/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/table/label-token-defaults.ts", "declarations": [ { "kind": "variable", "name": "tableLabelDefaults", "type": { "text": "{ readonly [key in TokenName]: string }" }, "default": "{ tableGroupCollapseLabel: 'Collapse group', tableGroupExpandLabel: 'Expand group', tableRowCollapseLabel: 'Collapse row', tableRowExpandLabel: 'Expand row', tableCollapseAllLabel: 'Collapse all', tableCellActionMenuLabel: 'Options', tableColumnHeaderGroupedLabel: 'Grouped', tableColumnHeaderSortedAscendingLabel: 'Sorted ascending', tableColumnHeaderSortedDescendingLabel: 'Sorted descending', tableSelectAllLabel: 'Select all rows', tableGroupSelectAllLabel: 'Select all rows in group', tableRowSelectLabel: 'Select row', tableRowOperationColumnLabel: 'Row operations', tableRowLoadingLabel: 'Loading', tableGroupRowPlaceholderNoValueLabel: 'No value', tableGroupRowPlaceholderEmptyLabel: 'Empty' }" } ], "exports": [ { "kind": "js", "name": "tableLabelDefaults", "declaration": { "name": "tableLabelDefaults", "module": "src/label-provider/table/label-token-defaults.ts" } } ] }, { "kind": "javascript-module", "path": "src/label-provider/table/label-tokens.ts", "declarations": [ { "kind": "variable", "name": "tableGroupCollapseLabel" }, { "kind": "variable", "name": "tableGroupExpandLabel" }, { "kind": "variable", "name": "tableRowCollapseLabel" }, { "kind": "variable", "name": "tableRowExpandLabel" }, { "kind": "variable", "name": "tableCollapseAllLabel" }, { "kind": "variable", "name": "tableCellActionMenuLabel" }, { "kind": "variable", "name": "tableColumnHeaderGroupedLabel" }, { "kind": "variable", "name": "tableColumnHeaderSortedAscendingLabel" }, { "kind": "variable", "name": "tableColumnHeaderSortedDescendingLabel" }, { "kind": "variable", "name": "tableSelectAllLabel" }, { "kind": "variable", "name": "tableGroupSelectAllLabel" }, { "kind": "variable", "name": "tableRowSelectLabel" }, { "kind": "variable", "name": "tableRowOperationColumnLabel" }, { "kind": "variable", "name": "tableRowLoadingLabel" }, { "kind": "variable", "name": "tableGroupRowPlaceholderNoValueLabel" }, { "kind": "variable", "name": "tableGroupRowPlaceholderEmptyLabel" } ], "exports": [ { "kind": "js", "name": "tableGroupCollapseLabel", "declaration": { "name": "tableGroupCollapseLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableGroupExpandLabel", "declaration": { "name": "tableGroupExpandLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableRowCollapseLabel", "declaration": { "name": "tableRowCollapseLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableRowExpandLabel", "declaration": { "name": "tableRowExpandLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableCollapseAllLabel", "declaration": { "name": "tableCollapseAllLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableCellActionMenuLabel", "declaration": { "name": "tableCellActionMenuLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableColumnHeaderGroupedLabel", "declaration": { "name": "tableColumnHeaderGroupedLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableColumnHeaderSortedAscendingLabel", "declaration": { "name": "tableColumnHeaderSortedAscendingLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableColumnHeaderSortedDescendingLabel", "declaration": { "name": "tableColumnHeaderSortedDescendingLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableSelectAllLabel", "declaration": { "name": "tableSelectAllLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableGroupSelectAllLabel", "declaration": { "name": "tableGroupSelectAllLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableRowSelectLabel", "declaration": { "name": "tableRowSelectLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableRowOperationColumnLabel", "declaration": { "name": "tableRowOperationColumnLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableRowLoadingLabel", "declaration": { "name": "tableRowLoadingLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableGroupRowPlaceholderNoValueLabel", "declaration": { "name": "tableGroupRowPlaceholderNoValueLabel", "module": "src/label-provider/table/label-tokens.ts" } }, { "kind": "js", "name": "tableGroupRowPlaceholderEmptyLabel", "declaration": { "name": "tableGroupRowPlaceholderEmptyLabel", "module": "src/label-provider/table/label-tokens.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/base/index.ts", "declarations": [ { "kind": "class", "description": "Base class for mapping configuration elements", "name": "Mapping", "members": [ { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"" }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation" } ], "attributes": [ { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "Mapping", "declaration": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/base/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mapping/empty/index.ts", "declarations": [ { "kind": "class", "description": "Maps data values to text.\nOne or more may be added as children of a nimble-table-column-mapping element. The\nmapping displays an empty cell and text-only group rows.", "name": "MappingEmpty", "members": [ { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "attributes": [ { "name": "text", "type": { "text": "string | undefined" }, "fieldName": "text" }, { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "superclass": { "name": "Mapping", "module": "/src/mapping/base" } }, { "kind": "variable", "name": "mappingEmptyTag", "type": { "text": "string" }, "default": "'nimble-mapping-empty'" } ], "exports": [ { "kind": "js", "name": "MappingEmpty", "declaration": { "name": "MappingEmpty", "module": "src/mapping/empty/index.ts" } }, { "kind": "js", "name": "mappingEmptyTag", "declaration": { "name": "mappingEmptyTag", "module": "src/mapping/empty/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/icon/index.ts", "declarations": [ { "kind": "class", "description": "Maps a data value to an icon.\nOne or more may be added as children of a nimble-table-column-mapping element to define\nhow specific data values should be displayed as icons in that column's cells.", "name": "MappingIcon", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "severity", "type": { "text": "IconSeverity" }, "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "textHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "method", "name": "resolveIconAsync", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "icon", "type": { "text": "string" } } ] }, { "kind": "method", "name": "iconChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "attributes": [ { "name": "icon", "type": { "text": "string | undefined" }, "fieldName": "icon" }, { "name": "severity", "type": { "text": "IconSeverity" }, "fieldName": "severity" }, { "name": "text", "type": { "text": "string | undefined" }, "fieldName": "text" }, { "name": "text-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "textHidden" }, { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "superclass": { "name": "Mapping", "module": "/src/mapping/base" } }, { "kind": "variable", "name": "mappingIconTag", "type": { "text": "string" }, "default": "'nimble-mapping-icon'" } ], "exports": [ { "kind": "js", "name": "MappingIcon", "declaration": { "name": "MappingIcon", "module": "src/mapping/icon/index.ts" } }, { "kind": "js", "name": "mappingIconTag", "declaration": { "name": "mappingIconTag", "module": "src/mapping/icon/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/spinner/index.ts", "declarations": [ { "kind": "class", "description": "Maps data values to a spinner.\nOne or more may be added as children of a nimble-table-column-mapping element to define\nwhich specific data values should be displayed as spinners in that column's cells.", "name": "MappingSpinner", "members": [ { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "textHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "attributes": [ { "name": "text", "type": { "text": "string | undefined" }, "fieldName": "text" }, { "name": "text-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "textHidden" }, { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "superclass": { "name": "Mapping", "module": "/src/mapping/base" } }, { "kind": "variable", "name": "mappingSpinnerTag", "type": { "text": "string" }, "default": "'nimble-mapping-spinner'" } ], "exports": [ { "kind": "js", "name": "MappingSpinner", "declaration": { "name": "MappingSpinner", "module": "src/mapping/spinner/index.ts" } }, { "kind": "js", "name": "mappingSpinnerTag", "declaration": { "name": "mappingSpinnerTag", "module": "src/mapping/spinner/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/text/index.ts", "declarations": [ { "kind": "class", "description": "Defines a mapping from one data value ('key' property) to display text ('text' property).\nOne or more may be added as children of a nimble-table-column-mapping element to define\nhow a specific data value should be displayed as text in that column's cells.", "name": "MappingText", "members": [ { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "attributes": [ { "name": "text", "type": { "text": "string | undefined" }, "fieldName": "text" }, { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "superclass": { "name": "Mapping", "module": "/src/mapping/base" } }, { "kind": "variable", "name": "mappingTextTag", "type": { "text": "string" }, "default": "'nimble-mapping-text'" } ], "exports": [ { "kind": "js", "name": "MappingText", "declaration": { "name": "MappingText", "module": "src/mapping/text/index.ts" } }, { "kind": "js", "name": "mappingTextTag", "declaration": { "name": "mappingTextTag", "module": "src/mapping/text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/mapping/user/index.ts", "declarations": [ { "kind": "class", "description": "Maps key (url) to a user\nNon-visible configuration element for mapping rich text user mention keys to a user", "name": "MappingUser", "members": [ { "kind": "field", "name": "displayName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "keyValue", "type": { "text": "T | undefined" }, "privacy": "public", "description": "Setter for the `key` property for environments that do not support properties named \"key\"", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } }, { "kind": "field", "name": "key", "type": { "text": "T | undefined" }, "privacy": "public", "description": "The data value that is mapped to another representation", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "attributes": [ { "name": "display-name", "type": { "text": "string | undefined" }, "fieldName": "displayName" }, { "name": "key", "type": { "text": "T | undefined" }, "description": "The data value that is mapped to another representation", "fieldName": "key", "inheritedFrom": { "name": "Mapping", "module": "src/mapping/base/index.ts" } } ], "superclass": { "name": "Mapping", "module": "/src/mapping/base" } }, { "kind": "variable", "name": "mappingUserTag", "type": { "text": "string" }, "default": "'nimble-mapping-user'" } ], "exports": [ { "kind": "js", "name": "MappingUser", "declaration": { "name": "MappingUser", "module": "src/mapping/user/index.ts" } }, { "kind": "js", "name": "mappingUserTag", "declaration": { "name": "mappingUserTag", "module": "src/mapping/user/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/button/types.ts", "declarations": [ { "kind": "variable", "name": "ButtonAppearance", "type": { "text": "{\n outline: 'outline',\n ghost: 'ghost',\n block: 'block'\n}" }, "default": "{ outline: 'outline', ghost: 'ghost', block: 'block' }", "description": "Types of button appearance.", "privacy": "public" }, { "kind": "variable", "name": "ButtonAppearanceVariant", "type": { "text": "{\n default: undefined,\n primary: 'primary',\n accent: 'accent'\n}" }, "default": "{ default: undefined, primary: 'primary', accent: 'accent' }", "description": "Types of button appearance variants.", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "ButtonAppearance", "declaration": { "name": "ButtonAppearance", "module": "src/patterns/button/types.ts" } }, { "kind": "js", "name": "ButtonAppearanceVariant", "declaration": { "name": "ButtonAppearanceVariant", "module": "src/patterns/button/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/dialog/types.ts", "declarations": [ { "kind": "variable", "name": "UserDismissed", "type": { "text": "unique symbol" }, "description": "Symbol that is returned as the close reason (from the Promise returned by show()) when\nthe dialog or drawer was closed by pressing the ESC key (vs. calling the close() function)." } ], "exports": [ { "kind": "js", "name": "UserDismissed", "declaration": { "name": "UserDismissed", "module": "src/patterns/dialog/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/dropdown/types.ts", "declarations": [ { "kind": "variable", "name": "DropdownPosition", "type": { "text": "{\n above: 'above',\n below: 'below'\n}" }, "default": "{ above: 'above', below: 'below' }" }, { "kind": "variable", "name": "DropdownAppearance", "type": { "text": "{\n underline: 'underline',\n outline: 'outline',\n block: 'block',\n frameless: 'frameless'\n}" }, "default": "{ underline: 'underline', outline: 'outline', block: 'block', frameless: 'frameless' }" } ], "exports": [ { "kind": "js", "name": "DropdownPosition", "declaration": { "name": "DropdownPosition", "module": "src/patterns/dropdown/types.ts" } }, { "kind": "js", "name": "DropdownAppearance", "declaration": { "name": "DropdownAppearance", "module": "src/patterns/dropdown/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/error/types.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinErrorPattern", "members": [ { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance" }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinErrorPattern", "declaration": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/required-visible/types.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinRequiredVisiblePattern", "members": [ { "kind": "field", "name": "requiredVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinRequiredVisiblePattern", "declaration": { "name": "mixinRequiredVisiblePattern", "module": "src/patterns/required-visible/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/severity/types.ts", "declarations": [ { "kind": "variable", "name": "Severity", "type": { "text": "{\n default: undefined,\n error: 'error',\n warning: 'warning',\n success: 'success',\n}" }, "default": "{ default: undefined, error: 'error', warning: 'warning', success: 'success', }" }, { "kind": "mixin", "description": "", "name": "mixinSeverityPattern", "members": [ { "kind": "field", "name": "severity", "type": { "text": "Severity" }, "privacy": "public", "description": "The severity state of the element" }, { "kind": "field", "name": "severityText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The severity text that will be displayed when a component is not in the default severity state" }, { "kind": "field", "name": "severityHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false" } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "Severity", "declaration": { "name": "Severity", "module": "src/patterns/severity/types.ts" } }, { "kind": "js", "name": "mixinSeverityPattern", "declaration": { "name": "mixinSeverityPattern", "module": "src/patterns/severity/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/step/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/patterns/tabs/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/rich-text/base/index.ts", "declarations": [ { "kind": "class", "description": "Base class for rich text components", "name": "RichText", "members": [ { "kind": "field", "name": "configuration", "type": { "text": "Configuration | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "mentionElements", "type": { "text": "RichTextMention[]" }, "privacy": "protected" }, { "kind": "field", "name": "richTextUpdateTracker", "privacy": "protected", "readonly": true, "default": "new RichTextUpdateTracker(this)" }, { "kind": "field", "name": "richTextValidator", "privacy": "protected", "readonly": true, "default": "new RichTextValidator()" }, { "kind": "field", "name": "validity", "type": { "text": "RichTextValidity" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "validate", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "childItemsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "Element[] | undefined" } }, { "name": "_next", "type": { "text": "Element[]" } } ] }, { "kind": "method", "name": "updateMentionElementsFromChildItems", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "observeMentionInternals", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "removeMentionInternalsObservers", "privacy": "private", "return": { "type": { "text": "void" } } } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "RichText", "declaration": { "name": "RichText", "module": "src/rich-text/base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text/base/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/rich-text/mention-listbox/index.ts", "declarations": [ { "kind": "class", "description": "A rich text mention listbox which acts as a popup for \"@mention\" support in editor", "name": "RichTextMentionListbox", "members": [ { "kind": "field", "name": "anchorElement", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "regionNotifier", "type": { "text": "Notifier | undefined" }, "privacy": "private" }, { "kind": "field", "name": "anchorElementIntersectionObserver", "type": { "text": "IntersectionObserver" }, "privacy": "private", "readonly": true, "default": "new IntersectionObserver( entries => { if (!entries[0]?.isIntersecting) { this.setOpen(false); } }, { threshold: 1.0, root: document } )" }, { "kind": "method", "name": "close", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "options", "type": { "text": "ListboxOption[]" }, "privacy": "public", "description": "The list of options." }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "type": { "text": "MentionListboxShowOptions" } } ], "description": "Triggers when the mention plugin is activated upon pressing the `key`" }, { "kind": "method", "name": "keydownHandler", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } }, { "description": "the keyboard event", "name": "e" } ], "description": "Handle keydown actions for listbox navigation and selection." }, { "kind": "method", "name": "setOpen", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "boolean" } } ] } ], "superclass": { "name": "FoundationListbox", "package": "@ni/fast-foundation" } }, { "kind": "variable", "name": "richTextMentionListboxTag", "type": { "text": "string" }, "default": "'nimble-rich-text-mention-listbox'" } ], "exports": [ { "kind": "js", "name": "RichTextMentionListbox", "declaration": { "name": "RichTextMentionListbox", "module": "src/rich-text/mention-listbox/index.ts" } }, { "kind": "js", "name": "richTextMentionListboxTag", "declaration": { "name": "richTextMentionListboxTag", "module": "src/rich-text/mention-listbox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text/mention-listbox/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/rich-text/editor/index.ts", "declarations": [ { "kind": "class", "description": "A nimble styled rich text editor", "name": "RichTextEditor", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to disable user from editing and interacting with toolbar buttons" }, { "kind": "field", "name": "footerHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to hide the footer of the rich text editor" }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "empty", "type": { "text": "boolean" }, "privacy": "public", "description": "True if the editor is empty or contains only whitespace, false otherwise.", "readonly": true }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver | undefined" }, "privacy": "private" }, { "kind": "field", "name": "updateScrollbarWidthQueued", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "setMarkdown", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "markdown", "type": { "text": "string" } } ], "description": "This function load tip tap editor with provided markdown content by parsing into html" }, { "kind": "method", "name": "getMarkdown", "privacy": "public", "return": { "type": { "text": "string" } }, "description": "This function returns markdown string by serializing tiptap editor document using prosemirror MarkdownSerializer" }, { "kind": "method", "name": "getMentionedHrefs", "privacy": "public", "return": { "type": { "text": "string[]" } } }, { "kind": "method", "name": "createConfig", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isMentionExtensionConfigUnchanged", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "prev", "type": { "text": "EditorConfiguration | undefined" } }, { "name": "next", "type": { "text": "EditorConfiguration | undefined" } } ] }, { "kind": "method", "name": "createEditor", "privacy": "private", "return": { "type": { "text": "HTMLDivElement" } } }, { "kind": "method", "name": "initializeEditor", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getHtmlContent", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "markdown", "type": { "text": "string" } } ], "description": "This function takes the Fragment from parseMarkdownToDOM function and return the serialized string using XMLSerializer" }, { "kind": "method", "name": "bindEditorTransactionEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Binding the \"transaction\" event to the editor allows continuous monitoring the events and updating the button state in response to\nvarious actions such as mouse events, keyboard events, changes in the editor content etc,.\nhttps://tiptap.dev/api/events#transaction" }, { "kind": "method", "name": "unbindEditorTransactionEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateEditorButtonsState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "keyActivatesButton", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "unbindEditorUpdateEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "bindEditorUpdateEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "input event is fired when there is a change in the content of the editor.\n\nhttps://tiptap.dev/api/events#update" }, { "kind": "method", "name": "disableEditor", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "disableMentionViewElement", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stopNativeInputEventPropagation", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Stopping the native input event propagation emitted by the contenteditable element in the Tiptap\nsince there is an issue (linked below) in ProseMirror where selecting the text and removing it\ndoes not trigger the native HTMLElement input event. So using the \"update\" event emitted by the\nTiptap to capture it as an \"input\" customEvent in the rich text editor.\n\nProse Mirror issue: https://discuss.prosemirror.net/t/how-to-handle-select-backspace-delete-cut-type-kind-of-events-handletextinput-or-handledomevents-input-doesnt-help/4844" }, { "kind": "method", "name": "unbindNativeInputEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "queueUpdateScrollbarWidth", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateScrollbarWidth", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "onResize", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getTipTapExtension", "privacy": "private", "return": { "type": { "text": "AnyExtension | undefined" } }, "parameters": [ { "name": "extensionName", "type": { "text": "string" } } ] }, { "kind": "method", "name": "setEditorTabIndex", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setActiveMappingConfigs", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "shouldInsertSpace", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "getMentionExtensionConfigFromCharacter", "privacy": "private", "return": { "type": { "text": "MentionExtensionConfiguration | undefined" } }, "parameters": [ { "name": "character", "type": { "text": "string" } } ] }, { "kind": "method", "name": "resetEditorButtonsState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "buttonsState", "type": { "text": "FormatButtonsState | undefined" } } ] }, { "kind": "method", "name": "getButtonsState", "privacy": "private", "return": { "type": { "text": "FormatButtonsState | undefined" } }, "parameters": [ { "name": "tiptapEditor", "type": { "text": "Editor" } } ] }, { "kind": "field", "name": "errorText", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error text that will be displayed when a component is in the error appearance", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorVisible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "errorHasOverflow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinErrorPattern", "module": "src/patterns/error/types.ts" } }, { "kind": "field", "name": "configuration", "type": { "text": "Configuration | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "mentionElements", "type": { "text": "RichTextMention[]" }, "privacy": "protected", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "richTextUpdateTracker", "privacy": "protected", "readonly": true, "default": "new RichTextUpdateTracker(this)", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "richTextValidator", "privacy": "protected", "readonly": true, "default": "new RichTextValidator()", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "RichTextValidity" }, "privacy": "public", "readonly": true, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "childItemsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "Element[] | undefined" } }, { "name": "_next", "type": { "text": "Element[]" } } ], "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "updateMentionElementsFromChildItems", "privacy": "private", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "observeMentionInternals", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "removeMentionInternalsObservers", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable user from editing and interacting with toolbar buttons", "fieldName": "disabled" }, { "name": "footer-hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the footer of the rich text editor", "fieldName": "footerHidden" }, { "name": "placeholder", "type": { "text": "string | undefined" }, "fieldName": "placeholder" } ], "mixins": [ { "name": "mixinErrorPattern", "module": "/src/patterns/error/types" } ], "superclass": { "name": "RichText", "module": "/src/rich-text/base" } }, { "kind": "variable", "name": "richTextEditorTag", "type": { "text": "string" }, "default": "'nimble-rich-text-editor'" } ], "exports": [ { "kind": "js", "name": "RichTextEditor", "declaration": { "name": "RichTextEditor", "module": "src/rich-text/editor/index.ts" } }, { "kind": "js", "name": "richTextEditorTag", "declaration": { "name": "richTextEditorTag", "module": "src/rich-text/editor/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text/editor/types.ts", "declarations": [ { "kind": "variable", "name": "TipTapNodeName", "type": { "text": "{\n bulletList: 'bulletList',\n numberedList: 'orderedList'\n}" }, "default": "{ bulletList: 'bulletList', numberedList: 'orderedList' }", "description": "TipTap node types.", "privacy": "public" }, { "kind": "variable", "name": "mentionPluginPrefix", "type": { "text": "string" }, "default": "'mention-plugin-'" } ], "exports": [ { "kind": "js", "name": "TipTapNodeName", "declaration": { "name": "TipTapNodeName", "module": "src/rich-text/editor/types.ts" } }, { "kind": "js", "name": "mentionPluginPrefix", "declaration": { "name": "mentionPluginPrefix", "module": "src/rich-text/editor/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text/viewer/index.ts", "declarations": [ { "kind": "class", "description": "A nimble styled rich text viewer", "name": "RichTextViewer", "members": [ { "kind": "field", "name": "markdown", "type": { "text": "string" }, "privacy": "public", "default": "''" }, { "kind": "field", "name": "mentionedHrefs", "type": { "text": "string[]" }, "privacy": "private", "default": "[]" }, { "kind": "method", "name": "getMentionedHrefs", "privacy": "public", "return": { "type": { "text": "string[]" } } }, { "kind": "method", "name": "updateView", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "configuration", "type": { "text": "Configuration | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "mentionElements", "type": { "text": "RichTextMention[]" }, "privacy": "protected", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "richTextUpdateTracker", "privacy": "protected", "readonly": true, "default": "new RichTextUpdateTracker(this)", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "richTextValidator", "privacy": "protected", "readonly": true, "default": "new RichTextValidator()", "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "RichTextValidity" }, "privacy": "public", "readonly": true, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "childItemsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "prev", "type": { "text": "Element[] | undefined" } }, { "name": "_next", "type": { "text": "Element[]" } } ], "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "updateMentionElementsFromChildItems", "privacy": "private", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "observeMentionInternals", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } }, { "kind": "method", "name": "removeMentionInternalsObservers", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichText", "module": "src/rich-text/base/index.ts" } } ], "attributes": [ { "name": "markdown", "type": { "text": "string" }, "default": "''", "fieldName": "markdown" } ], "superclass": { "name": "RichText", "module": "/src/rich-text/base" } }, { "kind": "variable", "name": "richTextViewerTag", "type": { "text": "string" }, "default": "'nimble-rich-text-viewer'" } ], "exports": [ { "kind": "js", "name": "RichTextViewer", "declaration": { "name": "RichTextViewer", "module": "src/rich-text/viewer/index.ts" } }, { "kind": "js", "name": "richTextViewerTag", "declaration": { "name": "richTextViewerTag", "module": "src/rich-text/viewer/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text-mention/base/index.ts", "declarations": [ { "kind": "class", "description": "The base class for Mention configuration", "name": "RichTextMention", "members": [ { "kind": "field", "name": "pattern", "type": { "text": "string | undefined" }, "privacy": "public", "description": "A regex used to extract user ID from user key (url) while parsing and serializing a markdown." }, { "kind": "field", "name": "buttonLabel", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "validity", "type": { "text": "RichTextMentionValidity" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "getObservedMappingProperty", "privacy": "protected", "return": { "type": { "text": "string[]" } } }, { "kind": "method", "name": "getMentionInternalsOptions", "privacy": "protected", "return": { "type": { "text": "MentionInternalsOptions" } } }, { "kind": "method", "name": "createMappingConfig", "privacy": "protected", "return": { "type": { "text": "MappingConfig" } }, "parameters": [ { "name": "mapping", "type": { "text": "Mapping" } } ] }, { "kind": "method", "name": "getMappingConfigs", "privacy": "private", "return": { "type": { "text": "MappingConfigs" } } }, { "kind": "method", "name": "updateMappingConfigs", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "mappingElementsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "patternChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "buttonLabelChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "removeMappingElementObservers", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "observeMappingElements", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "pattern", "type": { "text": "string | undefined" }, "description": "A regex used to extract user ID from user key (url) while parsing and serializing a markdown.", "fieldName": "pattern" }, { "name": "button-label", "type": { "text": "string | undefined" }, "fieldName": "buttonLabel" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "RichTextMention", "declaration": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text-mention/base/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/rich-text-mention/users/index.ts", "declarations": [ { "kind": "class", "description": "Rich Text user mention configuration element which will have MappingMentionUser elements as children", "name": "RichTextMentionUsers", "members": [ { "kind": "method", "name": "getMentionInternalsOptions", "privacy": "protected", "return": { "type": { "text": "MentionInternalsOptions" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "getObservedMappingProperty", "privacy": "protected", "return": { "type": { "text": "string[]" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "createMappingConfig", "privacy": "protected", "return": { "type": { "text": "MappingConfig" } }, "parameters": [ { "name": "mapping", "type": { "text": "Mapping" } } ], "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "field", "name": "pattern", "type": { "text": "string | undefined" }, "privacy": "public", "description": "A regex used to extract user ID from user key (url) while parsing and serializing a markdown.", "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "field", "name": "buttonLabel", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "RichTextMentionValidity" }, "privacy": "public", "readonly": true, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "getMappingConfigs", "privacy": "private", "return": { "type": { "text": "MappingConfigs" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "updateMappingConfigs", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "mappingElementsChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "patternChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "buttonLabelChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "removeMappingElementObservers", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "kind": "method", "name": "observeMappingElements", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } } ], "superclass": { "name": "RichTextMention", "module": "/src/rich-text-mention/base" }, "attributes": [ { "name": "pattern", "type": { "text": "string | undefined" }, "description": "A regex used to extract user ID from user key (url) while parsing and serializing a markdown.", "fieldName": "pattern", "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } }, { "name": "button-label", "type": { "text": "string | undefined" }, "fieldName": "buttonLabel", "inheritedFrom": { "name": "RichTextMention", "module": "src/rich-text-mention/base/index.ts" } } ] }, { "kind": "variable", "name": "richTextMentionUsersTag", "type": { "text": "string" }, "default": "'nimble-rich-text-mention-users'" } ], "exports": [ { "kind": "js", "name": "RichTextMentionUsers", "declaration": { "name": "RichTextMentionUsers", "module": "src/rich-text-mention/users/index.ts" } }, { "kind": "js", "name": "richTextMentionUsersTag", "declaration": { "name": "richTextMentionUsersTag", "module": "src/rich-text-mention/users/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/anchor/index.ts", "declarations": [ { "kind": "class", "description": "A table column for displaying links.", "name": "TableColumnAnchor", "members": [ { "kind": "field", "name": "labelFieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "hrefFieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "appearance", "type": { "text": "AnchorAppearance | undefined" }, "privacy": "public" }, { "kind": "field", "name": "underlineHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "hreflang", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "ping", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "referrerpolicy", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "target", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "type", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "defaultSortOperation", "privacy": "private", "readonly": true }, { "kind": "method", "name": "placeholderChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSortConfigurationChange", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "labelFieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hrefFieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "appearanceChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "underlineHiddenChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hreflangChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "pingChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "referrerpolicyChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "relChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "targetChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "typeChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "downloadChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnInternalsSortConfiguration", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "groupingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "field", "name": "groupIndex", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "method", "name": "groupingDisabledChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "method", "name": "groupIndexChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "field", "name": "fractionalWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "field", "name": "minPixelWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "fractionalWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "minPixelWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinColumnWithPlaceholderAPI", "module": "src/table-column/mixins/placeholder.ts" } }, { "kind": "field", "name": "sortingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } }, { "kind": "field", "name": "sortIndex", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } }, { "kind": "field", "name": "sortDirection", "type": { "text": "TableColumnSortDirection" }, "privacy": "public", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } }, { "kind": "field", "name": "sortByFieldName", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getResolvedOperandDataRecordFieldName", "privacy": "public", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "initialOperandFieldName", "type": { "text": "string | undefined" } } ], "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getResolvedSortOperation", "privacy": "public", "return": { "type": { "text": "TableColumnSortOperation" } }, "parameters": [ { "name": "initialSortOperation", "type": { "text": "TableColumnSortOperation" } } ], "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } } ], "attributes": [ { "name": "label-field-name", "type": { "text": "string | undefined" }, "fieldName": "labelFieldName" }, { "name": "href-field-name", "type": { "text": "string | undefined" }, "fieldName": "hrefFieldName" }, { "name": "appearance", "type": { "text": "AnchorAppearance | undefined" }, "fieldName": "appearance" }, { "name": "underline-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "underlineHidden" }, { "name": "hreflang", "type": { "text": "string | undefined" }, "fieldName": "hreflang" }, { "name": "ping", "type": { "text": "string | undefined" }, "fieldName": "ping" }, { "name": "referrerpolicy", "type": { "text": "string | undefined" }, "fieldName": "referrerpolicy" }, { "name": "rel", "type": { "text": "string | undefined" }, "fieldName": "rel" }, { "name": "target", "type": { "text": "string | undefined" }, "fieldName": "target" }, { "name": "type", "type": { "text": "string | undefined" }, "fieldName": "type" }, { "name": "download", "type": { "text": "string | undefined" }, "fieldName": "download" } ], "mixins": [ { "name": "mixinGroupableColumnAPI", "module": "/src/table-column/mixins/groupable-column" }, { "name": "mixinFractionalWidthColumnAPI", "module": "/src/table-column/mixins/fractional-width-column" }, { "name": "mixinColumnWithPlaceholderAPI", "module": "/src/table-column/mixins/placeholder" }, { "name": "mixinSortableColumnAPI", "module": "/src/table-column/mixins/sortable-column" }, { "name": "mixinCustomSortOrderColumnAPI", "module": "/src/table-column/mixins/custom-sort-order" } ], "superclass": { "module": "src/table-column/anchor/index.ts" } }, { "kind": "variable", "name": "tableColumnAnchorTag", "type": { "text": "string" }, "default": "'nimble-table-column-anchor'" } ], "exports": [ { "kind": "js", "name": "TableColumnAnchor", "declaration": { "name": "TableColumnAnchor", "module": "src/table-column/anchor/index.ts" } }, { "kind": "js", "name": "tableColumnAnchorTag", "declaration": { "name": "tableColumnAnchorTag", "module": "src/table-column/anchor/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/base/index.ts", "declarations": [ { "kind": "class", "description": "The base class for table columns", "name": "TableColumn", "members": [ { "kind": "field", "name": "columnId", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "actionMenuSlot", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "actionMenuLabel", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "validity", "type": { "text": "TableColumnValidity" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } } ], "attributes": [ { "name": "column-id", "type": { "text": "string | undefined" }, "fieldName": "columnId" }, { "name": "action-menu-slot", "type": { "text": "string | undefined" }, "fieldName": "actionMenuSlot" }, { "name": "action-menu-label", "type": { "text": "string | undefined" }, "fieldName": "actionMenuLabel" }, { "name": "column-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "columnHidden" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "TableColumn", "declaration": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/base/types.ts", "declarations": [ { "kind": "variable", "name": "TableColumnSortOperation", "type": { "text": "{\n /**\n * Performs a sort using `===`, `<`, and `>` operators\n */\n basic: 'basic',\n /**\n * Performs a locale-aware case-sensitive string sort on the columns.\n * Only use this sort operation if the field is of type `string | undefined | null`.\n */\n localeAwareCaseSensitive: 'localeAwareCaseSensitive'\n}" }, "default": "{ /** * Performs a sort using `===`, `<`, and `>` operators */ basic: 'basic', /** * Performs a locale-aware case-sensitive string sort on the columns. * Only use this sort operation if the field is of type `string | undefined | null`. */ localeAwareCaseSensitive: 'localeAwareCaseSensitive' }", "description": "The possible operations to use when sorting a table column." }, { "kind": "variable", "name": "defaultMinPixelWidth" }, { "kind": "variable", "name": "singleIconColumnWidth" }, { "kind": "variable", "name": "defaultFractionalWidth", "type": { "text": "number" }, "default": "1" } ], "exports": [ { "kind": "js", "name": "TableColumnSortOperation", "declaration": { "name": "TableColumnSortOperation", "module": "src/table-column/base/types.ts" } }, { "kind": "js", "name": "defaultMinPixelWidth", "declaration": { "name": "defaultMinPixelWidth", "module": "src/table-column/base/types.ts" } }, { "kind": "js", "name": "singleIconColumnWidth", "declaration": { "name": "singleIconColumnWidth", "module": "src/table-column/base/types.ts" } }, { "kind": "js", "name": "defaultFractionalWidth", "declaration": { "name": "defaultFractionalWidth", "module": "src/table-column/base/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/date-text/index.ts", "declarations": [ { "kind": "class", "description": "The table column for displaying dates/times as text.", "name": "TableColumnDateText", "members": [ { "kind": "field", "name": "format", "type": { "text": "DateTextFormat" }, "privacy": "public" }, { "kind": "field", "name": "customLocaleMatcher", "type": { "text": "LocaleMatcherAlgorithm" }, "privacy": "public" }, { "kind": "field", "name": "customWeekday", "type": { "text": "WeekdayFormat" }, "privacy": "public" }, { "kind": "field", "name": "customEra", "type": { "text": "EraFormat" }, "privacy": "public" }, { "kind": "field", "name": "customYear", "type": { "text": "YearFormat" }, "privacy": "public" }, { "kind": "field", "name": "customMonth", "type": { "text": "MonthFormat" }, "privacy": "public" }, { "kind": "field", "name": "customDay", "type": { "text": "DayFormat" }, "privacy": "public" }, { "kind": "field", "name": "customHour", "type": { "text": "HourFormat" }, "privacy": "public" }, { "kind": "field", "name": "customMinute", "type": { "text": "MinuteFormat" }, "privacy": "public" }, { "kind": "field", "name": "customSecond", "type": { "text": "SecondFormat" }, "privacy": "public" }, { "kind": "field", "name": "customTimeZoneName", "type": { "text": "TimeZoneNameFormat" }, "privacy": "public" }, { "kind": "field", "name": "customFormatMatcher", "type": { "text": "FormatMatcherAlgorithm" }, "privacy": "public" }, { "kind": "field", "name": "customHour12", "type": { "text": "boolean | undefined" }, "privacy": "public" }, { "kind": "field", "name": "customTimeZone", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "customCalendar", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "customDayPeriod", "type": { "text": "DayPeriodFormat" }, "privacy": "public" }, { "kind": "field", "name": "customNumberingSystem", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "customDateStyle", "type": { "text": "DateStyle" }, "privacy": "public" }, { "kind": "field", "name": "customTimeStyle", "type": { "text": "TimeStyle" }, "privacy": "public" }, { "kind": "field", "name": "customHourCycle", "type": { "text": "HourCycleFormat" }, "privacy": "public" }, { "kind": "field", "name": "langSubscriber", "type": { "text": "DesignTokenSubscriber" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateColumnConfig(); } }" }, { "kind": "method", "name": "placeholderChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "formatChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customLocaleMatcherChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customWeekdayChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customEraChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customYearChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customMonthChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customDayChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customHourChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customMinuteChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customSecondChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customTimeZoneNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customFormatMatcherChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customHour12Changed", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customTimeZoneChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customCalendarChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customDayPeriodChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customNumberingSystemChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customDateStyleChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customTimeStyleChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "customHourCycleChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "createFormatter", "privacy": "private", "return": { "type": { "text": "Intl.DateTimeFormat | undefined" } } }, { "kind": "method", "name": "getCustomFormattingOptions", "privacy": "private", "return": { "type": { "text": "Intl.DateTimeFormatOptions" } } } ], "attributes": [ { "name": "format", "type": { "text": "DateTextFormat" }, "fieldName": "format" }, { "name": "custom-locale-matcher", "type": { "text": "LocaleMatcherAlgorithm" }, "fieldName": "customLocaleMatcher" }, { "name": "custom-weekday", "type": { "text": "WeekdayFormat" }, "fieldName": "customWeekday" }, { "name": "custom-era", "type": { "text": "EraFormat" }, "fieldName": "customEra" }, { "name": "custom-year", "type": { "text": "YearFormat" }, "fieldName": "customYear" }, { "name": "custom-month", "type": { "text": "MonthFormat" }, "fieldName": "customMonth" }, { "name": "custom-day", "type": { "text": "DayFormat" }, "fieldName": "customDay" }, { "name": "custom-hour", "type": { "text": "HourFormat" }, "fieldName": "customHour" }, { "name": "custom-minute", "type": { "text": "MinuteFormat" }, "fieldName": "customMinute" }, { "name": "custom-second", "type": { "text": "SecondFormat" }, "fieldName": "customSecond" }, { "name": "custom-time-zone-name", "type": { "text": "TimeZoneNameFormat" }, "fieldName": "customTimeZoneName" }, { "name": "custom-format-matcher", "type": { "text": "FormatMatcherAlgorithm" }, "fieldName": "customFormatMatcher" }, { "name": "custom-hour12", "type": { "text": "boolean | undefined" }, "fieldName": "customHour12" }, { "name": "custom-time-zone", "type": { "text": "string | undefined" }, "fieldName": "customTimeZone" }, { "name": "custom-calendar", "type": { "text": "string | undefined" }, "fieldName": "customCalendar" }, { "name": "custom-day-period", "type": { "text": "DayPeriodFormat" }, "fieldName": "customDayPeriod" }, { "name": "custom-numbering-system", "type": { "text": "string | undefined" }, "fieldName": "customNumberingSystem" }, { "name": "custom-date-style", "type": { "text": "DateStyle" }, "fieldName": "customDateStyle" }, { "name": "custom-time-style", "type": { "text": "TimeStyle" }, "fieldName": "customTimeStyle" }, { "name": "custom-hour-cycle", "type": { "text": "HourCycleFormat" }, "fieldName": "customHourCycle" } ], "mixins": [ { "name": "mixinTextBase", "module": "/src/table-column/text-base" } ], "superclass": { "module": "src/table-column/date-text/index.ts" } }, { "kind": "variable", "name": "formatter" }, { "kind": "variable", "name": "tableColumnDateTextTag", "type": { "text": "string" }, "default": "'nimble-table-column-date-text'" } ], "exports": [ { "kind": "js", "name": "TableColumnDateText", "declaration": { "name": "TableColumnDateText", "module": "src/table-column/date-text/index.ts" } }, { "kind": "js", "name": "tableColumnDateTextTag", "declaration": { "name": "tableColumnDateTextTag", "module": "src/table-column/date-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/date-text/types.ts", "declarations": [ { "kind": "variable", "name": "DateTextFormat", "type": { "text": "{\n default: undefined,\n custom: 'custom'\n}" }, "default": "{ default: undefined, custom: 'custom' }", "description": "Formatting scheme for the date-text table column" } ], "exports": [ { "kind": "js", "name": "DateTextFormat", "declaration": { "name": "DateTextFormat", "module": "src/table-column/date-text/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/duration-text/index.ts", "declarations": [ { "kind": "class", "description": "The table column for displaying a duration value as text.", "name": "TableColumnDurationText", "members": [ { "kind": "field", "name": "langSubscriber", "type": { "text": "DesignTokenSubscriber" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateColumnConfig(); } }" }, { "kind": "method", "name": "placeholderChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } } } ], "mixins": [ { "name": "mixinTextBase", "module": "/src/table-column/text-base" } ], "superclass": { "module": "src/table-column/duration-text/index.ts" } }, { "kind": "variable", "name": "formatter", "default": "new DurationFormatter(lang.getValueFor(this))" }, { "kind": "variable", "name": "tableColumnDurationTextTag", "type": { "text": "string" }, "default": "'nimble-table-column-duration-text'" } ], "exports": [ { "kind": "js", "name": "TableColumnDurationText", "declaration": { "name": "TableColumnDurationText", "module": "src/table-column/duration-text/index.ts" } }, { "kind": "js", "name": "tableColumnDurationTextTag", "declaration": { "name": "tableColumnDurationTextTag", "module": "src/table-column/duration-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/enum-base/index.ts", "declarations": [ { "kind": "class", "description": "Base class for table columns that map values to content", "name": "TableColumnEnumBase", "members": [ { "kind": "field", "name": "fieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "keyType", "type": { "text": "MappingKeyType" }, "privacy": "public", "default": "'string'" }, { "kind": "method", "name": "createMappingConfig", "privacy": "protected", "return": { "type": { "text": "MappingConfig" } }, "parameters": [ { "name": "mapping", "type": { "text": "Mapping" } } ], "description": "Implementations should throw an error if an invalid Mapping is passed." }, { "kind": "method", "name": "createColumnConfig", "privacy": "protected", "return": { "type": { "text": "TColumnConfig" } }, "parameters": [ { "name": "mappingConfigs", "type": { "text": "MappingConfigs" } } ] }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Called when any Mapping related state has changed." }, { "kind": "method", "name": "getMappingConfigs", "privacy": "private", "return": { "type": { "text": "MappingConfigs" } } }, { "kind": "method", "name": "fieldNameChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "mappingsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "keyTypeChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "removeMappingObservers", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "observeMappings", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "columnId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "actionMenuSlot", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "actionMenuLabel", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "columnHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "TableColumnValidity" }, "privacy": "public", "readonly": true, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } }, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } } ], "attributes": [ { "name": "field-name", "type": { "text": "string | undefined" }, "fieldName": "fieldName" }, { "name": "key-type", "type": { "text": "MappingKeyType" }, "default": "'string'", "fieldName": "keyType" }, { "name": "column-id", "type": { "text": "string | undefined" }, "fieldName": "columnId", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "action-menu-slot", "type": { "text": "string | undefined" }, "fieldName": "actionMenuSlot", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "action-menu-label", "type": { "text": "string | undefined" }, "fieldName": "actionMenuLabel", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "column-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "columnHidden", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } } ], "superclass": { "name": "TableColumn", "module": "/src/table-column/base" } } ], "exports": [ { "kind": "js", "name": "TableColumnEnumBase", "declaration": { "name": "TableColumnEnumBase", "module": "src/table-column/enum-base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/enum-base/types.ts", "declarations": [ { "kind": "variable", "name": "MappingKeyType", "type": { "text": "{\n string: 'string',\n number: 'number',\n boolean: 'boolean'\n}" }, "default": "{ string: 'string', number: 'number', boolean: 'boolean' }", "description": "Input data types for mapping-based columns", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "MappingKeyType", "declaration": { "name": "MappingKeyType", "module": "src/table-column/enum-base/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mapping/index.ts", "declarations": [ { "kind": "class", "description": "Table column that maps number, boolean, or string values to an icon, a spinner,\ntext, or an icon/spinner with text.", "name": "TableColumnMapping", "members": [ { "kind": "field", "name": "widthMode", "type": { "text": "TableColumnMappingWidthMode" }, "privacy": "public" }, { "kind": "method", "name": "minPixelWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "createColumnConfig", "privacy": "protected", "return": { "type": { "text": "TableColumnEnumColumnConfig" } }, "parameters": [ { "name": "mappingConfigs", "type": { "text": "MappingConfigs" } } ] }, { "kind": "method", "name": "createMappingConfig", "privacy": "protected", "return": { "type": { "text": "MappingConfig" } }, "parameters": [ { "name": "mapping", "type": { "text": "Mapping" } } ] }, { "kind": "method", "name": "widthModeChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getConfiguredMinPixelWidth", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "field", "name": "groupingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "field", "name": "groupIndex", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "method", "name": "groupingDisabledChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "method", "name": "groupIndexChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } }, { "kind": "field", "name": "fractionalWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "field", "name": "minPixelWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "fractionalWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "field", "name": "sortingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } }, { "kind": "field", "name": "sortIndex", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } }, { "kind": "field", "name": "sortDirection", "type": { "text": "TableColumnSortDirection" }, "privacy": "public", "inheritedFrom": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } } ], "attributes": [ { "name": "width-mode", "type": { "text": "TableColumnMappingWidthMode" }, "fieldName": "widthMode" } ], "mixins": [ { "name": "mixinGroupableColumnAPI", "module": "/src/table-column/mixins/groupable-column" }, { "name": "mixinFractionalWidthColumnAPI", "module": "/src/table-column/mixins/fractional-width-column" }, { "name": "mixinSortableColumnAPI", "module": "/src/table-column/mixins/sortable-column" } ], "superclass": { "module": "src/table-column/mapping/index.ts" } }, { "kind": "variable", "name": "tableColumnMappingTag", "type": { "text": "string" }, "default": "'nimble-table-column-mapping'" } ], "exports": [ { "kind": "js", "name": "TableColumnMapping", "declaration": { "name": "TableColumnMapping", "module": "src/table-column/mapping/index.ts" } }, { "kind": "js", "name": "tableColumnMappingTag", "declaration": { "name": "tableColumnMappingTag", "module": "src/table-column/mapping/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mapping/types.ts", "declarations": [ { "kind": "variable", "name": "TableColumnMappingWidthMode", "type": { "text": "{\n default: undefined,\n iconSize: 'icon-size'\n}" }, "default": "{ default: undefined, iconSize: 'icon-size' }", "description": "Width mode for the mapping column" } ], "exports": [ { "kind": "js", "name": "TableColumnMappingWidthMode", "declaration": { "name": "TableColumnMappingWidthMode", "module": "src/table-column/mapping/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/menu-button/index.ts", "declarations": [ { "kind": "class", "description": "The table column for displaying string fields as the content within a menu button.", "name": "TableColumnMenuButton", "members": [ { "kind": "field", "name": "fieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "menuSlot", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "fieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "menuSlotChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "fractionalWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "field", "name": "minPixelWidth", "type": { "text": "number | null | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "fractionalWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } }, { "kind": "method", "name": "minPixelWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } } ], "attributes": [ { "name": "field-name", "type": { "text": "string | undefined" }, "fieldName": "fieldName" }, { "name": "menu-slot", "type": { "text": "string | undefined" }, "fieldName": "menuSlot" } ], "mixins": [ { "name": "mixinFractionalWidthColumnAPI", "module": "/src/table-column/mixins/fractional-width-column" } ], "superclass": { "module": "src/table-column/menu-button/index.ts" } }, { "kind": "variable", "name": "tableColumnMenuButtonTag", "type": { "text": "string" }, "default": "'nimble-table-column-menu-button'" } ], "exports": [ { "kind": "js", "name": "TableColumnMenuButton", "declaration": { "name": "TableColumnMenuButton", "module": "src/table-column/menu-button/index.ts" } }, { "kind": "js", "name": "tableColumnMenuButtonTag", "declaration": { "name": "tableColumnMenuButtonTag", "module": "src/table-column/menu-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/menu-button/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/table-column/mixins/custom-sort-order.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinCustomSortOrderColumnAPI", "members": [ { "kind": "field", "name": "sortByFieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "method", "name": "getResolvedOperandDataRecordFieldName", "privacy": "public", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "initialOperandFieldName", "type": { "text": "string | undefined" } } ] }, { "kind": "method", "name": "getResolvedSortOperation", "privacy": "public", "return": { "type": { "text": "TableColumnSortOperation" } }, "parameters": [ { "name": "initialSortOperation", "type": { "text": "TableColumnSortOperation" } } ] }, { "kind": "method", "name": "handleSortConfigurationChange", "privacy": "public", "return": { "type": { "text": "void" } } } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinCustomSortOrderColumnAPI", "declaration": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mixins/fractional-width-column.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinFractionalWidthColumnAPI", "members": [ { "kind": "field", "name": "fractionalWidth", "type": { "text": "number | null | undefined" }, "privacy": "public" }, { "kind": "field", "name": "minPixelWidth", "type": { "text": "number | null | undefined" }, "privacy": "public" }, { "kind": "method", "name": "fractionalWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "minPixelWidthChanged", "privacy": "public", "return": { "type": { "text": "void" } } } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinFractionalWidthColumnAPI", "declaration": { "name": "mixinFractionalWidthColumnAPI", "module": "src/table-column/mixins/fractional-width-column.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mixins/groupable-column.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinGroupableColumnAPI", "members": [ { "kind": "field", "name": "groupingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "groupIndex", "type": { "text": "number | null | undefined" }, "privacy": "public" }, { "kind": "method", "name": "groupingDisabledChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "groupIndexChanged", "privacy": "public", "return": { "type": { "text": "void" } } } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinGroupableColumnAPI", "declaration": { "name": "mixinGroupableColumnAPI", "module": "src/table-column/mixins/groupable-column.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mixins/placeholder.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinColumnWithPlaceholderAPI", "members": [ { "kind": "field", "name": "placeholder", "type": { "text": "string | undefined" }, "privacy": "public" } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinColumnWithPlaceholderAPI", "declaration": { "name": "mixinColumnWithPlaceholderAPI", "module": "src/table-column/mixins/placeholder.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mixins/sortable-column.ts", "declarations": [ { "kind": "mixin", "description": "", "name": "mixinSortableColumnAPI", "members": [ { "kind": "field", "name": "sortingDisabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "sortIndex", "type": { "text": "number | null | undefined" }, "privacy": "public" }, { "kind": "field", "name": "sortDirection", "type": { "text": "TableColumnSortDirection" }, "privacy": "public" } ], "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mixinSortableColumnAPI", "declaration": { "name": "mixinSortableColumnAPI", "module": "src/table-column/mixins/sortable-column.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/number-text/index.ts", "declarations": [ { "kind": "class", "description": "The table column for displaying numbers as text.", "name": "TableColumnNumberText", "members": [ { "kind": "field", "name": "format", "type": { "text": "NumberTextFormat" }, "privacy": "public" }, { "kind": "field", "name": "alignment", "type": { "text": "NumberTextAlignment" }, "privacy": "public" }, { "kind": "field", "name": "decimalDigits", "type": { "text": "number | undefined" }, "privacy": "public" }, { "kind": "field", "name": "decimalMaximumDigits", "type": { "text": "number | undefined" }, "privacy": "public" }, { "kind": "field", "name": "unit", "type": { "text": "Unit | undefined" }, "privacy": "private" }, { "kind": "field", "name": "unitNotifier", "type": { "text": "Notifier | undefined" }, "privacy": "private" }, { "kind": "field", "name": "langSubscriber", "type": { "text": "DesignTokenSubscriber" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateColumnConfig(); } }" }, { "kind": "field", "name": "unitSubscriber", "type": { "text": "Subscriber" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.updateColumnConfig(); } }" }, { "kind": "method", "name": "placeholderChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "updateUnitNotifier", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "formatChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "alignmentChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "decimalDigitsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "decimalMaximumDigitsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "unitElementsChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateUnit", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "unitChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnConfig", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "createFormatter", "privacy": "private", "return": { "type": { "text": "UnitFormat" } } }, { "kind": "method", "name": "determineCellContentAlignment", "privacy": "private", "return": { "type": { "text": "TableColumnAlignment" } } } ], "attributes": [ { "name": "format", "type": { "text": "NumberTextFormat" }, "fieldName": "format" }, { "name": "alignment", "type": { "text": "NumberTextAlignment" }, "fieldName": "alignment" }, { "name": "decimal-digits", "type": { "text": "number | undefined" }, "fieldName": "decimalDigits" }, { "name": "decimal-maximum-digits", "type": { "text": "number | undefined" }, "fieldName": "decimalMaximumDigits" } ], "mixins": [ { "name": "mixinTextBase", "module": "/src/table-column/text-base" } ], "superclass": { "module": "src/table-column/number-text/index.ts" } }, { "kind": "variable", "name": "tableColumnNumberTextTag", "type": { "text": "string" }, "default": "'nimble-table-column-number-text'" } ], "exports": [ { "kind": "js", "name": "TableColumnNumberText", "declaration": { "name": "TableColumnNumberText", "module": "src/table-column/number-text/index.ts" } }, { "kind": "js", "name": "tableColumnNumberTextTag", "declaration": { "name": "tableColumnNumberTextTag", "module": "src/table-column/number-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/number-text/types.ts", "declarations": [ { "kind": "variable", "name": "NumberTextFormat", "type": { "text": "{\n default: undefined,\n decimal: 'decimal'\n}" }, "default": "{ default: undefined, decimal: 'decimal' }", "description": "Formatting scheme for the number-text table column" }, { "kind": "variable", "name": "NumberTextAlignment", "type": { "text": "{\n default: undefined,\n left: 'left',\n right: 'right'\n}" }, "default": "{ default: undefined, left: 'left', right: 'right' }", "description": "The aligment of the value in the number-text table column.\nThe `default` alignment is determined by the column's `NumberTextFormat`." } ], "exports": [ { "kind": "js", "name": "NumberTextFormat", "declaration": { "name": "NumberTextFormat", "module": "src/table-column/number-text/types.ts" } }, { "kind": "js", "name": "NumberTextAlignment", "declaration": { "name": "NumberTextAlignment", "module": "src/table-column/number-text/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text/index.ts", "declarations": [ { "kind": "class", "description": "The table column for displaying string fields as text.", "name": "TableColumnText", "members": [ { "kind": "field", "name": "defaultSortOperation", "privacy": "private", "readonly": true }, { "kind": "method", "name": "placeholderChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSortConfigurationChange", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } } }, { "kind": "method", "name": "fieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateColumnInternalsSortConfiguration", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "sortByFieldName", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getResolvedOperandDataRecordFieldName", "privacy": "public", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "initialOperandFieldName", "type": { "text": "string | undefined" } } ], "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } }, { "kind": "method", "name": "getResolvedSortOperation", "privacy": "public", "return": { "type": { "text": "TableColumnSortOperation" } }, "parameters": [ { "name": "initialSortOperation", "type": { "text": "TableColumnSortOperation" } } ], "inheritedFrom": { "name": "mixinCustomSortOrderColumnAPI", "module": "src/table-column/mixins/custom-sort-order.ts" } } ], "mixins": [ { "name": "mixinCustomSortOrderColumnAPI", "module": "/src/table-column/mixins/custom-sort-order" }, { "name": "mixinTextBase", "module": "/src/table-column/text-base" } ], "superclass": { "module": "src/table-column/text/index.ts" } }, { "kind": "variable", "name": "tableColumnTextTag", "type": { "text": "string" }, "default": "'nimble-table-column-text'" } ], "exports": [ { "kind": "js", "name": "TableColumnText", "declaration": { "name": "TableColumnText", "module": "src/table-column/text/index.ts" } }, { "kind": "js", "name": "tableColumnTextTag", "declaration": { "name": "tableColumnTextTag", "module": "src/table-column/text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text-base/index.ts", "declarations": [ { "kind": "class", "description": "The base class for table columns that display fields of any type as text.", "name": "TableColumnTextBase", "members": [ { "kind": "field", "name": "fieldName", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "method", "name": "fieldNameChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "columnId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "actionMenuSlot", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "actionMenuLabel", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "columnHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "TableColumnValidity" }, "privacy": "public", "readonly": true, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "kind": "method", "name": "getColumnInternalsOptions", "privacy": "protected", "return": { "type": { "text": "ColumnInternalsOptions" } }, "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } } ], "attributes": [ { "name": "field-name", "type": { "text": "string | undefined" }, "fieldName": "fieldName" }, { "name": "column-id", "type": { "text": "string | undefined" }, "fieldName": "columnId", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "action-menu-slot", "type": { "text": "string | undefined" }, "fieldName": "actionMenuSlot", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "action-menu-label", "type": { "text": "string | undefined" }, "fieldName": "actionMenuLabel", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } }, { "name": "column-hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "columnHidden", "inheritedFrom": { "name": "TableColumn", "module": "src/table-column/base/index.ts" } } ], "superclass": { "name": "TableColumn", "module": "/src/table-column/base" } }, { "kind": "function", "name": "mixinTextBase", "parameters": [ { "name": "base", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "TableColumnTextBase", "declaration": { "name": "TableColumnTextBase", "module": "src/table-column/text-base/index.ts" } }, { "kind": "js", "name": "mixinTextBase", "declaration": { "name": "mixinTextBase", "module": "src/table-column/text-base/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/unit/base/unit.ts", "declarations": [ { "kind": "class", "description": "The base class for an element that provides a unit scale for scaled unit conversions", "name": "Unit", "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "Unit", "declaration": { "name": "Unit", "module": "src/unit/base/unit.ts" } } ] }, { "kind": "javascript-module", "path": "src/unit/byte/index.ts", "declarations": [ { "kind": "class", "description": "Element that provides a unit scale for conversion of bytes", "name": "UnitByte", "members": [ { "kind": "field", "name": "binary", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Use binary (base 1024 scale with binary prefixes) instead of\nthe default of decimal (base 1000 scale with metric prefixes)" }, { "kind": "method", "name": "binaryChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "resolvedUnitScale", "default": "unitScaleByte" } ], "attributes": [ { "name": "binary", "type": { "text": "boolean" }, "default": "false", "description": "Use binary (base 1024 scale with binary prefixes) instead of\nthe default of decimal (base 1000 scale with metric prefixes)", "fieldName": "binary" } ], "superclass": { "name": "Unit", "module": "/src/unit/base/unit" } }, { "kind": "variable", "name": "unitByteTag", "type": { "text": "string" }, "default": "'nimble-unit-byte'" } ], "exports": [ { "kind": "js", "name": "UnitByte", "declaration": { "name": "UnitByte", "module": "src/unit/byte/index.ts" } }, { "kind": "js", "name": "unitByteTag", "declaration": { "name": "unitByteTag", "module": "src/unit/byte/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/unit/celsius/index.ts", "declarations": [ { "kind": "class", "description": "Element representing degrees Celsius unit", "name": "UnitCelsius", "members": [ { "kind": "field", "name": "resolvedUnitScale", "default": "unitScaleCelsius" } ], "superclass": { "name": "Unit", "module": "/src/unit/base/unit" } }, { "kind": "variable", "name": "unitCelsiusTag", "type": { "text": "string" }, "default": "'nimble-unit-celsius'" } ], "exports": [ { "kind": "js", "name": "UnitCelsius", "declaration": { "name": "UnitCelsius", "module": "src/unit/celsius/index.ts" } }, { "kind": "js", "name": "unitCelsiusTag", "declaration": { "name": "unitCelsiusTag", "module": "src/unit/celsius/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/unit/fahrenheit/index.ts", "declarations": [ { "kind": "class", "description": "Element representing degrees Fahrenheit unit", "name": "UnitFahrenheit", "members": [ { "kind": "field", "name": "resolvedUnitScale", "default": "unitScaleFahrenheit" } ], "superclass": { "name": "Unit", "module": "/src/unit/base/unit" } }, { "kind": "variable", "name": "unitFahrenheitTag", "type": { "text": "string" }, "default": "'nimble-unit-fahrenheit'" } ], "exports": [ { "kind": "js", "name": "UnitFahrenheit", "declaration": { "name": "UnitFahrenheit", "module": "src/unit/fahrenheit/index.ts" } }, { "kind": "js", "name": "unitFahrenheitTag", "declaration": { "name": "unitFahrenheitTag", "module": "src/unit/fahrenheit/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/unit/volt/index.ts", "declarations": [ { "kind": "class", "description": "Element representing units for volts", "name": "UnitVolt", "members": [ { "kind": "field", "name": "resolvedUnitScale", "default": "unitScaleVolt" } ], "superclass": { "name": "Unit", "module": "/src/unit/base/unit" } }, { "kind": "variable", "name": "unitVoltTag", "type": { "text": "string" }, "default": "'nimble-unit-volt'" } ], "exports": [ { "kind": "js", "name": "UnitVolt", "declaration": { "name": "UnitVolt", "module": "src/unit/volt/index.ts" } }, { "kind": "js", "name": "unitVoltTag", "declaration": { "name": "unitVoltTag", "module": "src/unit/volt/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/experimental/computations.ts", "declarations": [ { "kind": "class", "description": "Computations calculates and stores different measures which are used in the Wafermap", "name": "Computations", "members": [ { "kind": "field", "name": "horizontalScale", "type": { "text": "ScaleLinear" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "verticalScale", "type": { "text": "ScaleLinear" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "containerDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "dieDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "margin", "type": { "text": "Margin" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "verticalCoefficient", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "horizontalCoefficient", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "horizontalConstant", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "verticalConstant", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "gridMinX", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "gridMaxX", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "gridMinY", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "gridMaxY", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "labelsFontSize", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "colorScale", "type": { "text": "ColorScale" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "_horizontalScale", "type": { "text": "ScaleLinear" }, "privacy": "private" }, { "kind": "field", "name": "_verticalScale", "type": { "text": "ScaleLinear" }, "privacy": "private" }, { "kind": "field", "name": "_containerDimensions", "type": { "text": "Dimensions" }, "privacy": "private" }, { "kind": "field", "name": "_dieDimensions", "type": { "text": "Dimensions" }, "privacy": "private" }, { "kind": "field", "name": "_margin", "type": { "text": "Margin" }, "privacy": "private" }, { "kind": "field", "name": "_verticalCoefficient", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_horizontalCoefficient", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_horizontalConstant", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_verticalConstant", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_gridMinX", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_gridMaxX", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_gridMinY", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_gridMaxY", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_labelsFontSize", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_colorScale", "type": { "text": "ColorScale" }, "privacy": "private" }, { "kind": "field", "name": "baseMarginPercentage", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0.04" }, { "kind": "field", "name": "fontSizeFactor", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0.8" }, { "kind": "field", "name": "colorScaleResolution", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "10" }, { "kind": "method", "name": "componentResizeUpdate", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "inputDataUpdate", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "colorAndTextUpdate", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridDimensionsValidAndDefined", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "setGridDimensionsFromBoundingBox", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setGridDimensionsFromDies", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "calculateContainerDimensions", "privacy": "private", "return": { "type": { "text": "Dimensions" } }, "parameters": [ { "name": "canvasDimensions", "type": { "text": "Dimensions" } }, { "name": "margin", "type": { "text": "Margin" } } ] }, { "kind": "method", "name": "createHorizontalScale", "privacy": "private", "return": { "type": { "text": "ScaleLinear" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "containerWidth", "type": { "text": "number" } } ] }, { "kind": "method", "name": "createVerticalScale", "privacy": "private", "return": { "type": { "text": "ScaleLinear" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "containerHeight", "type": { "text": "number" } } ] }, { "kind": "method", "name": "calculateMarginAddition", "privacy": "private", "return": { "type": { "text": "Margin" } }, "parameters": [ { "name": "baseMargin", "type": { "text": "Margin" } }, { "name": "addedMargin", "type": { "text": "Margin" } } ] }, { "kind": "method", "name": "calculateColorScale", "privacy": "private", "return": { "type": { "text": "ColorScale" } } }, { "kind": "method", "name": "calculateLabelsFontSize", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "dieDimensions", "type": { "text": "Dimensions" } }, { "name": "maxCharacters", "type": { "text": "number" } } ] } ] } ], "exports": [ { "kind": "js", "name": "Computations", "declaration": { "name": "Computations", "module": "src/wafer-map/experimental/computations.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/experimental/hover-handler.ts", "declarations": [ { "kind": "class", "description": "HoverHandler deals with user interactions and events like hovering", "name": "HoverHandler", "members": [ { "kind": "field", "name": "onMouseMove", "privacy": "private", "readonly": true }, { "kind": "field", "name": "onMouseOut", "privacy": "private", "readonly": true }, { "kind": "method", "name": "calculateDieCoordinates", "privacy": "private", "return": { "type": { "text": "PointCoordinates | undefined" } }, "parameters": [ { "name": "mousePosition", "type": { "text": "PointCoordinates" } } ] }, { "kind": "method", "name": "isDieInGrid", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "x", "type": { "text": "number" } }, { "name": "y", "type": { "text": "number" } } ] } ] } ], "exports": [ { "kind": "js", "name": "HoverHandler", "declaration": { "name": "HoverHandler", "module": "src/wafer-map/experimental/hover-handler.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/experimental/worker-renderer.ts", "declarations": [ { "kind": "class", "description": "Responsible for drawing the dies inside the wafer map, adding dieText and scaling the canvas", "name": "WorkerRenderer", "members": [ { "kind": "field", "name": "minDieDim", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "100" }, { "kind": "method", "name": "setupWafer", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "snapshot", "type": { "text": "{\n canvasDimensions: Dimensions,\n renderConfig: RenderConfig,\n columnIndices: Int32Array,\n rowIndices: Int32Array,\n values: Float64Array\n }" } } ] }, { "kind": "method", "name": "drawWafer", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "snapshot", "type": { "text": "{\n canvasDimensions: Dimensions,\n dieDimensions: Dimensions,\n transform: ZoomTransform,\n dieLabelsHidden: boolean\n }" } } ] }, { "kind": "method", "name": "renderHover", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "calculateHoverTransform", "privacy": "private", "return": { "type": { "text": "string" } } } ] } ], "exports": [ { "kind": "js", "name": "WorkerRenderer", "declaration": { "name": "WorkerRenderer", "module": "src/wafer-map/experimental/worker-renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/computations.ts", "declarations": [ { "kind": "class", "description": "Computations calculates and stores different measures which are used in the Wafermap", "name": "Computations", "members": [ { "kind": "field", "name": "containerDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "dieDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "radius", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "margin", "type": { "text": "Margin" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "horizontalScale", "type": { "text": "ScaleBand" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "verticalScale", "type": { "text": "ScaleBand" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "invertedHorizontalScale", "type": { "text": "ScaleQuantile" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "invertedVerticalScale", "type": { "text": "ScaleQuantile" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "_containerDimensions", "type": { "text": "Dimensions" }, "privacy": "private" }, { "kind": "field", "name": "_dieDimensions", "type": { "text": "Dimensions" }, "privacy": "private" }, { "kind": "field", "name": "_radius", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_margin", "type": { "text": "Margin" }, "privacy": "private" }, { "kind": "field", "name": "_horizontalScale", "type": { "text": "ScaleBand" }, "privacy": "private" }, { "kind": "field", "name": "_verticalScale", "type": { "text": "ScaleBand" }, "privacy": "private" }, { "kind": "field", "name": "_invertedHorizontalScale", "type": { "text": "ScaleQuantile" }, "privacy": "private" }, { "kind": "field", "name": "_invertedVerticalScale", "type": { "text": "ScaleQuantile" }, "privacy": "private" }, { "kind": "field", "name": "defaultPadding", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0" }, { "kind": "field", "name": "baseMarginPercentage", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0.04" }, { "kind": "method", "name": "updateContainerDimensions", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateScales", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "gridDimensionsValidAndDefined", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "calculateGridDimensionsFromBoundingBox", "privacy": "private", "return": { "type": { "text": "GridDimensions" } } }, { "kind": "method", "name": "calculateGridDimensionsFromDies", "privacy": "private", "return": { "type": { "text": "GridDimensions" } }, "parameters": [ { "name": "dies", "type": { "text": "readonly Readonly[]" } } ] }, { "kind": "method", "name": "calculateContainerDimensions", "privacy": "private", "return": { "type": { "text": "Dimensions" } }, "parameters": [ { "name": "canvasDimensions", "type": { "text": "Dimensions" } }, { "name": "margin", "type": { "text": "Margin" } } ] }, { "kind": "method", "name": "createHorizontalScale", "privacy": "private", "return": { "type": { "text": "ScaleBand" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "grid", "type": { "text": "GridDimensions" } }, { "name": "containerWidth", "type": { "text": "number" } } ] }, { "kind": "method", "name": "createInvertedHorizontalScale", "privacy": "private", "return": { "type": { "text": "ScaleQuantile" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "grid", "type": { "text": "GridDimensions" } }, { "name": "containerWidth", "type": { "text": "number" } } ] }, { "kind": "method", "name": "createVerticalScale", "privacy": "private", "return": { "type": { "text": "ScaleBand" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "grid", "type": { "text": "GridDimensions" } }, { "name": "containerHeight", "type": { "text": "number" } } ] }, { "kind": "method", "name": "createInvertedVerticalScale", "privacy": "private", "return": { "type": { "text": "ScaleQuantile" } }, "parameters": [ { "name": "originLocation", "type": { "text": "WaferMapOriginLocation" } }, { "name": "grid", "type": { "text": "GridDimensions" } }, { "name": "containerHeight", "type": { "text": "number" } } ] }, { "kind": "method", "name": "calculateMarginAddition", "privacy": "private", "return": { "type": { "text": "Margin" } }, "parameters": [ { "name": "baseMargin", "type": { "text": "Margin" } }, { "name": "addedMargin", "type": { "text": "Margin" } } ] } ] } ], "exports": [ { "kind": "js", "name": "Computations", "declaration": { "name": "Computations", "module": "src/wafer-map/modules/computations.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/create-matrix-renderer.ts", "declarations": [ { "kind": "function", "name": "createMatrixRenderer", "return": { "type": { "text": "Promise<{\n matrixRenderer: Remote,\n terminate: () => void\n}>" } }, "description": "Asynchronously creates and returns a Remote instance.\nThis function simplifies the process of creating and accessing MatrixRenderer instances." } ], "exports": [ { "kind": "js", "name": "createMatrixRenderer", "declaration": { "name": "createMatrixRenderer", "module": "src/wafer-map/modules/create-matrix-renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/data-manager.ts", "declarations": [ { "kind": "class", "description": "Data Manager uses Computations and Prerendering modules in order and exposes the results", "name": "DataManager", "members": [ { "kind": "field", "name": "containerDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "dieDimensions", "type": { "text": "Dimensions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "radius", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "margin", "type": { "text": "Margin" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "horizontalScale", "type": { "text": "ScaleBand" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "invertedHorizontalScale", "type": { "text": "ScaleQuantile" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "verticalScale", "type": { "text": "ScaleBand" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "invertedVerticalScale", "type": { "text": "ScaleQuantile" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "labelsFontSize", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "diesRenderInfo", "type": { "text": "DieRenderInfo[]" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "data", "type": { "text": "Map" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "computations", "type": { "text": "Computations" }, "privacy": "private", "readonly": true, "default": "new Computations(wafermap)" }, { "kind": "field", "name": "prerendering", "type": { "text": "Prerendering" }, "privacy": "private", "readonly": true, "default": "new Prerendering(wafermap)" }, { "kind": "field", "name": "dataMap", "type": { "text": "Map" }, "privacy": "private" }, { "kind": "method", "name": "updateContainerDimensions", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateScales", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateLabelsFontSize", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateDiesRenderInfo", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getWaferMapDie", "privacy": "public", "return": { "type": { "text": "WaferMapDie | undefined" } }, "parameters": [ { "name": "point", "type": { "text": "PointCoordinates" } } ] }, { "kind": "method", "name": "updateDataMap", "privacy": "private", "return": { "type": { "text": "void" } } } ] } ], "exports": [ { "kind": "js", "name": "DataManager", "declaration": { "name": "DataManager", "module": "src/wafer-map/modules/data-manager.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/hover-handler.ts", "declarations": [ { "kind": "class", "description": "HoverHandler deals with user interactions and events like hovering", "name": "HoverHandler", "members": [ { "kind": "field", "name": "onMouseMove", "privacy": "private", "readonly": true }, { "kind": "field", "name": "onMouseOut", "privacy": "private", "readonly": true }, { "kind": "method", "name": "calculateDieCoordinates", "privacy": "private", "return": { "type": { "text": "PointCoordinates | undefined" } }, "parameters": [ { "name": "mousePosition", "type": { "text": "PointCoordinates" } } ] }, { "kind": "method", "name": "hoversOverDie", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "mousePosition", "type": { "text": "PointCoordinates" } } ] } ] } ], "exports": [ { "kind": "js", "name": "HoverHandler", "declaration": { "name": "HoverHandler", "module": "src/wafer-map/modules/hover-handler.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/prerendering.ts", "declarations": [ { "kind": "class", "description": "Prerendering prepares render-ready dies data to be used by the rendering module", "name": "Prerendering", "members": [ { "kind": "field", "name": "labelsFontSize", "type": { "text": "number" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "diesRenderInfo", "type": { "text": "DieRenderInfo[]" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "d3ColorScale", "type": { "text": "| ScaleOrdinal\n | ScaleLinear" }, "privacy": "public" }, { "kind": "field", "name": "_labelsFontSize", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_diesRenderInfo", "type": { "text": "DieRenderInfo[]" }, "privacy": "private" }, { "kind": "field", "name": "fontSizeFactor", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0.8" }, { "kind": "field", "name": "nonHighlightedOpacity", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "0.3" }, { "kind": "field", "name": "emptyDieColor", "type": { "text": "string" }, "privacy": "private", "readonly": true, "default": "'rgba(218,223,236,1)'" }, { "kind": "field", "name": "nanDieColor", "type": { "text": "string" }, "privacy": "private", "readonly": true, "default": "'rgba(122,122,122,1)'" }, { "kind": "method", "name": "updateLabelsFontSize", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateDiesRenderInfo", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "computeDieRenderInfo", "privacy": "private", "return": { "type": { "text": "DieRenderInfo | null" } }, "parameters": [ { "name": "die", "type": { "text": "WaferMapDie" } } ] }, { "kind": "method", "name": "calculateLabelsFontSize", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "dieDimensions", "type": { "text": "Dimensions" } }, { "name": "maxCharacters", "type": { "text": "number" } } ] }, { "kind": "method", "name": "createD3ColorScale", "privacy": "private", "return": { "type": { "text": "ScaleOrdinal | ScaleLinear" } }, "parameters": [ { "name": "colorScale", "type": { "text": "WaferMapColorScale" } }, { "name": "colorScaleMode", "type": { "text": "WaferMapColorScaleMode" } } ] }, { "kind": "method", "name": "dieHasData", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "dieData", "type": { "text": "string" } } ] }, { "kind": "method", "name": "buildLabel", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "string" } }, { "name": "maxCharacters", "type": { "text": "number" } }, { "name": "dieLabelsHidden", "type": { "text": "boolean" } }, { "name": "dieLabelsSuffix", "type": { "text": "string" } } ] }, { "kind": "method", "name": "calculateOpacity", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "dieTags", "optional": true, "type": { "text": "string[]" } }, { "name": "highlightedTags", "optional": true, "type": { "text": "string[]" } } ] }, { "kind": "method", "name": "isColorScaleLinear", "privacy": "private", "return": { "type": { "text": "this is { d3ColorScale: ScaleLinear }" } }, "parameters": [ { "name": "colorScaleMode", "type": { "text": "WaferMapColorScaleMode" } } ] }, { "kind": "method", "name": "isColorScaleOrdinal", "privacy": "private", "return": { "type": { "text": "this is { d3ColorScale: ScaleOrdinal }" } }, "parameters": [ { "name": "colorScaleMode", "type": { "text": "WaferMapColorScaleMode" } } ] }, { "kind": "method", "name": "calculateFillStyle", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "string" } }, { "name": "colorScaleMode", "type": { "text": "WaferMapColorScaleMode" } }, { "name": "highlightedTags", "optional": true, "type": { "text": "string[]" } }, { "name": "dieTags", "optional": true, "type": { "text": "string[]" } } ] } ] } ], "exports": [ { "kind": "js", "name": "Prerendering", "declaration": { "name": "Prerendering", "module": "src/wafer-map/modules/prerendering.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/rendering.ts", "declarations": [ { "kind": "class", "description": "Responsible for drawing the dies inside the wafer map, adding dieText and scaling the canvas", "name": "RenderingModule", "members": [ { "kind": "field", "name": "dies", "type": { "text": "DieRenderInfo[]" }, "privacy": "private" }, { "kind": "field", "name": "minDieDim", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "50" }, { "kind": "method", "name": "updateSortedDiesAndDrawWafer", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "drawWafer", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderHover", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "calculateHoverTransform", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "renderDies", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderText", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clearCanvas", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "scaleCanvas", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isDieVisible", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "die", "type": { "text": "DieRenderInfo" } }, { "name": "minPoint", "type": { "text": "[number, number]" } }, { "name": "maxPoint", "type": { "text": "[number, number]" } } ] } ] } ], "exports": [ { "kind": "js", "name": "RenderingModule", "declaration": { "name": "RenderingModule", "module": "src/wafer-map/modules/rendering.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/wafer-map-update-tracker.ts", "declarations": [ { "kind": "class", "description": "Helper class to track what updates are needed to the wafer based on configuration\nchanges.", "name": "WaferMapUpdateTracker", "members": [ { "kind": "field", "name": "updateQueued", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "requiresEventsUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresWorkerWaferSetup", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresContainerDimensionsUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresComponentResizeUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresScalesUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresInputDataUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresLabelsFontSizeUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresDiesRenderInfoUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresColorAndTextUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresDrawnWaferUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "requiresRenderHoverUpdate", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "queueUpdate", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Queues an update using the DOM and until the update is run no other updates are queued.\nAfter the update is finished, all the tracked items are reset." } ], "superclass": { "name": "UpdateTracker", "module": "/src/utilities/models/update-tracker" } } ], "exports": [ { "kind": "js", "name": "WaferMapUpdateTracker", "declaration": { "name": "WaferMapUpdateTracker", "module": "src/wafer-map/modules/wafer-map-update-tracker.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/wafer-map-validator.ts", "declarations": [ { "kind": "class", "description": "Helper class for the nimble-wafer-map to validate that the wafer maps's grid dimensions\nconfiguration is valid and report which aspects of the configuration are valid or invalid.", "name": "WaferMapValidator", "members": [ { "kind": "field", "name": "invalidGridDimensions", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "invalidDiesTableSchema", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "getValidity", "privacy": "public", "return": { "type": { "text": "WaferMapValidity" } } }, { "kind": "method", "name": "isValid", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "validateGridDimensions", "privacy": "public", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "validateDiesTableSchema", "privacy": "public", "return": { "type": { "text": "boolean" } } } ] } ], "exports": [ { "kind": "js", "name": "WaferMapValidator", "declaration": { "name": "WaferMapValidator", "module": "src/wafer-map/modules/wafer-map-validator.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/modules/zoom-handler.ts", "declarations": [ { "kind": "class", "description": "ZoomHandler deals with user interactions and events like zooming", "name": "ZoomHandler", "members": [ { "kind": "field", "name": "scaleExtent", "type": { "text": "[number, number]" }, "privacy": "private", "readonly": true, "default": "[1, 100]" }, { "kind": "field", "name": "minExtentPoint", "type": { "text": "[number, number]" }, "privacy": "private", "readonly": true, "default": "[0, 0]" }, { "kind": "field", "name": "wafermapNotifier", "type": { "text": "Notifier" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "handleChange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "source", "type": { "text": "WaferMap" } }, { "name": "propertyName", "type": { "text": "string" } } ] }, { "kind": "method", "name": "createZoomBehavior", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "onWheelMove", "privacy": "private", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "ZoomHandler", "declaration": { "name": "ZoomHandler", "module": "src/wafer-map/modules/zoom-handler.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/workers/matrix-renderer.ts", "declarations": [ { "kind": "class", "description": "MatrixRenderer class is meant to be used within a Web Worker context,\nusing Comlink to facilitate communication between the main thread and the worker.\nThe MatrixRenderer class manages a matrix of dies, once an instance of MatrixRenderer is created,\nit is exposed to the main thread using Comlink's `expose` method.\nThis setup is used in the wafer-map component to perform heavy computational duties", "name": "MatrixRenderer", "members": [ { "kind": "field", "name": "values", "type": { "text": "Float64Array" } }, { "kind": "field", "name": "scaledColumnIndices", "type": { "text": "Float64Array" } }, { "kind": "field", "name": "scaledRowIndices", "type": { "text": "Float64Array" } }, { "kind": "field", "name": "columnIndicesPositions", "type": { "text": "Int32Array" } }, { "kind": "field", "name": "colorIndices", "type": { "text": "Int32Array" } }, { "kind": "field", "name": "canvas", "type": { "text": "OffscreenCanvas" } }, { "kind": "field", "name": "context", "type": { "text": "OffscreenCanvasRenderingContext2D" } }, { "kind": "field", "name": "colors", "privacy": "private" }, { "kind": "field", "name": "colorValues", "privacy": "private" }, { "kind": "field", "name": "outsideRangeDieColor", "privacy": "private", "readonly": true }, { "kind": "field", "name": "fontSizeFactor", "privacy": "private", "readonly": true }, { "kind": "field", "name": "renderConfig", "privacy": "private" }, { "kind": "field", "name": "transformConfig", "privacy": "private" }, { "kind": "method", "name": "setMatrixData", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "columnIndices", "type": { "text": "Int32Array" } }, { "name": "rowIndices", "type": { "text": "Int32Array" } }, { "name": "valuesBuffer", "type": { "text": "Float64Array" } } ] }, { "kind": "method", "name": "setRenderConfig", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "renderConfig", "type": { "text": "RenderConfig" } } ] }, { "kind": "method", "name": "setTransformConfig", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "transformData", "type": { "text": "TransformConfig" } } ] }, { "kind": "method", "name": "setCanvas", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "canvas", "type": { "text": "OffscreenCanvas" } } ] }, { "kind": "method", "name": "scaleCanvas", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setCanvasDimensions", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "data", "type": { "text": "Dimensions" } } ] }, { "kind": "method", "name": "getCanvasDimensions", "return": { "type": { "text": "Dimensions" } } }, { "kind": "method", "name": "clearCanvas", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "drawWafer", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "drawText", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "isDieInGrid", "privacy": "private" }, { "kind": "field", "name": "calculateHorizontalScaledIndices", "privacy": "private" }, { "kind": "field", "name": "calculateVerticalScaledIndices", "privacy": "private" }, { "kind": "field", "name": "findColorIndex", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "MatrixRenderer", "declaration": { "name": "MatrixRenderer", "module": "src/wafer-map/workers/matrix-renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/wafer-map/workers/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/wafer-map/workers/worker-code.ts", "declarations": [ { "kind": "variable", "name": "workerCode", "type": { "text": "string" }, "default": "\"var MatrixRenderer = (function (exports) {\\n 'use strict';\\n\\n /**\\n * @license\\n * Copyright 2019 Google LLC\\n * SPDX-License-Identifier: Apache-2.0\\n */\\n const proxyMarker = Symbol(\\\"Comlink.proxy\\\");\\n const createEndpoint = Symbol(\\\"Comlink.endpoint\\\");\\n const releaseProxy = Symbol(\\\"Comlink.releaseProxy\\\");\\n const finalizer = Symbol(\\\"Comlink.finalizer\\\");\\n const throwMarker = Symbol(\\\"Comlink.thrown\\\");\\n const isObject = (val) => (typeof val === \\\"object\\\" && val !== null) || typeof val === \\\"function\\\";\\n /**\\n * Internal transfer handle to handle objects marked to proxy.\\n */\\n const proxyTransferHandler = {\\n canHandle: (val) => isObject(val) && val[proxyMarker],\\n serialize(obj) {\\n const { port1, port2 } = new MessageChannel();\\n expose(obj, port1);\\n return [port2, [port2]];\\n },\\n deserialize(port) {\\n port.start();\\n return wrap(port);\\n },\\n };\\n /**\\n * Internal transfer handler to handle thrown exceptions.\\n */\\n const throwTransferHandler = {\\n canHandle: (value) => isObject(value) && throwMarker in value,\\n serialize({ value }) {\\n let serialized;\\n if (value instanceof Error) {\\n serialized = {\\n isError: true,\\n value: {\\n message: value.message,\\n name: value.name,\\n stack: value.stack,\\n },\\n };\\n }\\n else {\\n serialized = { isError: false, value };\\n }\\n return [serialized, []];\\n },\\n deserialize(serialized) {\\n if (serialized.isError) {\\n throw Object.assign(new Error(serialized.value.message), serialized.value);\\n }\\n throw serialized.value;\\n },\\n };\\n /**\\n * Allows customizing the serialization of certain values.\\n */\\n const transferHandlers = new Map([\\n [\\\"proxy\\\", proxyTransferHandler],\\n [\\\"throw\\\", throwTransferHandler],\\n ]);\\n function isAllowedOrigin(allowedOrigins, origin) {\\n for (const allowedOrigin of allowedOrigins) {\\n if (origin === allowedOrigin || allowedOrigin === \\\"*\\\") {\\n return true;\\n }\\n if (allowedOrigin instanceof RegExp && allowedOrigin.test(origin)) {\\n return true;\\n }\\n }\\n return false;\\n }\\n function expose(obj, ep = globalThis, allowedOrigins = [\\\"*\\\"]) {\\n ep.addEventListener(\\\"message\\\", function callback(ev) {\\n if (!ev || !ev.data) {\\n return;\\n }\\n if (!isAllowedOrigin(allowedOrigins, ev.origin)) {\\n console.warn(`Invalid origin '${ev.origin}' for comlink proxy`);\\n return;\\n }\\n const { id, type, path } = Object.assign({ path: [] }, ev.data);\\n const argumentList = (ev.data.argumentList || []).map(fromWireValue);\\n let returnValue;\\n try {\\n const parent = path.slice(0, -1).reduce((obj, prop) => obj[prop], obj);\\n const rawValue = path.reduce((obj, prop) => obj[prop], obj);\\n switch (type) {\\n case \\\"GET\\\" /* MessageType.GET */:\\n {\\n returnValue = rawValue;\\n }\\n break;\\n case \\\"SET\\\" /* MessageType.SET */:\\n {\\n parent[path.slice(-1)[0]] = fromWireValue(ev.data.value);\\n returnValue = true;\\n }\\n break;\\n case \\\"APPLY\\\" /* MessageType.APPLY */:\\n {\\n returnValue = rawValue.apply(parent, argumentList);\\n }\\n break;\\n case \\\"CONSTRUCT\\\" /* MessageType.CONSTRUCT */:\\n {\\n const value = new rawValue(...argumentList);\\n returnValue = proxy(value);\\n }\\n break;\\n case \\\"ENDPOINT\\\" /* MessageType.ENDPOINT */:\\n {\\n const { port1, port2 } = new MessageChannel();\\n expose(obj, port2);\\n returnValue = transfer(port1, [port1]);\\n }\\n break;\\n case \\\"RELEASE\\\" /* MessageType.RELEASE */:\\n {\\n returnValue = undefined;\\n }\\n break;\\n default:\\n return;\\n }\\n }\\n catch (value) {\\n returnValue = { value, [throwMarker]: 0 };\\n }\\n Promise.resolve(returnValue)\\n .catch((value) => {\\n return { value, [throwMarker]: 0 };\\n })\\n .then((returnValue) => {\\n const [wireValue, transferables] = toWireValue(returnValue);\\n ep.postMessage(Object.assign(Object.assign({}, wireValue), { id }), transferables);\\n if (type === \\\"RELEASE\\\" /* MessageType.RELEASE */) {\\n // detach and deactive after sending release response above.\\n ep.removeEventListener(\\\"message\\\", callback);\\n closeEndPoint(ep);\\n if (finalizer in obj && typeof obj[finalizer] === \\\"function\\\") {\\n obj[finalizer]();\\n }\\n }\\n })\\n .catch((error) => {\\n // Send Serialization Error To Caller\\n const [wireValue, transferables] = toWireValue({\\n value: new TypeError(\\\"Unserializable return value\\\"),\\n [throwMarker]: 0,\\n });\\n ep.postMessage(Object.assign(Object.assign({}, wireValue), { id }), transferables);\\n });\\n });\\n if (ep.start) {\\n ep.start();\\n }\\n }\\n function isMessagePort(endpoint) {\\n return endpoint.constructor.name === \\\"MessagePort\\\";\\n }\\n function closeEndPoint(endpoint) {\\n if (isMessagePort(endpoint))\\n endpoint.close();\\n }\\n function wrap(ep, target) {\\n const pendingListeners = new Map();\\n ep.addEventListener(\\\"message\\\", function handleMessage(ev) {\\n const { data } = ev;\\n if (!data || !data.id) {\\n return;\\n }\\n const resolver = pendingListeners.get(data.id);\\n if (!resolver) {\\n return;\\n }\\n try {\\n resolver(data);\\n }\\n finally {\\n pendingListeners.delete(data.id);\\n }\\n });\\n return createProxy(ep, pendingListeners, [], target);\\n }\\n function throwIfProxyReleased(isReleased) {\\n if (isReleased) {\\n throw new Error(\\\"Proxy has been released and is not useable\\\");\\n }\\n }\\n function releaseEndpoint(ep) {\\n return requestResponseMessage(ep, new Map(), {\\n type: \\\"RELEASE\\\" /* MessageType.RELEASE */,\\n }).then(() => {\\n closeEndPoint(ep);\\n });\\n }\\n const proxyCounter = new WeakMap();\\n const proxyFinalizers = \\\"FinalizationRegistry\\\" in globalThis &&\\n new FinalizationRegistry((ep) => {\\n const newCount = (proxyCounter.get(ep) || 0) - 1;\\n proxyCounter.set(ep, newCount);\\n if (newCount === 0) {\\n releaseEndpoint(ep);\\n }\\n });\\n function registerProxy(proxy, ep) {\\n const newCount = (proxyCounter.get(ep) || 0) + 1;\\n proxyCounter.set(ep, newCount);\\n if (proxyFinalizers) {\\n proxyFinalizers.register(proxy, ep, proxy);\\n }\\n }\\n function unregisterProxy(proxy) {\\n if (proxyFinalizers) {\\n proxyFinalizers.unregister(proxy);\\n }\\n }\\n function createProxy(ep, pendingListeners, path = [], target = function () { }) {\\n let isProxyReleased = false;\\n const proxy = new Proxy(target, {\\n get(_target, prop) {\\n throwIfProxyReleased(isProxyReleased);\\n if (prop === releaseProxy) {\\n return () => {\\n unregisterProxy(proxy);\\n releaseEndpoint(ep);\\n pendingListeners.clear();\\n isProxyReleased = true;\\n };\\n }\\n if (prop === \\\"then\\\") {\\n if (path.length === 0) {\\n return { then: () => proxy };\\n }\\n const r = requestResponseMessage(ep, pendingListeners, {\\n type: \\\"GET\\\" /* MessageType.GET */,\\n path: path.map((p) => p.toString()),\\n }).then(fromWireValue);\\n return r.then.bind(r);\\n }\\n return createProxy(ep, pendingListeners, [...path, prop]);\\n },\\n set(_target, prop, rawValue) {\\n throwIfProxyReleased(isProxyReleased);\\n // FIXME: ES6 Proxy Handler `set` methods are supposed to return a\\n // boolean. To show good will, we return true asynchronously ¯\\\\_(ツ)_/¯\\n const [value, transferables] = toWireValue(rawValue);\\n return requestResponseMessage(ep, pendingListeners, {\\n type: \\\"SET\\\" /* MessageType.SET */,\\n path: [...path, prop].map((p) => p.toString()),\\n value,\\n }, transferables).then(fromWireValue);\\n },\\n apply(_target, _thisArg, rawArgumentList) {\\n throwIfProxyReleased(isProxyReleased);\\n const last = path[path.length - 1];\\n if (last === createEndpoint) {\\n return requestResponseMessage(ep, pendingListeners, {\\n type: \\\"ENDPOINT\\\" /* MessageType.ENDPOINT */,\\n }).then(fromWireValue);\\n }\\n // We just pretend that `bind()` didn’t happen.\\n if (last === \\\"bind\\\") {\\n return createProxy(ep, pendingListeners, path.slice(0, -1));\\n }\\n const [argumentList, transferables] = processArguments(rawArgumentList);\\n return requestResponseMessage(ep, pendingListeners, {\\n type: \\\"APPLY\\\" /* MessageType.APPLY */,\\n path: path.map((p) => p.toString()),\\n argumentList,\\n }, transferables).then(fromWireValue);\\n },\\n construct(_target, rawArgumentList) {\\n throwIfProxyReleased(isProxyReleased);\\n const [argumentList, transferables] = processArguments(rawArgumentList);\\n return requestResponseMessage(ep, pendingListeners, {\\n type: \\\"CONSTRUCT\\\" /* MessageType.CONSTRUCT */,\\n path: path.map((p) => p.toString()),\\n argumentList,\\n }, transferables).then(fromWireValue);\\n },\\n });\\n registerProxy(proxy, ep);\\n return proxy;\\n }\\n function myFlat(arr) {\\n return Array.prototype.concat.apply([], arr);\\n }\\n function processArguments(argumentList) {\\n const processed = argumentList.map(toWireValue);\\n return [processed.map((v) => v[0]), myFlat(processed.map((v) => v[1]))];\\n }\\n const transferCache = new WeakMap();\\n function transfer(obj, transfers) {\\n transferCache.set(obj, transfers);\\n return obj;\\n }\\n function proxy(obj) {\\n return Object.assign(obj, { [proxyMarker]: true });\\n }\\n function toWireValue(value) {\\n for (const [name, handler] of transferHandlers) {\\n if (handler.canHandle(value)) {\\n const [serializedValue, transferables] = handler.serialize(value);\\n return [\\n {\\n type: \\\"HANDLER\\\" /* WireValueType.HANDLER */,\\n name,\\n value: serializedValue,\\n },\\n transferables,\\n ];\\n }\\n }\\n return [\\n {\\n type: \\\"RAW\\\" /* WireValueType.RAW */,\\n value,\\n },\\n transferCache.get(value) || [],\\n ];\\n }\\n function fromWireValue(value) {\\n switch (value.type) {\\n case \\\"HANDLER\\\" /* WireValueType.HANDLER */:\\n return transferHandlers.get(value.name).deserialize(value.value);\\n case \\\"RAW\\\" /* WireValueType.RAW */:\\n return value.value;\\n }\\n }\\n function requestResponseMessage(ep, pendingListeners, msg, transfers) {\\n return new Promise((resolve) => {\\n const id = generateUUID();\\n pendingListeners.set(id, resolve);\\n if (ep.start) {\\n ep.start();\\n }\\n ep.postMessage(Object.assign({ id }, msg), transfers);\\n });\\n }\\n function generateUUID() {\\n return new Array(4)\\n .fill(0)\\n .map(() => Math.floor(Math.random() * Number.MAX_SAFE_INTEGER).toString(16))\\n .join(\\\"-\\\");\\n }\\n\\n /**\\n * MatrixRenderer class is meant to be used within a Web Worker context,\\n * using Comlink to facilitate communication between the main thread and the worker.\\n * The MatrixRenderer class manages a matrix of dies, once an instance of MatrixRenderer is created,\\n * it is exposed to the main thread using Comlink's `expose` method.\\n * This setup is used in the wafer-map component to perform heavy computational duties\\n */\\n class MatrixRenderer {\\n constructor() {\\n this.values = Float64Array.from([]);\\n this.scaledColumnIndices = Float64Array.from([]);\\n this.scaledRowIndices = Float64Array.from([]);\\n this.columnIndicesPositions = Int32Array.from([]);\\n this.colorIndices = Int32Array.from([]);\\n this.colors = [];\\n this.colorValues = Float64Array.from([]);\\n this.outsideRangeDieColor = 'rgba(218,223,236,1)';\\n this.fontSizeFactor = 0.8;\\n this.renderConfig = {\\n dieDimensions: {\\n width: 0,\\n height: 0\\n },\\n margin: {\\n top: 0,\\n right: 0,\\n bottom: 0,\\n left: 0\\n },\\n verticalCoefficient: 1,\\n horizontalCoefficient: 1,\\n horizontalConstant: 0,\\n verticalConstant: 0,\\n gridMinX: 0,\\n gridMaxX: 0,\\n gridMinY: 0,\\n gridMaxY: 0,\\n labelsFontSize: 0,\\n colorScale: [],\\n dieLabelsSuffix: '',\\n maxCharacters: 0\\n };\\n this.transformConfig = {\\n transform: {\\n k: 1,\\n x: 0,\\n y: 0\\n },\\n topLeftCanvasCorner: {\\n x: 0,\\n y: 0\\n },\\n bottomRightCanvasCorner: {\\n x: 0,\\n y: 0\\n }\\n };\\n }\\n setMatrixData(columnIndices, rowIndices, valuesBuffer) {\\n const scaledColumnIndex = [];\\n const columnPositions = [];\\n const scaledRowIndices = [];\\n const values = [];\\n const colorIndices = [];\\n let prevXIndex;\\n let dieCount = 0;\\n for (let i = 0; i < columnIndices.length; i++) {\\n const xIndex = columnIndices[i];\\n const yIndex = rowIndices[i];\\n if (this.isDieInGrid(xIndex, yIndex)) {\\n if (xIndex !== prevXIndex) {\\n scaledColumnIndex.push(this.calculateHorizontalScaledIndices(xIndex));\\n columnPositions.push(dieCount);\\n prevXIndex = xIndex;\\n }\\n scaledRowIndices.push(this.calculateVerticalScaledIndices(yIndex));\\n const value = valuesBuffer[i];\\n values.push(value);\\n colorIndices.push(this.findColorIndex(value));\\n dieCount += 1;\\n }\\n }\\n this.scaledColumnIndices = Float64Array.from(scaledColumnIndex);\\n this.columnIndicesPositions = Int32Array.from(columnPositions);\\n this.scaledRowIndices = Float64Array.from(scaledRowIndices);\\n this.values = Float64Array.from(values);\\n this.colorIndices = Int32Array.from(colorIndices);\\n }\\n setRenderConfig(renderConfig) {\\n this.renderConfig = renderConfig;\\n this.colors = renderConfig.colorScale.map(marker => marker.color);\\n this.colorValues = Float64Array.from(renderConfig.colorScale.map(marker => marker.value));\\n }\\n setTransformConfig(transformData) {\\n this.transformConfig = transformData;\\n }\\n setCanvas(canvas) {\\n this.canvas = canvas;\\n this.context = canvas.getContext('2d');\\n }\\n scaleCanvas() {\\n this.context.translate(this.transformConfig.transform.x, this.transformConfig.transform.y);\\n this.context.scale(this.transformConfig.transform.k, this.transformConfig.transform.k);\\n }\\n setCanvasDimensions(data) {\\n this.canvas.width = data.width;\\n this.canvas.height = data.height;\\n }\\n getCanvasDimensions() {\\n return {\\n width: this.canvas.width,\\n height: this.canvas.height\\n };\\n }\\n clearCanvas() {\\n this.context.clearRect(0, 0, this.canvas.width, this.canvas.height);\\n }\\n drawWafer() {\\n this.context.restore();\\n this.context.save();\\n this.clearCanvas();\\n this.scaleCanvas();\\n for (let i = 0; i < this.scaledColumnIndices.length; i++) {\\n const scaledX = this.scaledColumnIndices[i];\\n if (!(scaledX >= this.transformConfig.topLeftCanvasCorner.x\\n && scaledX < this.transformConfig.bottomRightCanvasCorner.x)) {\\n continue;\\n }\\n // columnIndexPositions is used to get chunks to determine the start and end index of the column, it looks something like [0, 1, 4, 9, 12]\\n // This means that the first column has a start index of 0 and an end index of 1, the second column has a start index of 1 and an end index of 4, and so on\\n // scaledRowIndices is used when we reach the end of the columnIndexPositions, when columnIndexPositions is [0, 1, 4, 9, 12], scaledRowIndices is 13\\n const columnEndIndex = this.columnIndicesPositions[i + 1] !== undefined\\n ? this.columnIndicesPositions[i + 1]\\n : this.scaledRowIndices.length;\\n for (let columnStartIndex = this.columnIndicesPositions[i]; columnStartIndex < columnEndIndex; columnStartIndex++) {\\n const scaledY = this.scaledRowIndices[columnStartIndex];\\n if (!(scaledY >= this.transformConfig.topLeftCanvasCorner.y\\n && scaledY < this.transformConfig.bottomRightCanvasCorner.y)) {\\n continue;\\n }\\n // Fill style is temporary green for all dies, will be replaced with a color based on the value of the die in a future implementation\\n this.context.fillStyle = this.colors[this.colorIndices[columnStartIndex]]\\n ?? this.outsideRangeDieColor;\\n this.context.fillRect(scaledX, scaledY, this.renderConfig.dieDimensions.width, this.renderConfig.dieDimensions.height);\\n }\\n }\\n }\\n drawText() {\\n this.context.font = `${this.renderConfig.labelsFontSize.toString()}px sans-serif`;\\n this.context.fillStyle = '#ffffff';\\n this.context.textAlign = 'center';\\n this.context.lineCap = 'butt';\\n const approximateTextHeight = this.context.measureText('M');\\n for (let i = 0; i < this.scaledColumnIndices.length; i++) {\\n const scaledX = this.scaledColumnIndices[i];\\n if (!(scaledX >= this.transformConfig.topLeftCanvasCorner.x\\n && scaledX < this.transformConfig.bottomRightCanvasCorner.x)) {\\n continue;\\n }\\n // columnIndexPositions is used to get chunks to determine the start and end index of the column, it looks something like [0, 1, 4, 9, 12]\\n // This means that the first column has a start index of 0 and an end index of 1, the second column has a start index of 1 and an end index of 4, and so on\\n // scaledRowIndices is used when we reach the end of the columnIndexPositions, when columnIndexPositions is [0, 1, 4, 9, 12], scaledRowIndices is 13\\n const columnEndIndex = this.columnIndicesPositions[i + 1] !== undefined\\n ? this.columnIndicesPositions[i + 1]\\n : this.scaledRowIndices.length;\\n for (let columnStartIndex = this.columnIndicesPositions[i]; columnStartIndex < columnEndIndex; columnStartIndex++) {\\n const scaledY = this.scaledRowIndices[columnStartIndex];\\n if (!(scaledY >= this.transformConfig.topLeftCanvasCorner.y\\n && scaledY < this.transformConfig.bottomRightCanvasCorner.y)) {\\n continue;\\n }\\n let label = `${this.values[columnStartIndex] ?? 'NaN'}${this.renderConfig.dieLabelsSuffix}`;\\n if (label.length >= this.renderConfig.maxCharacters) {\\n label = `${label.substring(0, this.renderConfig.maxCharacters)}…`;\\n }\\n this.context.fillText(label, scaledX + this.renderConfig.dieDimensions.width / 2, scaledY\\n + this.renderConfig.dieDimensions.height / 2\\n + approximateTextHeight.width / 2, this.renderConfig.dieDimensions.width * this.fontSizeFactor);\\n }\\n }\\n }\\n isDieInGrid(x, y) {\\n return (x >= this.renderConfig.gridMinX\\n && x <= this.renderConfig.gridMaxX\\n && y >= this.renderConfig.gridMinY\\n && y <= this.renderConfig.gridMaxY);\\n }\\n calculateHorizontalScaledIndices(columnIndex) {\\n return (this.renderConfig.horizontalCoefficient * columnIndex\\n + this.renderConfig.horizontalConstant\\n + this.renderConfig.margin.left);\\n }\\n calculateVerticalScaledIndices(rowIndex) {\\n return (this.renderConfig.verticalCoefficient * rowIndex\\n + this.renderConfig.verticalConstant\\n + this.renderConfig.margin.top);\\n }\\n findColorIndex(value) {\\n let index = -1;\\n if (this.colorValues.length === 0 || this.colorValues[0] >= value) {\\n return index;\\n }\\n for (let i = 0; i < this.colorValues.length; i++) {\\n if (value <= this.colorValues[i]) {\\n index = i;\\n break;\\n }\\n }\\n return index;\\n }\\n }\\n expose(MatrixRenderer);\\n\\n exports.MatrixRenderer = MatrixRenderer;\\n\\n return exports;\\n\\n})({});\\n\"" } ], "exports": [ { "kind": "js", "name": "workerCode", "declaration": { "name": "workerCode", "module": "src/wafer-map/workers/worker-code.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text-mention/base/view/index.ts", "declarations": [ { "kind": "class", "description": "The base class for Mention View Node", "name": "RichTextMentionView", "members": [ { "kind": "field", "name": "mentionHref", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Stores the unique URL of the mentioned user matching the pattern" }, { "kind": "field", "name": "mentionLabel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Stores the value of the rendering label" } ], "attributes": [ { "name": "mention-href", "type": { "text": "string | undefined" }, "description": "Stores the unique URL of the mentioned user matching the pattern", "fieldName": "mentionHref" }, { "name": "mention-label", "type": { "text": "string | undefined" }, "description": "Stores the value of the rendering label", "fieldName": "mentionLabel" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "RichTextMentionView", "declaration": { "name": "RichTextMentionView", "module": "src/rich-text-mention/base/view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/rich-text-mention/users/view/index.ts", "declarations": [ { "kind": "class", "description": "A nimble styled rich text mention users view", "name": "RichTextMentionUsersView", "superclass": { "name": "RichTextMentionView", "module": "/src/rich-text-mention/base/view" }, "attributes": [ { "name": "mention-href", "type": { "text": "string | undefined" }, "description": "Stores the unique URL of the mentioned user matching the pattern", "fieldName": "mentionHref", "inheritedFrom": { "name": "RichTextMentionView", "module": "src/rich-text-mention/base/view/index.ts" } }, { "name": "mention-label", "type": { "text": "string | undefined" }, "description": "Stores the value of the rendering label", "fieldName": "mentionLabel", "inheritedFrom": { "name": "RichTextMentionView", "module": "src/rich-text-mention/base/view/index.ts" } } ], "members": [ { "kind": "field", "name": "mentionHref", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Stores the unique URL of the mentioned user matching the pattern", "inheritedFrom": { "name": "RichTextMentionView", "module": "src/rich-text-mention/base/view/index.ts" } }, { "kind": "field", "name": "mentionLabel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Stores the value of the rendering label", "inheritedFrom": { "name": "RichTextMentionView", "module": "src/rich-text-mention/base/view/index.ts" } } ] }, { "kind": "variable", "name": "richTextMentionUsersViewTag", "type": { "text": "string" }, "default": "'nimble-rich-text-mention-users-view'" } ], "exports": [ { "kind": "js", "name": "RichTextMentionUsersView", "declaration": { "name": "RichTextMentionUsersView", "module": "src/rich-text-mention/users/view/index.ts" } }, { "kind": "js", "name": "richTextMentionUsersViewTag", "declaration": { "name": "richTextMentionUsersViewTag", "module": "src/rich-text-mention/users/view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/components/cell/index.ts", "declarations": [ { "kind": "variable", "name": "tableCellTag", "type": { "text": "string" }, "default": "'nimble-table-cell'" } ], "exports": [ { "kind": "js", "name": "tableCellTag", "declaration": { "name": "tableCellTag", "module": "src/table/components/cell/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/components/group-row/index.ts", "declarations": [ { "kind": "variable", "name": "tableGroupRowTag", "type": { "text": "string" }, "default": "'nimble-table-group-row'" } ], "exports": [ { "kind": "js", "name": "tableGroupRowTag", "declaration": { "name": "tableGroupRowTag", "module": "src/table/components/group-row/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/components/header/index.ts", "declarations": [ { "kind": "variable", "name": "tableHeaderTag", "type": { "text": "string" }, "default": "'nimble-table-header'" } ], "exports": [ { "kind": "js", "name": "tableHeaderTag", "declaration": { "name": "tableHeaderTag", "module": "src/table/components/header/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table/components/row/index.ts", "declarations": [ { "kind": "variable", "name": "tableRowTag", "type": { "text": "string" }, "default": "'nimble-table-row'" } ], "exports": [ { "kind": "js", "name": "tableRowTag", "declaration": { "name": "tableRowTag", "module": "src/table/components/row/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/anchor/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "A cell view for displaying links", "name": "TableColumnAnchorCellView", "members": [ { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableCellView", "module": "/src/table-column/base/cell-view" } }, { "kind": "variable", "name": "tableColumnAnchorCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-anchor-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnAnchorCellView", "declaration": { "name": "TableColumnAnchorCellView", "module": "src/table-column/anchor/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnAnchorCellViewTag", "declaration": { "name": "tableColumnAnchorCellViewTag", "module": "src/table-column/anchor/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/base/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "Base class for table cell views, which are used within the nimble-table-cell.\nEach TableColumn type has a corresponding TableCellView type (linked via TableColumn.cellViewTag).", "name": "TableCellView", "members": [ { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public" }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public" }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]" }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "TableCellView", "declaration": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/base/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The base class for group header views, which are displayed in a TableGroupRow.\nA TableColumn that uses the GroupableColumn mixin must provide a TableGroupHeaderView\ntype (linked via TableColumn.groupHeaderViewTag).", "name": "TableGroupHeaderView", "members": [ { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public" }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public" } ], "superclass": { "name": "FoundationElement", "package": "@ni/fast-foundation" } } ], "exports": [ { "kind": "js", "name": "TableGroupHeaderView", "declaration": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/date-text/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "A cell view for displaying date/time fields as text", "name": "TableColumnDateTextCellView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Text to render in the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "TableColumnAlignment" }, "privacy": "public", "description": "The alignment of the text within the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether or not the text being displayed in the cell view is a placeholder.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `cellValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableColumnTextCellViewBase", "module": "/src/table-column/text-base/cell-view" } }, { "kind": "variable", "name": "tableColumnDateTextCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-date-text-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnDateTextCellView", "declaration": { "name": "TableColumnDateTextCellView", "module": "src/table-column/date-text/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnDateTextCellViewTag", "declaration": { "name": "tableColumnDateTextCellViewTag", "module": "src/table-column/date-text/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/date-text/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view for displaying date/time fields as text.", "name": "TableColumnDateTextGroupHeaderView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "text", "privacy": "public", "description": "Text to render in the cell.\n\nThe value is initialized to `tableGroupRowPlaceholderNoValue` because if the group\nrow never has a value defined on it, the change handlers may never get called but\nthe text needs to be correct.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "noValuePlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderNoValueLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "emptyPlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderEmptyLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `groupHeaderValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableColumnTextGroupHeaderViewBase", "module": "/src/table-column/text-base/group-header-view" } }, { "kind": "variable", "name": "tableColumnDateTextGroupHeaderViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-date-text-group-header-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnDateTextGroupHeaderView", "declaration": { "name": "TableColumnDateTextGroupHeaderView", "module": "src/table-column/date-text/group-header-view/index.ts" } }, { "kind": "js", "name": "tableColumnDateTextGroupHeaderViewTag", "declaration": { "name": "tableColumnDateTextGroupHeaderViewTag", "module": "src/table-column/date-text/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/duration-text/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "A cell view for displaying duration fields as text", "name": "TableColumnDurationTextCellView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Text to render in the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "TableColumnAlignment" }, "privacy": "public", "description": "The alignment of the text within the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether or not the text being displayed in the cell view is a placeholder.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `cellValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableColumnTextCellViewBase", "module": "/src/table-column/text-base/cell-view" } }, { "kind": "variable", "name": "tableColumnDurationTextCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-duration-text-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnDurationTextCellView", "declaration": { "name": "TableColumnDurationTextCellView", "module": "src/table-column/duration-text/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnDurationTextCellViewTag", "declaration": { "name": "tableColumnDurationTextCellViewTag", "module": "src/table-column/duration-text/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/duration-text/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view for displaying duration fields as text.", "name": "TableColumnDurationTextGroupHeaderView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "text", "privacy": "public", "description": "Text to render in the cell.\n\nThe value is initialized to `tableGroupRowPlaceholderNoValue` because if the group\nrow never has a value defined on it, the change handlers may never get called but\nthe text needs to be correct.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "noValuePlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderNoValueLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "emptyPlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderEmptyLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `groupHeaderValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableColumnTextGroupHeaderViewBase", "module": "/src/table-column/text-base/group-header-view" } }, { "kind": "variable", "name": "tableColumnDurationTextGroupHeaderViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-duration-text-group-header-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnDurationTextGroupHeaderView", "declaration": { "name": "TableColumnDurationTextGroupHeaderView", "module": "src/table-column/duration-text/group-header-view/index.ts" } }, { "kind": "js", "name": "tableColumnDurationTextGroupHeaderViewTag", "declaration": { "name": "tableColumnDurationTextGroupHeaderViewTag", "module": "src/table-column/duration-text/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mapping/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "The cell view for the mapping column", "name": "TableColumnMappingCellView", "members": [ { "kind": "field", "name": "severity", "type": { "text": "IconSeverity" }, "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "privacy": "public" }, { "kind": "field", "name": "visualizationTemplate", "type": { "text": "| ViewTemplate\n | ViewTemplate | undefined" }, "privacy": "public" }, { "kind": "field", "name": "textHidden", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "resetState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableCellView", "module": "/src/table-column/base/cell-view" } }, { "kind": "variable", "name": "tableColumnMappingCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-mapping-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnMappingCellView", "declaration": { "name": "TableColumnMappingCellView", "module": "src/table-column/mapping/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnMappingCellViewTag", "declaration": { "name": "tableColumnMappingCellViewTag", "module": "src/table-column/mapping/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/mapping/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view for the mapping column", "name": "TableColumnMappingGroupHeaderView", "members": [ { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''" }, { "kind": "field", "name": "severity", "type": { "text": "IconSeverity" }, "privacy": "public" }, { "kind": "field", "name": "visualizationTemplate", "type": { "text": "| ViewTemplate\n | ViewTemplate | undefined" }, "privacy": "public" }, { "kind": "field", "name": "textHidden", "type": { "text": "boolean" }, "privacy": "public", "readonly": true, "default": "false" }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "resetState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableGroupHeaderView", "module": "/src/table-column/base/group-header-view" } }, { "kind": "variable", "name": "tableColumnMappingGroupHeaderViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-mapping-group-header-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnMappingGroupHeaderView", "declaration": { "name": "TableColumnMappingGroupHeaderView", "module": "src/table-column/mapping/group-header-view/index.ts" } }, { "kind": "js", "name": "tableColumnMappingGroupHeaderViewTag", "declaration": { "name": "tableColumnMappingGroupHeaderViewTag", "module": "src/table-column/mapping/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/menu-button/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "The cell view base class for displaying a string field as a menu button.", "name": "TableColumnMenuButtonCellView", "members": [ { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableCellView", "module": "/src/table-column/base/cell-view" } }, { "kind": "variable", "name": "tableColumnMenuButtonCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-menu-button-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnMenuButtonCellView", "declaration": { "name": "TableColumnMenuButtonCellView", "module": "src/table-column/menu-button/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnMenuButtonCellViewTag", "declaration": { "name": "tableColumnMenuButtonCellViewTag", "module": "src/table-column/menu-button/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/number-text/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "A cell view for displaying number fields as text", "name": "TableColumnNumberTextCellView", "members": [ { "kind": "method", "name": "columnConfigChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Text to render in the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "TableColumnAlignment" }, "privacy": "public", "description": "The alignment of the text within the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether or not the text being displayed in the cell view is a placeholder.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `cellValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableColumnTextCellViewBase", "module": "/src/table-column/text-base/cell-view" } }, { "kind": "variable", "name": "tableColumnNumberTextCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-number-text-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnNumberTextCellView", "declaration": { "name": "TableColumnNumberTextCellView", "module": "src/table-column/number-text/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnNumberTextCellViewTag", "declaration": { "name": "tableColumnNumberTextCellViewTag", "module": "src/table-column/number-text/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/number-text/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view for displaying number fields as text.", "name": "TableColumnNumberTextGroupHeaderView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "text", "privacy": "public", "description": "Text to render in the cell.\n\nThe value is initialized to `tableGroupRowPlaceholderNoValue` because if the group\nrow never has a value defined on it, the change handlers may never get called but\nthe text needs to be correct.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "noValuePlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderNoValueLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "emptyPlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderEmptyLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `groupHeaderValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableColumnTextGroupHeaderViewBase", "module": "/src/table-column/text-base/group-header-view" } }, { "kind": "variable", "name": "tableColumnNumberTextGroupHeaderTag", "type": { "text": "string" }, "default": "'nimble-table-column-number-text-group-header-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnNumberTextGroupHeaderView", "declaration": { "name": "TableColumnNumberTextGroupHeaderView", "module": "src/table-column/number-text/group-header-view/index.ts" } }, { "kind": "js", "name": "tableColumnNumberTextGroupHeaderTag", "declaration": { "name": "tableColumnNumberTextGroupHeaderTag", "module": "src/table-column/number-text/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "A cell view for displaying string fields as text", "name": "TableColumnTextCellView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Text to render in the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "TableColumnAlignment" }, "privacy": "public", "description": "The alignment of the text within the cell.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether or not the text being displayed in the cell view is a placeholder.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `cellValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableColumnTextCellViewBase", "module": "/src/table-column/text-base/cell-view" } }, { "kind": "variable", "name": "tableColumnTextCellViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-text-cell-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnTextCellView", "declaration": { "name": "TableColumnTextCellView", "module": "src/table-column/text/cell-view/index.ts" } }, { "kind": "js", "name": "tableColumnTextCellViewTag", "declaration": { "name": "tableColumnTextCellViewTag", "module": "src/table-column/text/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view for displaying string fields as text.", "name": "TableColumnTextGroupHeaderView", "members": [ { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "text", "privacy": "public", "description": "Text to render in the cell.\n\nThe value is initialized to `tableGroupRowPlaceholderNoValue` because if the group\nrow never has a value defined on it, the change handlers may never get called but\nthe text needs to be correct.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "noValuePlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderNoValueLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "emptyPlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderEmptyLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `groupHeaderValue` warrants it.", "inheritedFrom": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableColumnTextGroupHeaderViewBase", "module": "/src/table-column/text-base/group-header-view" } }, { "kind": "variable", "name": "tableColumnTextGroupHeaderViewTag", "type": { "text": "string" }, "default": "'nimble-table-column-text-group-header-view'" } ], "exports": [ { "kind": "js", "name": "TableColumnTextGroupHeaderView", "declaration": { "name": "TableColumnTextGroupHeaderView", "module": "src/table-column/text/group-header-view/index.ts" } }, { "kind": "js", "name": "tableColumnTextGroupHeaderViewTag", "declaration": { "name": "tableColumnTextGroupHeaderViewTag", "module": "src/table-column/text/group-header-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text-base/cell-view/index.ts", "declarations": [ { "kind": "class", "description": "The cell view base class for displaying fields of any type as text.", "name": "TableColumnTextCellViewBase", "members": [ { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Text to render in the cell." }, { "kind": "field", "name": "alignment", "type": { "text": "TableColumnAlignment" }, "privacy": "public", "description": "The alignment of the text within the cell." }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether or not the text being displayed in the cell view is a placeholder." }, { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "cellRecordChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `cellValue` warrants it." }, { "kind": "field", "name": "cellRecord", "type": { "text": "TCellRecord | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "column", "type": { "text": "TableColumn | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "recordId", "type": { "text": "string | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "tabbableChildren", "type": { "text": "HTMLElement[]" }, "privacy": "public", "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.", "readonly": true, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEvents", "type": { "text": "readonly string[]" }, "privacy": "private", "default": "[]", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "method", "name": "columnChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } }, { "kind": "field", "name": "delegatedEventHandler", "type": { "text": "(event: Event) => void" }, "privacy": "private", "inheritedFrom": { "name": "TableCellView", "module": "src/table-column/base/cell-view/index.ts" } } ], "superclass": { "name": "TableCellView", "module": "/src/table-column/base/cell-view" } } ], "exports": [ { "kind": "js", "name": "TableColumnTextCellViewBase", "declaration": { "name": "TableColumnTextCellViewBase", "module": "src/table-column/text-base/cell-view/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/table-column/text-base/group-header-view/index.ts", "declarations": [ { "kind": "class", "description": "The group header view base class for displaying fields of any type as text.", "name": "TableColumnTextGroupHeaderViewBase", "members": [ { "kind": "field", "name": "text", "privacy": "public", "description": "Text to render in the cell.\n\nThe value is initialized to `tableGroupRowPlaceholderNoValue` because if the group\nrow never has a value defined on it, the change handlers may never get called but\nthe text needs to be correct." }, { "kind": "field", "name": "noValuePlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderNoValueLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }" }, { "kind": "field", "name": "emptyPlaceholderLabelSubscriber", "type": { "text": "DesignTokenSubscriber<\n typeof tableGroupRowPlaceholderEmptyLabel\n >" }, "privacy": "private", "readonly": true, "default": "{ handleChange: () => { this.applyPlaceholderTextIfNeeded(); } }" }, { "kind": "method", "name": "updateText", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "columnConfigChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "groupHeaderValueChanged", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "applyPlaceholderTextIfNeeded", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Sets `this.text` to the appropriate placeholder if `groupHeaderValue` warrants it." }, { "kind": "field", "name": "groupHeaderValue", "type": { "text": "TGroupValue | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } }, { "kind": "field", "name": "columnConfig", "type": { "text": "TColumnConfig | undefined" }, "privacy": "public", "inheritedFrom": { "name": "TableGroupHeaderView", "module": "src/table-column/base/group-header-view/index.ts" } } ], "superclass": { "name": "TableGroupHeaderView", "module": "/src/table-column/base/group-header-view" } } ], "exports": [ { "kind": "js", "name": "TableColumnTextGroupHeaderViewBase", "declaration": { "name": "TableColumnTextGroupHeaderViewBase", "module": "src/table-column/text-base/group-header-view/index.ts" } } ] } ] }