diff --git a/typedoc/en/globalFunctions.json b/typedoc/en/globalFunctions.json index 8b8b5057..46a22bf2 100644 --- a/typedoc/en/globalFunctions.json +++ b/typedoc/en/globalFunctions.json @@ -15,6 +15,7 @@ }, "monthRange": { "comment": { + "returns": "\n", "tags": { "export": { "comment": { @@ -27,6 +28,7 @@ }, "isLeap": { "comment": { + "returns": "\n", "tags": { "export": { "comment": { diff --git a/typedoc/en/lib/badge/IgxBadgeComponent.json b/typedoc/en/lib/badge/IgxBadgeComponent.json deleted file mode 100644 index e418cd86..00000000 --- a/typedoc/en/lib/badge/IgxBadgeComponent.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "IgxBadgeComponent": { - "comment": { - "text": [ - "The Ignite UI Badge is used to decorate avatars, navigation menus, or other components in the", - "application when visual notification is needed. They are usually designed as icons with a predefined", - "style to communicate information, success, warnings, or errors.", - "Example:", - "```html", - "", - " ", - " ", - "", - "```", - "The `badge-style` class is used to position the badge:", - "```css", - ".badge-style {", - " position: absolute;", - " bottom: -6px;", - " right:-50px;", - "}", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Badge** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/badge.html)" - ] - }, - "properties": { - "id": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `id` attribute.", - "```html", - "", - "```" - ] - } - }, - "type": { - "comment": { - "shortText": [ - "An @Input property controlling the type of the badge.", - "Allowed values are `primary`, `info`, `success`, `warning`, `error`.", - "Providing an invalid value won't display a badge.", - "```html", - "", - "```" - ] - } - }, - "value": { - "comment": { - "shortText": [ - "An @Input property that sets the value to be displayed inside the badge.", - "If an `icon` property is already set the `icon` will be displayed.", - "If neither a `value` nor an `icon` is set the contentent of the badge will be empty.", - "```html", - "", - "```" - ] - } - }, - "icon": { - "comment": { - "shortText": [ - "Set an icon for the badge from the material icons set.", - "Has priority over the `value` property.", - "If neither a `value` nor an `icon` is set the content of the badge will be empty.", - "Providing an invalid value won't display anything.", - "```html", - "", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "This allows you to set value to role attribute.", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.label = \"badge-status\";", - "```" - ] - } - }, - "cssClass": { - "comment": { - "shortText": [ - "This allows you to disable igx-badge class. The default it's applied.", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.cssClass = false;", - "```" - ] - } - }, - "label": { - "comment": { - "shortText": [ - "This allows you to set value to aria-label attribute.", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.label = \"icon-badge\";", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/card/IgxCardComponent.json b/typedoc/en/lib/card/IgxCardComponent.json deleted file mode 100644 index d9925af8..00000000 --- a/typedoc/en/lib/card/IgxCardComponent.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "IgxCardComponent": { - "properties": { - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCardComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `id` of the card.", - "If not set, `id` will have value `\"igx-card-0\"`;", - "```html", - "", - "```", - "```typescript", - "let cardId = this.card.id;", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `role` attribute of the card.", - "By default the value is set to `group`.", - "```html", - "", - "```" - ] - } - }, - "type": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `type` attribute of the card.", - "By default the value is set to `default`. You can make the card use the", - "outlined style by setting the value to `outlined`.", - "```html", - "", - "```" - ] - } - }, - "horizontal": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `horizontal` attribute of the card.", - "Setting this to `true` will make the different card sections align horizontally,", - "essentially flipping the card to the side.", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "isOutlinedCard": { - "getter": { - "comment": { - "shortText": "A getter which will return true if the card type is `outlined`." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/card/IgxCardHeaderComponent.json b/typedoc/en/lib/card/IgxCardHeaderComponent.json deleted file mode 100644 index a25ced1a..00000000 --- a/typedoc/en/lib/card/IgxCardHeaderComponent.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "IgxCardHeaderComponent": { - "comment": { - "shortText": "IgxCardHeader is container for the card header" - }, - "properties": { - "vertical": { - "comment": { - "shortText": [ - "An @Input property that sets the layout style of the header.", - "By default the header elements(thumbnail and title/subtitle) are aligned horizontally.", - "```html", - "", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `role` attribute of the card header.", - "By default the value is set to `header`.", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/card/IgxCardType.json b/typedoc/en/lib/card/IgxCardType.json deleted file mode 100644 index b6eaaa6e..00000000 --- a/typedoc/en/lib/card/IgxCardType.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "IgxCardType": { - "comment": { - "text": [ - "The Ignite UI Card serves as a container that allows custom content to be organized in an appealing way. There are", - "five sections in a card that you can use to organize your content. These are header, media, content, actions, and footer.", - "Example:", - "```html", - "", - " ", - "

{{title}}

", - "
{{subtitle}}
", - " ", - " ", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Card** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/card.html)" - ] - }, - "members": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/checkbox/IgxCheckboxComponent.json b/typedoc/en/lib/checkbox/IgxCheckboxComponent.json deleted file mode 100644 index 21415f79..00000000 --- a/typedoc/en/lib/checkbox/IgxCheckboxComponent.json +++ /dev/null @@ -1,479 +0,0 @@ -{ - "IgxCheckboxComponent": { - "comment": { - "text": [ - "The Ignite UI Checkbox is a selection control that allows users to make a binary choice. It behaves similarly", - "to the native browser checkbox.", - "Example:", - "```html", - "", - " simple checkbox", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Checkbox** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/checkbox.html)" - ] - }, - "properties": { - "nativeCheckbox": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the native checkbox element.", - "```typescript", - "let checkboxElement = this.checkbox.checkboxElement;", - "```" - ] - } - }, - "nativeLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the native label element.", - "```typescript", - "let labelElement = this.checkbox.nativeLabel;", - "```" - ] - } - }, - "placeholderLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the label placeholder element.", - "```typescript", - "let labelPlaceholder = this.checkbox.placeholderLabel;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `id` of the checkbox component.", - "If not set, the `id` of the first checkbox component will be `\"igx-checkbox-0\"`.", - "```html", - "", - "```", - "```typescript", - "let checkboxId = this.checkbox.id;", - "```" - ] - } - }, - "labelId": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the id of the `label` element.", - "If not set, the id of the `label` in the first checkbox component will be `\"igx-checkbox-0-label\"`.", - "```html", - "", - "```", - "```typescript", - "let labelId = this.checkbox.labelId;", - "```" - ] - } - }, - "value": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `value` attribute.", - "```html", - "", - "```", - "```typescript", - "let value = this.checkbox.value;", - "```" - ] - } - }, - "name": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `name` attribute.", - "```html", - "", - "```", - "```typescript", - "let name = this.checkbox.name;", - "```" - ] - } - }, - "tabindex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the value of the `tabindex` attribute.", - "```html", - "", - "```", - "```typescript", - "let tabIndex = this.checkbox.tabindex;", - "```" - ] - } - }, - "labelPosition": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Sets/gets the position of the `label`.", - " If not set, the `labelPosition` will have value `\"after\"`.", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.checkbox.labelPosition;", - "```" - ] - } - }, - "disableRipple": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the ripple effect.", - "If not set, `disableRipple` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRippleDisabled = this.checkbox.desableRipple;", - "```" - ] - } - }, - "required": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox is required.", - "If not set, `required` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.checkbox.required;", - "```" - ] - } - }, - "ariaLabelledBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `aria-labelledby` attribute.", - "If not set, the `aria-labelledby` will be equal to the value of `labelId` attribute.", - "```html", - "", - "```", - "```typescript", - "let ariaLabelledBy = this.checkbox.ariaLabelledBy;", - "```" - ] - } - }, - "ariaLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the value of the `aria-label` attribute.", - "```html", - "", - "```", - "```typescript", - "let ariaLabel = this.checkbox.aruaLabel;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An event that is emitted after the checkbox state is changed.", - "Provides references to the `IgxCheckboxComponent` and the `checked` property as event arguments." - ] - } - }, - "cssClass": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the class of the checkbox component.", - "```typescript", - "let class = this.checkbox.cssClass;", - "```" - ] - } - }, - "focused": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox component is on focus.", - "Default value is `false`.", - "```typescript", - "this.checkbox.focused = true;", - "```", - "```typescript", - "let isFocused = this.checkbox.focused;", - "```" - ] - } - }, - "indeterminate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the checkbox indeterminate visual state.", - "Default value is `false`;", - "```html", - "", - "```", - "```typescript", - "let isIndeterminate = this.checkbox.indeterminate;", - "```" - ] - } - }, - "checked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox is checked.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let isChecked = this.checkbox.checked;", - "```" - ] - } - }, - "disabled": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox is disabled.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let isDisabled = this.checkbox.disabled;", - "```" - ] - } - }, - "readonly": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox is readonly.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let readonly = this.checkbox.readonly;", - "```" - ] - } - }, - "disableTransitions": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the checkbox should disable all css transitions.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let disableTransitions = this.checkbox.disableTransitions;", - "```" - ] - } - } - }, - "methods": { - "toggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If `disabled` is `false`, switches the `checked` state.", - "```typescript", - "this.checkbox.toggle();", - "```" - ] - } - } - }, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/chips/IgxChipComponent.json b/typedoc/en/lib/chips/IgxChipComponent.json deleted file mode 100644 index 7fb183a7..00000000 --- a/typedoc/en/lib/chips/IgxChipComponent.json +++ /dev/null @@ -1,347 +0,0 @@ -{ - "IgxChipComponent": { - "properties": { - "id": { - "comment": { - "shortText": [ - "An @Input property that sets the value of `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - }, - "data": { - "comment": { - "shortText": [ - "An @Input property that stores data related to the chip.", - "```html", - "", - "```" - ] - } - }, - "draggable": { - "comment": { - "shortText": [ - "An @Input property that defines if the `IgxChipComponent` can be dragged in order to change it's position.", - "By default it is set to false.", - "```html", - "", - "```" - ] - } - }, - "animateOnRelease": { - "comment": { - "shortText": [ - "An @Input property that enables/disables the draggable element animation when the element is released.", - "By default it's set to true.", - "```html", - "", - "```" - ] - } - }, - "hideBaseOnDrag": { - "comment": { - "shortText": [ - "An @Input property that enables/disables the hiding of the base element that has been dragged.", - "By default it's set to true.", - "```html", - "", - "```" - ] - } - }, - "removable": { - "comment": { - "shortText": [ - "An @Input property that defines if the `IgxChipComponent` should render remove button and throw remove events.", - "By default it is set to false.", - "```html", - "", - "```" - ] - } - }, - "removeIcon": { - "comment": { - "shortText": [ - "An @Input property that overrides the default icon that the chip applies to the remove button.", - "```html", - "", - "delete", - "```" - ] - } - }, - "selectable": { - "comment": { - "shortText": [ - "An @Input property that defines if the `IgxChipComponent` can be selected on click or through navigation,", - "By default it is set to false.", - "```html", - "", - "```" - ] - } - }, - "selectIcon": { - "comment": { - "shortText": [ - "An @Input property that overrides the default icon that the chip applies when it is selected.", - "```html", - "", - "done_outline", - "```" - ] - } - }, - "disabled": { - "comment": { - "shortText": [ - "An @Input property that defines if the `IgxChipComponent` is disabled. When disabled it restricts user interactions", - "like focusing on click or tab, selection on click or Space, dragging.", - "By default it is set to false.", - "```html", - "", - "```" - ] - } - }, - "onMoveStart": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` moving starts.", - "Returns the moving `IgxChipComponent`.", - "```typescript", - "moveStarted(event: IBaseChipEventArgs){", - " let movingChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onMoveEnd": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` moving ends.", - "Returns the moved `IgxChipComponent`.", - "```typescript", - "moveEnded(event: IBaseChipEventArgs){", - " let movedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRemove": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` is removed.", - "Returns the removed `IgxChipComponent`.", - "```typescript", - "remove(event: IBaseChipEventArgs){", - " let removedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onClick": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` is clicked.", - "Returns the clicked `IgxChipComponent`, whether the event should be canceled.", - "```typescript", - "chipClick(event: IChipClickEventArgs){", - " let clickedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onSelection": { - "comment": { - "shortText": [ - "Emits event when the `IgxChipComponent` is selected/deselected.", - "Returns the selected chip reference, whether the event should be canceled, what is the next selection state and", - "when the event is triggered by interaction `originalEvent` is provided, otherwise `originalEvent` is `null`.", - "```typescript", - "chipSelect(event: IChipSelectEventArgs){", - " let selectedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onSelectionDone": { - "comment": { - "shortText": [ - "Emits event when the `IgxChipComponent` is selected/deselected and any related animations and transitions also end.", - "```typescript", - "chipSelectEnd(event: IBaseChipEventArgs){", - " let selectedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onKeyDown": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` keyboard navigation is being used.", - "Returns the focused/selected `IgxChipComponent`, whether the event should be canceled,", - "if the `alt`, `shift` or `control` key is pressed and the pressed key name.", - "```typescript", - "chipKeyDown(event: IChipKeyDownEventArgs){", - " let keyDown = event.key;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDragEnter": { - "comment": { - "shortText": [ - "Emits an event when the `IgxChipComponent` has entered the `IgxChipsAreaComponent`.", - "Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as", - "the original drop event arguments.", - "```typescript", - "chipEnter(event: IChipEnterDragAreaEventArgs){", - " let targetChip = event.targetChip;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "dragDirective": { - "comment": { - "shortText": [ - "Property that contains a reference to the `IgxDragDirective` the `IgxChipComponent` uses for dragging behavior.", - "```html", - "", - "```", - "```typescript", - "onMoveStart(event: IBaseChipEventArgs){", - " let dragDirective = event.owner.dragDirective;", - "}", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "selected": { - "setter": { - "comment": { - "text": [ - "Two-way data binding:", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the `IgxChipComponent` selected state.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "text": [ - "Two-way data binding:", - "```html", - "", - "```" - ], - "shortText": [ - "Returns if the `IgxChipComponent` is selected.", - "```typescript", - "@ViewChild('myChip')", - "public chip: IgxChipComponent;", - "selectedChip(){", - " let selectedChip = this.chip.selected;", - "}", - "```" - ] - } - } - }, - "color": { - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the `IgxChipComponent` background color.", - "The `color` property supports string, rgb, hex.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": [ - "Returns the background color of the `IgxChipComponent`.", - "```typescript", - "@ViewChild('myChip')", - "public chip: IgxChipComponent;", - "ngAfterViewInit(){", - " let chipColor = this.chip.color;", - "}", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/chips/IgxChipsAreaComponent.json b/typedoc/en/lib/chips/IgxChipsAreaComponent.json deleted file mode 100644 index d9aedd02..00000000 --- a/typedoc/en/lib/chips/IgxChipsAreaComponent.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "IgxChipsAreaComponent": { - "properties": { - "width": { - "comment": { - "shortText": [ - "An @Input property that sets the width of the `IgxChipsAreaComponent`.", - "```html", - "", - "```" - ] - } - }, - "height": { - "comment": { - "shortText": [ - "An @Input property that sets the height of the `IgxChipsAreaComponent`.", - "```html", - "", - "```" - ] - } - }, - "onReorder": { - "comment": { - "shortText": [ - "Emits an event when `IgxChipComponent`s in the `IgxChipsAreaComponent` should be reordered.", - "Returns an array of `IgxChipComponent`s.", - "```html", - "", - "```", - "```typescript", - "public changedOrder(event: IChipsAreaReorderEventArgs){", - " let chips: IgxChipComponent[] = event.chipsArray;", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "shortText": [ - "Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is selected/deselected.", - "Fired after the chips area is initialized if there are initially selected chips as well.", - "Returns an array of selected `IgxChipComponent`s and the `IgxChipAreaComponent`.", - "```html", - "", - "```", - "```typescript", - "public selection(event: IChipsAreaSelectEventArgs){", - " let selectedChips: IgxChipComponent[] = event.newSelection;", - "}" - ] - } - }, - "onMoveStart": { - "comment": { - "shortText": [ - "Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved.", - "```html", - "", - "```", - "```typescript", - "moveStart(event: IBaseChipsAreaEventArgs){", - " let chipArea = event.owner;", - "}", - "```" - ] - } - }, - "onMoveEnd": { - "comment": { - "shortText": [ - "Emits an event after an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved.", - "```html", - "", - "```", - "```typescript", - "moveEnd(event: IBaseChipsAreaEventArgs){", - " let chipArea = event.owner;", - "}", - "```" - ] - } - }, - "chipsList": { - "comment": { - "shortText": [ - "Holds the `IgxChipComponent` in the `IgxChipsAreaComponent`.", - "```typescript", - "ngAfterViewInit(){", - " let chips = this.chipsArea.chipsList;", - "}", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/date-picker/IgxDatePickerComponent.json b/typedoc/en/lib/date-picker/IgxDatePickerComponent.json deleted file mode 100644 index 61c3571b..00000000 --- a/typedoc/en/lib/date-picker/IgxDatePickerComponent.json +++ /dev/null @@ -1,721 +0,0 @@ -{ - "IgxDatePickerComponent": { - "comment": { - "text": [ - "The Ignite UI Date Picker displays a popup calendar that lets users select a single date.", - "Example:", - "```html", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Date Picker** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/date_picker.html)" - ] - }, - "properties": { - "label": { - "comment": { - "shortText": [ - "An @Input property that sets the `IgxDatePickerComponent` label.", - "The default label is 'Date'.", - "```html", - "", - "```" - ] - } - }, - "labelVisibility": { - "comment": { - "shortText": [ - "An @Input property that sets the `IgxDatePickerComponent` label visibility.", - "By default the visibility is set to true.", - "" - ] - } - }, - "locale": { - "comment": { - "shortText": [ - "An @Input property that sets locales. Default locale is en.", - "```html", - "", - "```" - ] - } - }, - "weekStart": { - "comment": { - "shortText": [ - "An @Input property that sets on which day the week starts.", - "```html", - "", - "```" - ] - } - }, - "hideOutsideDays": { - "comment": { - "shortText": [ - "Sets/gets whether the inactive dates (dates that are out of the current month) will be hidden.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let hideOutsideDays = this.datePicker.hideOutsideDays;", - "```" - ] - } - }, - "monthsViewNumber": { - "comment": { - "shortText": [ - "Sets/gets the number of month views displayed.", - "Default value is `1`.", - "```html", - "", - "```", - "```typescript", - "let monthViewsDisplayed = this.datePicker.monthsViewNumber;", - "```" - ] - } - }, - "mask": { - "comment": { - "shortText": [ - "Returns the date mask of the `IgxDatePickerComponent` when in editable dropdown mode.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let mask = this.datePicker.mask;", - "}", - "```" - ] - } - }, - "id": { - "comment": { - "shortText": [ - "An @Input property that sets the value of `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - }, - "formatter": { - "comment": { - "shortText": [ - "An @Input property that applies a custom formatter function on the selected or passed date.", - "```typescript", - "public date: Date = new Date();", - "private dayFormatter = new Intl.DateTimeFormat(\"en\", { weekday: \"long\" });", - "private monthFormatter = new Intl.DateTimeFormat(\"en\", { month: \"long\" });", - "public formatter = (date: Date) => { return `You selected", - " ${this.dayFormatter.format(date)},", - " ${date.getDate()} ${this.monthFormatter.format(date)},", - " ${date.getFullYear()}`;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "disabled": { - "comment": { - "shortText": [ - "An @Input property that disables the `IgxDatePickerComponent`.", - "```html", - "", - "```" - ] - } - }, - "vertical": { - "comment": { - "shortText": [ - "An @Input property that sets the orientation of the `IgxDatePickerComponent` header.", - "```html", - "", - "```" - ] - } - }, - "todayButtonLabel": { - "comment": { - "shortText": [ - "An @Input property that renders today button with custom label.", - "```html", - "", - "```" - ] - } - }, - "cancelButtonLabel": { - "comment": { - "shortText": [ - "An @Input property that renders cancel button with custom label.", - "```html", - "", - "```" - ] - } - }, - "mode": { - "comment": { - "shortText": [ - "An @Input property that sets whether `IgxDatePickerComponent` is in dialog or drop down mode.", - "```html", - "", - "```" - ] - } - }, - "isSpinLoop": { - "comment": { - "shortText": [ - "An @Input property that sets whether the `IgxDatePickerComponent` date parts would spin continuously or stop when min/max is reached.", - "```html", - "", - "```" - ] - } - }, - "outlet": { - "comment": { - "text": [ - "```html", - "
", - "//..", - "", - "//..", - "```", - "Where `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`." - ], - "shortText": "Determines the container the popup element should be attached to." - } - }, - "onOpened": { - "comment": { - "shortText": "An event that is emitted when the `IgxDatePickerComponent` calendar is opened." - } - }, - "onClosed": { - "comment": { - "shortText": "An event that is emitted after the `IgxDatePickerComponent` is closed." - } - }, - "onClosing": { - "comment": { - "shortText": "An event that is emitted when the `IgxDatePickerComponent` is being closed." - } - }, - "onSelection": { - "comment": { - "shortText": [ - "An @Output property that is fired when selection is made in the calendar.", - "```typescript", - "public selection(event){", - " alert(\"A date has been selected!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "valueChange": { - "comment": { - "shortText": [ - "An @Output property that is fired when date picker value is changed.", - "```typescript", - "public valueChanged(event){", - " alert(\"Date picker value is changed\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDisabledDate": { - "comment": { - "shortText": [ - "An @Output property that fires when the user types/spins to a disabled date in the date-picker editor.", - "```typescript", - "public onDisabledDate(event){", - " alert(\"This date is disabled!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onValidationFailed": { - "comment": { - "shortText": [ - "An @Output property that fires when the user types/spins invalid date in the date-picker editor.", - "```typescript", - "public onValidationFailed(event){", - " alert(\"This date is not valid!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - } - }, - "methods": { - "writeValue": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "The date you want to select." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Method that sets the selected date.", - "```typescript", - "public date = new Date();", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.writeValue(this.date);", - "}", - "```" - ] - } - }, - "triggerTodaySelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects today's date from calendar and change the input field value, @calendar.viewDate and @calendar.value.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.triggerTodaySelection();", - "}", - "```" - ] - } - }, - "selectDate": { - "comment": { - "parameters": { - "date": { - "comment": { - "text": "passed date that has to be set to the calendar." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Change the calendar selection and calling this method will emit the @calendar.onSelection event,", - "which will fire @handleSelection method.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.selectDate(this.date);", - "}", - "```" - ] - } - }, - "deselectDate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects the calendar date.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.deselectDate();", - "}", - "```" - ] - } - }, - "openDialog": { - "comment": { - "parameters": { - "target": { - "comment": { - "text": [ - "HTMLElement - the target element to use for positioning the drop down container according to", - "```html", - "", - " ", - " ", - " ", - " ", - " alarm", - " ", - " ", - " ", - "", - "```" - ] - } - } - }, - "tags": {}, - "shortText": "Opens the date picker drop down or dialog." - } - } - }, - "accessors": { - "formatOptions": { - "getter": { - "comment": { - "shortText": [ - "Returns the format options of the `IgxDatePickerComponent`.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let formatOptions = this.datePicker.formatOptions;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the format options of the `IgxDatePickerComponent`.", - "```typescript", - "public Options;", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.Options = {", - " day: \"numeric\",", - " month: \"long\",", - " weekday: \"long\",", - " year: \"numeric\"", - " }", - "this.datePicker.formatOptions = this.Options;", - "}", - "```" - ] - } - } - }, - "format": { - "getter": { - "comment": { - "shortText": [ - "Returns the date display format of the `IgxDatePickerComponent` in dropdown mode.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let format = this.datePicker.format;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the date format of the `IgxDatePickerComponent` when in editable dropdown mode.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "this.datePicker.format = 'yyyy-M-d';", - "}", - "```" - ] - } - } - }, - "formatViews": { - "getter": { - "comment": { - "shortText": [ - "Returns the format views of the `IgxDatePickerComponent`.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let formatViews = this.datePicker.formatViews;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the format views of the `IgxDatePickerComponent`.", - "```typescript", - "public Views;", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.Views = {day:false, month: false, year:false};", - " this.datePicker.formatViews = this.Views;", - "}", - "```" - ] - } - } - }, - "disabledDates": { - "getter": { - "comment": { - "shortText": [ - "Gets the disabled dates descriptors.", - "```typescript", - "let disabledDates = this.datepicker.disabledDates;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the disabled dates' descriptors.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.disabledDates = [", - " {type: DateRangeType.Between, dateRange: [new Date(\"2020-1-1\"), new Date(\"2020-1-15\")]},", - " {type: DateRangeType.Weekends}];", - "}", - "```" - ] - } - } - }, - "specialDates": { - "getter": { - "comment": { - "shortText": [ - "Gets the special dates descriptors.", - "```typescript", - "let specialDates = this.datepicker.specialDates;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the special dates' descriptors.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.specialDates = [", - " {type: DateRangeType.Between, dateRange: [new Date(\"2020-1-1\"), new Date(\"2020-1-15\")]},", - " {type: DateRangeType.Weekends}];", - "}", - "```" - ] - } - } - }, - "displayData": { - "getter": { - "comment": { - "shortText": [ - "Returns the formatted date when `IgxDatePickerComponent` is in dialog mode.", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "public selection(event){", - " let selectedDate = this.datePicker.displayData;", - " alert(selectedDate);", - "}", - "```", - "```html", - "", - "```" - ] - } - } - }, - "transformedDate": { - "getter": { - "comment": { - "shortText": "hidden" - } - }, - "setter": { - "comment": { - "shortText": "hidden" - } - } - }, - "template": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxDatePickerComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the input group template.", - "```typescript", - "let template = this.template();", - "```" - ] - } - } - }, - "context": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxDatePickerComponent", - "tagName": "memberof" - } - } - }, - "shortText": "Gets the context passed to the input group template." - } - } - }, - "value": { - "getter": { - "comment": { - "shortText": [ - "An @Input property that gets/sets the selected date.", - "```typescript", - "public date: Date = new Date();", - "```", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that gets/sets the selected date.", - "```typescript", - "public date: Date = new Date();", - "```", - "```html", - "", - "```" - ] - } - } - }, - "onOpen": { - "getter": { - "comment": { - "tags": { - "deprecated": { - "comment": { - "text": [ - "Use 'onOpened' instead.", - "An event that is emitted when the `IgxDatePickerComponent` calendar is opened.", - "```typescript", - "public open(event){", - " alert(\"The date-picker calendar has been opened!\");", - "}", - "```", - "```html", - "", - "```" - ], - "tagName": "deprecated" - } - } - } - } - }, - "setter": { - "comment": {} - } - }, - "onClose": { - "getter": { - "comment": { - "tags": { - "deprecated": { - "comment": { - "text": [ - "Use 'onClosed' instead.", - "\"An event that is emitted when the `IgxDatePickerComponent` is closed.", - "```typescript", - "public close(event){", - " alert(\"The date-picker has been closed!\");", - "}", - "```", - "```html", - "", - "```" - ], - "tagName": "deprecated" - } - } - } - } - }, - "setter": { - "comment": {} - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxButtonDirective.json b/typedoc/en/lib/directives/IgxButtonDirective.json deleted file mode 100644 index 044db0e7..00000000 --- a/typedoc/en/lib/directives/IgxButtonDirective.json +++ /dev/null @@ -1,180 +0,0 @@ -{ - "IgxButtonDirective": { - "properties": { - "buttonClick": { - "comment": { - "shortText": "Called when the button is clicked" - } - }, - "role": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `role` attribute.", - "```typescript", - "this.button.role = 'navbutton';", - "```", - "```typescript", - "let buttonRole = this.button.role;", - "```" - ] - } - }, - "selected": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets or sets whether the button is selected.", - "Mainly used in the IgxButtonGroup component and it will have no effect if set separately.", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "nativeElement": { - "getter": { - "comment": { - "shortText": "Returns the underlying DOM element" - } - } - }, - "type": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the type of the button.", - "```html", - "", - "```" - ] - } - } - }, - "color": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the button text color.", - "```html", - "", - "```" - ] - } - } - }, - "background": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the background color of the button.", - "```html", - "", - "```" - ] - } - } - }, - "label": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the `aria-label` attribute.", - "```html", - "", - "```" - ] - } - } - }, - "disabled": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/disables the button.", - " ```html", - "", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxInputDirective.json b/typedoc/en/lib/directives/IgxInputDirective.json deleted file mode 100644 index 5e53e142..00000000 --- a/typedoc/en/lib/directives/IgxInputDirective.json +++ /dev/null @@ -1,334 +0,0 @@ -{ - "IgxInputDirective": { - "properties": { - "isInput": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the `\"igx-input-group__input\"` class is added to the host element.", - "Default value is `false`.", - "```typescript", - "this.igxInput.isInput = true;", - "```", - "```typescript", - "let isCLassAdded = this.igxInput.isInput;", - "```" - ] - } - }, - "isTextArea": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the `\"class.igx-input-group__textarea\"` class is added to the host element.", - "Default value is `false`.", - "```typescript", - "this.igxInput.isTextArea = true;", - "```", - "```typescript", - "let isCLassAdded = this.igxInput.isTextArea;", - "```" - ] - } - } - }, - "methods": { - "focus": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a focus on the igxInput.", - "```typescript", - "this.igxInput.focus();", - "```" - ] - } - } - }, - "accessors": { - "value": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the `value` property.", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the `value` propery.", - "```typescript", - "@ViewChild('igxInput', {read: IgxInputDirective})", - " public igxInput: IgxInputDirective;", - "let inputValue = this.igxInput.value;", - "```" - ] - } - } - }, - "disabled": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the `disabled` property.", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the `disabled` property", - "```typescript", - "@ViewChild('igxInput', {read: IgxInputDirective})", - " public igxInput: IgxInputDirective;", - "let isDisabled = this.igxInput.disabled;", - "```" - ] - } - } - }, - "required": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the `required` property.", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets whether the igxInput is required.", - "```typescript", - "let isRequired = this.igxInput.required;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the `nativeElement` of the igxInput.", - "```typescript", - "let igxInputNativeElement = this.igxInput.nativeElement;", - "```" - ] - } - } - }, - "hasPlaceholder": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets whether the igxInput has a placeholder.", - "```typescript", - "let hasPlaceholder = this.igxInput.hasPlaceholder;", - "```" - ] - } - } - }, - "placeholder": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the placeholder element of the igxInput.", - "```typescript", - "let igxInputPlaceholder = this.igxInput.placeholder;", - "```" - ] - } - } - }, - "focused": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets whether the igxInput is focused.", - "```typescript", - "let isFocused = this.igxInput.focused;", - "```" - ] - } - } - }, - "valid": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the state of the igxInput.", - "```typescript", - "let igxInputState = this.igxInput.valid;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the state of the igxInput.", - "```typescript", - "this.igxInput.valid = IgxInputState.INVALID;", - "```" - ] - } - } - }, - "isValid": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets whether the igxInput is valid.", - "```typescript", - "let valid = this.igxInput.isValid;", - "```" - ] - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxRadioGroupDirective.json b/typedoc/en/lib/directives/IgxRadioGroupDirective.json deleted file mode 100644 index 00d68a2d..00000000 --- a/typedoc/en/lib/directives/IgxRadioGroupDirective.json +++ /dev/null @@ -1,282 +0,0 @@ -{ - "IgxRadioGroupDirective": { - "comment": { - "text": [ - "The Ignite UI Radio Group allows the user to select a single option from an available set of options that are listed side by side.", - "Example:", - "```html", - "", - " ", - " {{item}}", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Radio Group** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/radio_button.html)" - ] - }, - "properties": { - "radioButtons": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the child radio buttons.", - "```typescript", - "let radioButtons = this.radioGroup.radioButtons;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An event that is emitted after the radio group `value` is changed.", - "Provides references to the selected `IgxRadioComponent` and the `value` property as event arguments." - ] - } - } - }, - "methods": { - "writeValue": { - "comment": { - "shortText": [ - "Checks whether the provided value is consistent to the current radio button.", - "If it is, the checked attribute will have value `true` and selected property will contain the selected `IgxRadioComponent`.", - "```typescript", - "this.radioGroup.writeValue('radioButtonValue');", - "```" - ] - } - } - }, - "accessors": { - "value": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `value` attribute.", - "```html", - "", - "```", - "```typescript", - "let value = this.radioGroup.value;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets/gets the `value` attribute.", - "```html", - "", - "```", - "```typescript", - "let value = this.radioGroup.value;", - "```" - ] - } - } - }, - "name": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `name` attribute of the radio group component. All child radio buttons inherits this name.", - "```html", - "", - " ```", - "```typescript", - "let name = this.radioGroup.name;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets/gets the `name` attribute of the radio group component. All child radio buttons inherits this name.", - "```html", - "", - " ```", - "```typescript", - "let name = this.radioGroup.name;", - "```" - ] - } - } - }, - "required": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the radio group is required.", - "If not set, `required` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.radioGroup.required;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets/gets whether the radio group is required.", - "If not set, `required` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.radioGroup.required;", - "```" - ] - } - } - }, - "disabled": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that allows you to disable the radio group. By default it's false.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that allows you to disable the radio group. By default it's false.", - "```html", - "", - "```" - ] - } - } - }, - "labelPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the position of the `label` in the child radio buttons.", - "If not set, `labelPosition` will have value `\"after\"`.", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.radioGroup.labelPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets/gets the position of the `label` in the child radio buttons.", - "If not set, `labelPosition` will have value `\"after\"`.", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.radioGroup.labelPosition;", - "```" - ] - } - } - }, - "selected": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the selected child radio button.", - "```typescript", - "let selectedButton = this.radioGroup.selected;", - "this.radioGroup.selected = selectedButton;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets/gets the selected child radio button.", - "```typescript", - "let selectedButton = this.radioGroup.selected;", - "this.radioGroup.selected = selectedButton;", - "```" - ] - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxGridBaseDirective.json b/typedoc/en/lib/grids/IgxGridBaseDirective.json deleted file mode 100644 index 9a78b987..00000000 --- a/typedoc/en/lib/grids/IgxGridBaseDirective.json +++ /dev/null @@ -1,4223 +0,0 @@ -{ - "IgxGridBaseDirective": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size.", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", - "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", - "If `headers` is enabled, it will use the column header (if any) instead of the column field." - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "Get transactions service for the grid." - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxGridComponent.json b/typedoc/en/lib/grids/IgxGridComponent.json deleted file mode 100644 index cfad9d11..00000000 --- a/typedoc/en/lib/grids/IgxGridComponent.json +++ /dev/null @@ -1,4904 +0,0 @@ -{ - "IgxGridComponent": { - "comment": { - "text": [ - "The Ignite UI Grid is used for presenting and manipulating tabular data in the simplest way possible. Once data", - "has been bound, it can be manipulated through filtering, sorting & editing operations.", - "Example:", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Grid** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" - ] - }, - "properties": { - "groupsExpanded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that determines whether created groups are rendered expanded or collapsed.", - "The default rendered state is expanded.", - "```html", - "", - "```" - ] - } - }, - "groupsRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A hierarchical representation of the group by records.", - "```typescript", - "let groupRecords = this.grid.groupsRecords;", - "```" - ] - } - }, - "dropAreaTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the template that will be rendered as a GroupBy drop area.", - "Note: The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", - "```html", - "", - " ", - "", - "", - " Custom drop area! ", - "", - "```", - "```ts", - "@ViewChild('myDropArea', { read: TemplateRef })", - "public dropAreaRef: TemplateRef;", - "```" - ] - } - }, - "onGroupingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new `IgxColumnComponent` gets grouped/ungrouped, or multiple columns get", - "grouped/ungrouped at once by using the Group By API.", - "The `onGroupingDone` event would be raised only once if several columns get grouped at once by calling", - "the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.", - "The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain", - "the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation.", - "Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last**", - "grouping/ungrouping operation), not all columns which are currently grouped/ungrouped.", - "columns.", - "```typescript", - "groupingDone(event: IGroupingDoneEventArgs){", - " const expressions = event.expressions;", - " //the newly grouped columns", - " const groupedColumns = event.groupedColumns;", - " //the newly ungrouped columns", - " const ungroupedColumns = event.ungroupedColumns;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "groupBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one.", - "Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.", - "The onGroupingDone event would get raised only **once** if this method gets called multiple times with the same arguments.", - "```typescript", - "this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "this.grid.groupBy([", - "{ fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },", - "{ fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },", - "{ fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }", - "]);", - "```" - ] - } - }, - "clearGrouping": { - "comment": { - "shortText": [ - "Clears all grouping in the grid, if no parameter is passed.", - "If a parameter is provided, clears grouping for a particular column or an array of columns.", - "```typescript", - "this.grid.clearGrouping(); //clears all grouping", - "this.grid.clearGrouping(\"ID\"); //ungroups a single column", - "this.grid.clearGrouping([\"ID\", \"Column1\", \"Column2\"]); //ungroups multiple columns", - "```" - ] - } - }, - "isExpandedGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if a group is expanded or not.", - "```typescript", - "public groupRow: IGroupByRecord;", - "const expandedGroup = this.grid.isExpandedGroup(this.groupRow);", - "```" - ] - } - }, - "toggleGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the expansion state of a group.", - "```typescript", - "public groupRow: IGroupByRecord;", - "const toggleExpGroup = this.grid.toggleGroup(this.groupRow);", - "```" - ] - } - }, - "fullyExpandGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the specified group and all of its parent groups.", - "```typescript", - "public groupRow: IGroupByRecord;", - "this.grid.fullyExpandGroup(this.groupRow);", - "```" - ] - } - }, - "toggleAllGroupRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the expansion state of all group rows recursively.", - "```typescript", - "this.grid.toggleAllGroupRows;", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "tags": { - "inheritdoc": { - "comment": { - "tagName": "inheritdoc" - } - } - } - } - }, - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size.", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that lets you fill the `IgxGridComponent` with an array of data.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that lets you fill the `IgxGridComponent` with an array of data.", - "```html", - "", - "```" - ] - } - } - }, - "filteredData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of objects containing the filtered data in the `IgxGridComponent`.", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets an array of objects containing the filtered data in the `IgxGridComponent`.", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - } - }, - "totalItemCount": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the total number of records in the data source.", - "This property is required for remote grid virtualization to function when it is bound to remote data.", - "```typescript", - "this.grid1.totalItemCount = 55;", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records in the data source.", - "Works only with remote grid virtualization.", - "```typescript", - "const itemCount = this.grid1.totalItemCount;", - "```" - ] - } - } - }, - "groupingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the group by state of the `IgxGridComponent`.", - "```typescript", - "let groupByState = this.grid.groupingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the group by state of the `IgxGridComponent` and emits the `onGroupingDone`", - "event with the appropriate arguments.", - "```typescript", - "this.grid.groupingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Asc,", - " ignoreCase: false", - "}];", - "```" - ] - } - } - }, - "groupingExpansionState": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns a list of expansion states for group rows.", - "Includes only states that differ from the default one (controlled through groupsExpanded and states that the user has changed.", - "Contains the expansion state (expanded: boolean) and the unique identifier for the group row (Array).", - "```typescript", - "const groupExpState = this.grid.groupingExpansionState;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets a list of expansion states for group rows.", - "```typescript", - " this.grid.groupingExpansionState = [{", - " expanded: false,", - " hierarchy: [{ fieldName: 'ID', value: 1 }]", - " }];", - "// You can use DataUtil.getHierarchy(groupRow) to get the group `IgxGridRowComponent` hierarchy.", - "```" - ] - } - } - }, - "hideGroupedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grouped columns should be hidden as well.", - "The default value is \"false\"", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets whether the grouped columns should be hidden as well.", - "The default value is \"false\"", - "```html", - "", - "```" - ] - } - } - }, - "dropAreaMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed inside the GroupBy drop area where columns can be dragged on.", - "Note: The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed inside the GroupBy drop area where columns can be dragged on." - } - } - }, - "groupsRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all group rows.", - "```typescript", - "const groupList = this.grid.groupsRowList;", - "```" - ] - } - } - }, - "groupRowTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template reference of the `IgxGridComponent`'s group row.", - "```", - "const groupRowTemplate = this.grid.groupRowTemplate;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the template reference of the `IgxGridComponent`'s group `IgxGridRowComponent`.", - "```typescript", - "this.grid.groupRowTemplate = myRowTemplate.", - "```" - ] - } - } - }, - "groupAreaTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template reference of the `IgxGridComponent`'s group area.", - "```typescript", - "const groupAreaTemplate = this.grid.groupAreaTemplate;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the template reference of the `IgxGridComponent`'s group area.", - "```typescript", - "this.grid.groupAreaTemplate = myAreaTemplate.", - "```" - ] - } - } - }, - "hasGroupableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has groupable columns.", - "```typescript", - "const groupableGrid = this.grid.hasGroupableColumns;", - "```" - ] - } - } - }, - "dropAreaVisible": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the grid's group by drop area is visible.", - "```typescript", - "const dropVisible = this.grid.dropAreaVisible;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "Get transactions service for the grid." - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxHierarchicalGridBaseDirective.json b/typedoc/en/lib/grids/IgxHierarchicalGridBaseDirective.json deleted file mode 100644 index de8814c6..00000000 --- a/typedoc/en/lib/grids/IgxHierarchicalGridBaseDirective.json +++ /dev/null @@ -1,4223 +0,0 @@ -{ - "IgxHierarchicalGridBaseDirective": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size.", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", - "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", - "If `headers` is enabled, it will use the column header (if any) instead of the column field." - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "Get transactions service for the grid." - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxHierarchicalGridComponent.json b/typedoc/en/lib/grids/IgxHierarchicalGridComponent.json deleted file mode 100644 index af1b2d72..00000000 --- a/typedoc/en/lib/grids/IgxHierarchicalGridComponent.json +++ /dev/null @@ -1,4383 +0,0 @@ -{ - "IgxHierarchicalGridComponent": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size.", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", - "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", - "If `headers` is enabled, it will use the column header (if any) instead of the column field." - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the value of the `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that lets you fill the `IgxHierarchicalGridComponent` with an array of data.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of data set to the `IgxHierarchicalGridComponent`.", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - } - }, - "filteredData": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - } - }, - "expandChildren": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.", - "Defult value is false.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets if all immediate children of the `IgxHierarchicalGridComponent` previously have been set to be expanded/collapsed.", - "If previously set and some rows have been manually expanded/collapsed it will still return the last set value.", - "```typescript", - "const expanded = this.grid.expandChildren;", - "```" - ] - } - } - }, - "foreignKey": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the", - "parent grid is set or an object reference of the parent record otherwise.", - "```typescript", - "const foreignKey = this.grid.foreignKey;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "Get transactions service for the grid." - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxRowIslandComponent.json b/typedoc/en/lib/grids/IgxRowIslandComponent.json deleted file mode 100644 index db1e1b57..00000000 --- a/typedoc/en/lib/grids/IgxRowIslandComponent.json +++ /dev/null @@ -1,4291 +0,0 @@ -{ - "IgxRowIslandComponent": { - "properties": { - "key": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the key of the row island by which child data would be taken from the row data if such is provided.", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "onGridCreated": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Event emmited when a grid is being created based on this row island.", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", - "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", - "If `headers` is enabled, it will use the column header (if any) instead of the column field." - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "expandChildren": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets if all immediate children of the grids for this `IgxRowIslandComponent` have been set to be expanded/collapsed.", - "```typescript", - "const expanded = this.rowIsland.expandChildren;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "Get transactions service for the grid." - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxTreeGridComponent.json b/typedoc/en/lib/grids/IgxTreeGridComponent.json deleted file mode 100644 index 4c51f7ee..00000000 --- a/typedoc/en/lib/grids/IgxTreeGridComponent.json +++ /dev/null @@ -1,4611 +0,0 @@ -{ - "IgxTreeGridComponent": { - "comment": { - "text": [ - "The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and", - "provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding.", - "Example:", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Tree Grid** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" - ] - }, - "properties": { - "rootRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the root level `ITreeGridRecord`s.", - "```typescript", - "// gets the root record with index=2", - "const states = this.grid.rootRecords[2];", - "```" - ] - } - }, - "records": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a map of all `ITreeGridRecord`s.", - "```typescript", - "// gets the record with primaryKey=2", - "const states = this.grid.records.get(2);", - "```" - ] - } - }, - "processedRootRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s.", - "```typescript", - "// gets the processed root record with index=2", - "const states = this.grid.processedRootRecords[2];", - "```" - ] - } - }, - "processedRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a map of all processed (filtered and sorted) `ITreeGridRecord`s.", - "```typescript", - "// gets the processed record with primaryKey=2", - "const states = this.grid.processedRecords.get(2);", - "```" - ] - } - }, - "childDataKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the child data key of the `IgxTreeGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "foreignKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the foreign key of the `IgxTreeGridComponent`.", - "```html", - "", - "", - "```" - ] - } - }, - "hasChildrenKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the key indicating whether a row has children.", - "This property is only used for load on demand scenarios.", - "```html", - "", - "", - "```" - ] - } - }, - "cascadeOnDelete": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property indicating whether child records should be deleted when their parent gets deleted.", - "By default it is set to true and deletes all children along with the parent.", - "```html", - "", - "", - "```" - ] - } - }, - "loadChildrenOnDemand": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that provides a callback for loading child rows on demand.", - "```html", - "", - "", - "```", - "```typescript", - "public loadChildren = (parentID: any, done: (children: any[]) => void) => {", - " this.dataService.getData(parentID, children => done(children));", - "}", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that autogenerates the `IgxGridComponent` columns.", - "The default value is false.", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is empty.", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets a custom template when the `IgxGridComponent` is loading.", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after filtering is performed.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted after advanced filtering is performed.", - "Returns the advanced filtering expressions tree.", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "You can provide a custom `ng-template` for the pagination UI of the grid.", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all even `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that adds styling classes applied to all odd `IgxGridRowComponent`s in the grid.", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the primary key of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "A property that allows the columns to be auto-generated once again after the initialization of the grid.", - "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", - "Note that after generating the columns, this property would be disabled to avoid re-creating", - "columns each time a new data is assigned.", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the built-in column hiding UI.", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the title to be displayed in the UI of the column pinning.", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "An @Input property that provides a callback for loading unique column values on demand.", - "If this property is provided, the unique values it generates will be used by the Excel Style Filtering.", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is clicked. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxGridCellComponent` is selected. Returns the `IgxGridCellComponent`.", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - " Emitted when `IgxGridRowComponent` is selected.", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is pinned.", - "The index that the column is inserted at may be changed through the `insertAtIndex` property.", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent`", - "editing has been performed in the grid and the values have **not** been submitted (e.g. `Esc` key was pressed).", - "This event is cancelable." - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` enters edit mode.", - "This event is cancelable." - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "An @Output property emitting an event when `IgxGridCellComponent` editing has been performed in the grid.", - "Event is fired after editing is completed, when the cell is exiting edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" a row enters edit mode.", - "This event is cancelable." - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(true)` is called.", - "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", - "performing paging operation, column resizing, pinning, moving or hitting `Done`", - "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", - "This event is cancelable." - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "An @Output property emitting an event when [rowEditable]=\"true\" & `endEdit(false)` is called.", - "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", - "in the row editing overlay.", - "This event is cancelable." - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a grid column is initialized. Returns the column object.", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when sorting is performed through the UI. Returns the sorting expression.", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when filtering is performed through the UI.", - "Returns the filtering expressions tree of the column for which filtering was performed.", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when paging is performed. Returns an object consisting of the previous and next pages.", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is being added to the `IgxGridComponent` through the API.", - "Returns the data for the new `IgxGridRowComponent` object.", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridRowComponent` is deleted through the `IgxGridComponent` API.", - "Returns an `IRowDataEventArgs` object.", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a new chunk of data is loaded from virtualization.", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` is resized.", - "Returns the `IgxColumnComponent` object's old and new width.", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is right clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when a `IgxGridCellComponent` is double clicked. Returns the `IgxGridCellComponent` object.", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` visibility is changed. Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving starts. Returns the moved `IgxColumnComponent` object.", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted throughout the `IgxColumnComponent` moving operation.", - "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when `IgxColumnComponent` moving ends.", - "Returns the source and target `IgxColumnComponent` objects.", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "Emitted when keydown is triggered over element inside grid's body.", - "This event is fired only if the key combination is supported in the grid.", - "Return the target type, target object and the original event. This event is cancelable.", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "Emitted when start dragging a row.", - "Return the dragged row." - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "Emitted when dropping a row.", - "Return the dropped row." - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "Emitted when a copy operation is executed.", - "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}." - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when the expanded state of a row gets changed.", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " // the id of the row", - " const rowID = event.rowID;", - " // the new expansion state", - " const newExpandedState = event.expanded;", - " // the original event that triggered onRowToggle", - " const originalEvent = event.event;", - " // whether the event should be cancelled", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the filtered `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A template reference for the template when the `IgxGridComponent` is empty.", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted before sorting is performed. Returns the sorting expressions.", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Provides access to the `IgxToolbarComponent`.", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emitted when an export process is initiated by the user.", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "Emitted when making a range selection either through", - "drag selection or through keyboard selection." - ] - } - } - }, - "methods": { - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands all rows.", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses all rows.", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created", - "row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches", - "the specified parentRowID. If the parentRowID does not exist, an error would be thrown.", - "```typescript", - "const record = {", - " ID: this.grid.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1.", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "tags": { - "inheritdoc": { - "comment": { - "tagName": "inheritdoc" - } - } - } - } - }, - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the specified column's visibility.", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Expands the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Collapses the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the row by its id. ID is either the primaryKey value or the data record instance.", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the `width` to be set on `IgxGridHeaderGroupComponent`." - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxColumnComponent` by field name.", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxRowDirective` by index.", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `IgxGridRowComponent` object by the specified primary key .", - "Requires that the `primaryKey` property is set.", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridCellComponent` that matches the conditions.", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "match any rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an `IgxGridCellComponent` object by the specified primary key and column field.", - "Requires that the primaryKey property is set.", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the next page of the `IgxGridComponent`, if the grid is not already at the last page.", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the previous page of the `IgxGridComponent`, if the grid is not already at the first page.", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Moves a column to the specified drop target.", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Goes to the desired page index.", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Manually marks the `IgxGridComponent` for change detection.", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "The method accept rowSelector as a parameter, which is the rowID.", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "the new value which is to be set." - } - }, - "rowSelector": { - "comment": { - "text": "corresponds to rowID." - } - }, - "column": { - "comment": { - "text": "corresponds to column field." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", - "Requires that the `primaryKey` property is set.", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "correspond to rowID" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Updates the `IgxGridRowComponent`, which is specified by", - "rowSelector parameter and the data source record with the passed value.", - "This method will apply requested update only if primary key is specified in the grid.", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sort a single `IgxColumnComponent`.", - "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables summaries for the specified column and applies your customSummary.", - "If you do not provide the customSummary, then the default summary for the column data type will be applied.", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "Enable summaries for the listed columns.", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Disable summaries for the listed columns.", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "Disable summaries for the specified column.", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`,", - "otherwise clears the filtering state of all `IgxColumnComponent`s.", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`,", - "otherwise clears the sorting state of all `IgxColumnComponent`.", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Pins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Unpins a column by field name. Returns whether the operation is successful.", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size.", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "the string to search." - } - }, - "caseSensitive": { - "comment": { - "text": "optionally, if the search should be case sensitive (defaults to false)." - } - }, - "exactMatch": { - "comment": { - "text": "optionally, if the text should match the entire value (defaults to false)." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", - "Returns how many times the grid contains the string.", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Reapplies the existing search.", - "Returns how many times the grid contains the last search.", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Removes all the highlights in the cell.", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "If we should take into account the hidden columns in the pinned area." - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets calculated width of the pinned area.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Get current selection state.", - "Returns an array with selected rows' IDs (primaryKey or rowData)", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "if true clears the current selection" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Select specified rows by ID.", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselect specified rows by ID.", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Selects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Deselects all rows", - "Note: By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", - "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "This method allows you to navigate to a position", - "in the grid based on provided `rowindex` and `visibleColumnIndex`,", - "also to execute a custom logic over the target element,", - "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the next cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns `ICellPosition` which defines the previous cell,", - "according to the current position, that match specific criteria.", - "You can pass callback function as a third parameter of `getPreviousCell` method.", - "The callback function accepts IgxColumnComponent as a param", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "Binding to the event", - "```html", - "", - "```" - ], - "shortText": [ - "Finishes the row transactions on the current row.", - "If `commit === true`, passes them from the pending state to the data (or transaction service)" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "Opens the advanced filtering dialog." - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "indicates whether the changes should be applied" - } - } - }, - "tags": {}, - "shortText": "Closes the advanced filtering dialog." - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", - "```html", - "", - "```" - ] - } - } - }, - "filteredData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of objects containing the filtered data in the `IgxGridComponent`.", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets an array of objects containing the filtered data in the `IgxGridComponent`.", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "tags": { - "experimental": { - "comment": { - "text": "@hidden", - "tagName": "experimental" - } - } - }, - "shortText": "Get transactions service for the grid." - } - } - }, - "expansionDepth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", - "set to `Infinity` which means all levels would be expanded.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", - "set to `Infinity` which means all levels would be expanded.", - "```html", - "", - "```" - ] - } - } - }, - "rowLoadingIndicatorTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "", - "", - "```" - ], - "shortText": [ - "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", - "```html", - "", - " loop", - "" - ] - } - }, - "setter": { - "comment": { - "text": [ - "", - "", - "```" - ], - "shortText": [ - "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", - "```html", - "", - " loop", - "" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "An accessor that sets the resource strings.", - "By default it uses EN resources." - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the resource strings." - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering logic of the `IgxGridComponent`.", - "The default is AND.", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filtering state of `IgxGridComponent`.", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the advanced filtering state of `IgxGridComponent`.", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the advanced filtering state of the `IgxGridComponent`.", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "Returns the locale of the grid.", - "If not set, returns browser's language." - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the locale of the grid." - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the paging feature is enabled/disabled.", - "The default state is disabled (false).", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the paging feature.", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current page index.", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the current page index.", - "```html", - "", - "```", - "Two-way data binding.", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the number of visible items per page of the `IgxGridComponent`.", - "The default is 15.", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the number of visible items per page of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the column hiding UI for the `IgxGridComponent` is enabled.", - "By default it is disabled (false).", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the column hiding UI for the `IgxGridComponent` is enabled.", - "In order for the UI to work, you need to enable the toolbar as shown in the example below.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns if the row selectors are hidden" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to change the visibility of the row selectors", - "By default row selectors are shown" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be moved.", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether the `IgxGridRowComponent` is editable.", - "By default it is set to false.", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets whether rows can be edited.", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the height of the `IgxGridComponent`.", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the height of the `IgxGridComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns the width of the `IgxGridComponent`.", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the width of the header of the `IgxGridComponent`.", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the row height.", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the row height.", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "An @Input property that sets the default width of the `IgxGridComponent`'s columns.", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records." - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets whether the grid is going to show loading indicator.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns whether the grid is showing loading indicator." - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An @Input property that sets the message displayed when there are no records and the grid is filtered.", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "An accessor that returns the message displayed when there are no records and the grid is filtered." - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the built-in column pinning UI should be shown in the toolbar.", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the built-in column pinning UI should be shown in the toolbar.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets if the filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a value indicating whether the advanced filtering is enabled.", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets a value indicating whether the advanced filtering is enabled.", - "By default it's disabled.", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the filter mode.", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets filter mode.", - "By default it's set to FilterMode.quickFilter.", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary position.", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary position.", - "By default it is bottom.", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the summary calculation mode.", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets summary calculation mode.", - "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the filtering strategy of the grid.", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the filtering strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "Gets the sorting strategy of the grid.", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Sets the sorting strategy of the grid.", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderGroupComponent`.", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridHeaderComponent`.", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of all `IgxGridFilteringCellComponent`.", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`.", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "A list of `IgxGridRowComponent`, currently rendered.", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the toolbar to show custom content.", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - }, - "setter": { - "comment": { - "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Returns the sorting state of the `IgxGridComponent`.", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "```" - ], - "shortText": [ - "Sets the sorting state of the `IgxGridComponent`.", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "Returns the number of hidden `IgxColumnComponent`.", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column hiding UI of the`IgxColumnComponent`.", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the text to be displayed inside the toggle button", - "for the built-in column pinning UI of the`IgxColumnComponent`.", - "```html", - "", - "```" - ] - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the `IgxGridComponent`'s toolbar is shown or hidden.", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Shows or hides the `IgxGridComponent`'s toolbar.", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the toolbar's title.", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the toolbar's title.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to MS Excel is enabled or disabled.", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to MS Excel.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns whether the option for exporting to CSV is enabled or disabled.", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enable or disable the option for exporting to CSV.", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the main export button.", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the main export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the MS Excel export button.", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the MS Excel export button.", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the textual content for the CSV export button.", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets the textual content for the CSV export button.", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current cell selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set cell selection mode", - "By default the cell selection mode is multiple" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": "Returns the current row selection state, which can be none, single or multiple" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Allows you to set row selection mode", - "By default the row selection mode is none" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Returns a list of key-value pairs [row ID, expansion state]. Includes only states that differ from the default one.", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "text": [ - "Two-way data binding.", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "Sets a list of key-value pairs [row ID, expansion state].", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the native element of the `IgxGridComponent`.", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridComponent`'s rows height.", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width.", - "Used internally for restricting header group component width.", - "The values below depend on the header cell default right/left padding values." - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the current width of the container for the unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of `IgxColumnComponent`s.", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the pinned `IgxColumnComponent`s.", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of unpinned `IgxColumnComponent`s.", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of visible `IgxColumnComponent`s.", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of pages.", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the first page.", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total number of records.", - "Only functions when paging is enabled.", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the current page is the last page.", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the total width of the `IgxGridComponent`.", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has sortable columns.", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has editable columns.", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has fiterable columns.", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has summarized columns.", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has moveable columns.", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column groups.", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition.", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array of the selected `IgxGridCellComponent`s.", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid.", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "Returns an array containing the filtered sorted data.", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/icon/IgxIconComponent.json b/typedoc/en/lib/icon/IgxIconComponent.json deleted file mode 100644 index 0df6089e..00000000 --- a/typedoc/en/lib/icon/IgxIconComponent.json +++ /dev/null @@ -1,208 +0,0 @@ -{ - "IgxIconComponent": { - "properties": { - "cssClass": { - "comment": { - "shortText": [ - " This allows you to change the value of `class.igx-icon`. By default it's `igx-icon`.", - "```typescript", - "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", - "constructor(private cdRef:ChangeDetectorRef) {}", - "ngAfterViewInit() {", - " this.icon.cssClass = \"\";", - " this.cdRef.detectChanges();", - "}", - "```" - ] - } - }, - "ariaHidden": { - "comment": { - "shortText": [ - " This allows you to disable the `aria-hidden` attribute. By default it's applied.", - "```typescript", - "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", - "constructor(private cdRef:ChangeDetectorRef) {}", - "ngAfterViewInit() {", - " this.icon.ariaHidden = false;", - " this.cdRef.detectChanges();", - "}", - "```" - ] - } - }, - "id": { - "comment": { - "shortText": [ - " An @Input property that sets the value of the `id` attribute.", - "```html", - "settings", - "```" - ] - } - }, - "font": { - "comment": { - "shortText": [ - " An @Input property that sets the value of the `fontSet`. By default it's \"material\".", - "```html", - "settings", - "```" - ] - } - }, - "active": { - "comment": { - "shortText": [ - " An @Input property that allows you to disable the `active` property. By default it's applied.", - "```html", - "settings", - "```" - ] - } - }, - "iconColor": { - "comment": { - "shortText": [ - " An @Input property that allows you to change the `iconColor` of the icon.", - "```html", - "settings", - "```" - ] - } - }, - "iconName": { - "comment": { - "shortText": [ - " An @Input property that allows you to set the `iconName` of the icon.", - " The `iconName` can be set using the `name` property.", - "```html", - "question_answer", - "```" - ] - } - }, - "el": { - "comment": { - "shortText": "An ElementRef property of the `igx-icon` component." - } - } - }, - "methods": {}, - "accessors": { - "getFontSet": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns the value of the font property.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconFont = this.icon.getFontSet;", - "}", - "```" - ] - } - } - }, - "getActive": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns the value of the active property.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconActive = this.icon.getActive;", - "}", - "```" - ] - } - } - }, - "getInactive": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns inactive property.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconActive = this.icon.getInactive;", - "}", - "```" - ] - } - } - }, - "getIconColor": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns the opposite value of the `iconColor` property.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconColor = this.icon.getIconColor;", - "}", - "```" - ] - } - } - }, - "getIconName": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns the value of the iconName property.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconName = this.icon.getIconName;", - "}", - "```" - ] - } - } - }, - "getSvgKey": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns the key of the SVG image.", - " The key consists of the fontSet and the iconName separated by underscore.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let svgKey = this.icon.getSvgKey;", - "}", - "```" - ] - } - } - }, - "template": { - "getter": { - "comment": { - "shortText": [ - " An accessor that returns a TemplateRef to explicit, svg or no ligature.", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconTemplate = this.icon.template;", - "}", - "```" - ] - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/list/IgxListComponent.json b/typedoc/en/lib/list/IgxListComponent.json deleted file mode 100644 index 08a074cc..00000000 --- a/typedoc/en/lib/list/IgxListComponent.json +++ /dev/null @@ -1,415 +0,0 @@ -{ - "IgxListComponent": { - "properties": { - "children": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns a collection of all items and headers in the list.", - "```typescript", - "let listChildren: QueryList = this.list.children;", - "```" - ] - } - }, - "emptyListTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the IgxList in case there are no list items defined and `isLoading` is set to `false`.", - "```typescript", - "let emptyTemplate = this.list.emptyListTemplate;", - "```" - ] - } - }, - "dataLoadingTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the template which will be used by the IgxList in case there are no list items defined and `isLoading` is set to `true`.", - "```typescript", - "let loadingTemplate = this.list.dataLoadingTemplate;", - "```" - ] - } - }, - "listItemLeftPanningTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the template shown when left panning a list item.", - "Default value is `null`.", - "```html", - " ", - "```", - "```typescript", - "let itemLeftPanTmpl = this.list.listItemLeftPanningTemplate;", - "```" - ] - } - }, - "listItemRightPanningTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the template shown when right panning a list item.", - "Default value is `null`.", - "```html", - " ", - "```", - "```typescript", - "let itemRightPanTmpl = this.list.listItemRightPanningTemplate;", - "```" - ] - } - }, - "panEndTriggeringThreshold": { - "comment": { - "shortText": [ - "Provides a threshold after which the item's panning will be completed automatically.", - "By default this property is set to 0.5 which is 50% of the list item's width.", - "```typescript", - "this.list.panEndTriggeringThreshold = 0.8;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `id` of the list.", - "If not set, the `id` of the first list component will be `\"igx-list-0\"`.", - "```html", - "", - "```", - "```typescript", - "let listId = this.list.id;", - "```" - ] - } - }, - "allowLeftPanning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the left panning of an item is allowed.", - "Default value is `false`.", - "```html", - " ", - "```", - "```typescript", - "let isLeftPanningAllowed = this.list.allowLeftPanning;", - "```" - ] - } - }, - "allowRightPanning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the right panning of an item is allowed.", - "Default value is `false`.", - "```html", - " ", - "```", - "```typescript", - "let isRightPanningAllowed = this.list.allowRightPanning;", - "```" - ] - } - }, - "isLoading": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the list is currently loading data.", - "Set it to display the dataLoadingTemplate while data is being retrieved.", - "Default value is `false`.", - "```html", - " ", - "```", - "```typescript", - "let isLoading = this.list.isLoading;", - "```" - ] - } - }, - "onLeftPan": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emits an event within the current list when left pan gesture is executed on a list item.", - "Provides a reference to an object of type `IListItemPanningEventArgs` as an event argument.", - "```html", - "", - "```" - ] - } - }, - "onRightPan": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emits an event within the current list when right pan gesture is executed on a list item.", - "Provides a reference to an object of type `IListItemPanningEventArgs` as an event argument.", - "```html", - "", - "```" - ] - } - }, - "onPanStateChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emits an event within the current list when pan gesture is executed on list item.", - "Provides references to the `IgxListItemComponent` and `IgxListPanState` as event arguments.", - "```html", - "", - "```" - ] - } - }, - "onItemClicked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Emits an event within the current list when a list item has been clicked.", - "Provides references to the `IgxListItemComponent` and `Event` as event arguments.", - " ```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "role": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Gets the `role` attribute.", - "```typescript", - "let listRole = this.list.role;", - "```" - ] - } - } - }, - "isListEmpty": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns boolean indicating if the list is empty.", - "```typescript", - "let isEmpty = this.list.isListEmpty;", - "```" - ] - } - } - }, - "items": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `items` in the list excluding the headers.", - "```typescript", - "let listItems: IgxListItemComponent[] = this.list.items;", - "```" - ] - } - } - }, - "headers": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the headers in the list.", - "```typescript", - "let listHeaders: IgxListItemComponent[] = this.list.headers;", - "```" - ] - } - } - }, - "context": { - "getter": { - "comment": { - "shortText": [ - "Returns the `context` object which represents the `template context` binding into the `list container`", - "by providing the `$implicit` declaration which is the `IgxListComponent` itself.", - "```typescript", - "let listComponent = this.list.context;", - "```" - ] - } - } - }, - "template": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the `template` of an empty list.", - "```typescript", - "let listTemplate = this.list.template;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "Returns the theme of the component.", - "The default theme is `comfortable`.", - "Available options are `comfortable`, `cosy`, `compact`.", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "Sets the theme of the component." - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/en/lib/switch/IgxSwitchComponent.json b/typedoc/en/lib/switch/IgxSwitchComponent.json deleted file mode 100644 index bff1eb07..00000000 --- a/typedoc/en/lib/switch/IgxSwitchComponent.json +++ /dev/null @@ -1,412 +0,0 @@ -{ - "IgxSwitchComponent": { - "comment": { - "text": [ - "The Ignite UI Switch lets the user toggle between on/off or true/false states.", - "Example:", - "```html", - "", - " Simple switch", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Switch** -", - "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/switch.html)" - ] - }, - "properties": { - "nativeCheckbox": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the native checkbox element.", - "```typescript", - "let checkboxElement = this.switch.nativeCheckbox;", - "```" - ] - } - }, - "nativeLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the native label element.", - "```typescript", - "let labelElement = this.switch.nativeLabel;", - "```" - ] - } - }, - "placeholderLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns reference to the label placeholder element.", - "```typescript", - "let labelPlaceholder = this.switch.placeholderLabel;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `id` of the switch component.", - "If not set, the `id` of the first switch component will be `\"igx-switch-0\"`.", - "```html", - "", - "```", - "```typescript", - "let switchId = this.switch.id;", - "```" - ] - } - }, - "labelId": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the id of the `label` element in the switch component.", - "If not set, the label of the first switch component will have value `\"igx-switch-0-label\"`.", - "```html", - "", - "```", - "```typescript", - "let labelId = this.switch.labelId;", - "```" - ] - } - }, - "value": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `value` attribute of the switch component.", - "```html", - "", - "```", - "```typescript", - "let value = this.switch.value;", - "```" - ] - } - }, - "name": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `name` attribute of the switch component.", - "```html", - "", - "```", - "```typescript", - "let name = this.switch.name;", - "```" - ] - } - }, - "tabindex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the value of the `tabindex` attribute.", - "```html", - "", - "```", - "```typescript", - "let tabIndex = this.switch.tabindex;", - "```" - ] - } - }, - "labelPosition": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the position of the `label` in the switch component.", - "If not set, `labelPosition` will have value `\"after\"`.", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.switch.labelPosition;", - "```" - ] - } - }, - "disableRipple": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Enables/Disables the ripple effect", - "If not set, `disableRipple` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRippleDisabled = this.switch.disableRipple;", - "```" - ] - } - }, - "required": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether switch is required.", - "If not set, `required` will have value `false`.", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.switch.required;", - "```" - ] - } - }, - "ariaLabelledBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `aria-labelledBy` attribute.", - "If not set, the value of `aria-labelledBy` will be equal to the value of `labelId` attribute.", - "```html", - "", - "```", - "```typescript", - "let ariaLabelledBy = this.switch.ariaLabelledBy;", - "```" - ] - } - }, - "ariaLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the value of the `aria-label` attribute.", - "```html", - "", - "```", - "```typescript", - "let ariaLabel = this.switch.ariaLabel;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "An event that is emitted after the switch state is changed.", - "Provides references to the `IgxSwitchComponent` and the `checked` property as event arguments." - ] - } - }, - "cssClass": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Returns the class of the switch component.", - "```typescript", - "let switchClass = this.switch.cssClass;", - "```" - ] - } - }, - "checked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the switch is on or off.", - "Default value is 'false'.", - "```html", - " ", - "```", - "```typescript", - "let isChecked = this.switch.checked;", - "```" - ] - } - }, - "disabled": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets the `disabled` attribute.", - "Default value is `false`.", - "```html", - "", - "```", - "```typescript", - "let isDisabled = this.switch.disabled;", - "```" - ] - } - }, - "focused": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Sets/gets whether the switch component is on focus.", - "Default value is `false`.", - "```typescript", - "this.switch.focused = true;", - "```", - "```typescript", - "let isFocused = this.switch.focused;", - "```" - ] - } - } - }, - "methods": { - "toggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "memberof" - } - } - }, - "shortText": [ - "Toggles the checked state of the switch.", - "```typescript", - "this.switch.toggle();", - "```" - ] - } - } - }, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/en/lib/avatar/IgxAvatarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/avatar/IgxAvatarComponent.json similarity index 100% rename from typedoc/en/lib/avatar/IgxAvatarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/avatar/IgxAvatarComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json new file mode 100644 index 00000000..659638b5 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json @@ -0,0 +1,217 @@ +{ + "IgxBadgeComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxBadgeModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-badge-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "badge, icon, notification", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Badge is used to decorate avatars, navigation menus, or other components in the", + "application when visual notification is needed. They are usually designed as icons with a predefined", + "style to communicate information, success, warnings, or errors." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "" + ], + "tagName": "example" + } + } + }, + "shortText": "Badge provides visual notifications used to decorate avatars, menus, etc." + }, + "properties": { + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, the `id` will have value `\"igx-badge-0\"`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `id` of the badge." + } + }, + "type": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allowed values are `primary`, `info`, `success`, `warning`, `error`.", + "Providing an invalid value won't display a badge." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the type of the badge." + } + }, + "value": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "If an `icon` property is already set the `icon` will be displayed.", + "If neither a `value` nor an `icon` is set the content of the badge will be empty." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the value to be displayed inside the badge." + } + }, + "icon": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Has priority over the `value` property.", + "If neither a `value` nor an `icon` is set the content of the badge will be empty.", + "Providing an invalid value won't display anything." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets an icon for the badge from the material icons set." + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.role = 'status';", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the role attribute value." + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.cssClass = 'my-badge-class';", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the the css class to use on the badge." + } + }, + "label": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.label = 'badge';", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the aria-label attribute value." + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json b/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json new file mode 100644 index 00000000..b6600c67 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json @@ -0,0 +1,8 @@ +{ + "IgxBadgeType": { + "comment": { + "shortText": "Determines the igxBadge type" + }, + "members": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/banner/BannerCancelEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/banner/BannerCancelEventArgs.json similarity index 100% rename from typedoc/en/lib/banner/BannerCancelEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/banner/BannerCancelEventArgs.json diff --git a/typedoc/en/lib/banner/BannerEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/banner/BannerEventArgs.json similarity index 100% rename from typedoc/en/lib/banner/BannerEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/banner/BannerEventArgs.json diff --git a/typedoc/en/lib/banner/IgxBannerComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/banner/IgxBannerComponent.json similarity index 100% rename from typedoc/en/lib/banner/IgxBannerComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/banner/IgxBannerComponent.json diff --git a/typedoc/en/lib/buttonGroup/IButtonGroupEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/buttonGroup/IButtonGroupEventArgs.json similarity index 100% rename from typedoc/en/lib/buttonGroup/IButtonGroupEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/buttonGroup/IButtonGroupEventArgs.json diff --git a/typedoc/en/lib/buttonGroup/IgxButtonGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/buttonGroup/IgxButtonGroupComponent.json similarity index 100% rename from typedoc/en/lib/buttonGroup/IgxButtonGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/buttonGroup/IgxButtonGroupComponent.json diff --git a/typedoc/en/lib/calendar/Calendar.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/Calendar.json similarity index 95% rename from typedoc/en/lib/calendar/Calendar.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/Calendar.json index a959055f..1b5238f4 100644 --- a/typedoc/en/lib/calendar/Calendar.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/calendar/Calendar.json @@ -4,6 +4,7 @@ "methods": { "weekdays": { "comment": { + "returns": "\n", "tags": { "memberof": { "comment": { @@ -24,6 +25,7 @@ }, "monthdates": { "comment": { + "returns": "\n", "tags": { "memberof": { "comment": { @@ -40,6 +42,7 @@ }, "monthdatescalendar": { "comment": { + "returns": "\n", "tags": { "memberof": { "comment": { diff --git a/typedoc/en/lib/calendar/CalendarSelection.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/CalendarSelection.json similarity index 100% rename from typedoc/en/lib/calendar/CalendarSelection.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/CalendarSelection.json diff --git a/typedoc/en/lib/calendar/CalendarView.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/CalendarView.json similarity index 100% rename from typedoc/en/lib/calendar/CalendarView.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/CalendarView.json diff --git a/typedoc/en/lib/calendar/IgxCalendarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json similarity index 97% rename from typedoc/en/lib/calendar/IgxCalendarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json index a4c7c58b..68a26f29 100644 --- a/typedoc/en/lib/calendar/IgxCalendarComponent.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json @@ -216,22 +216,23 @@ "tagName": "memberof" } } - } + }, + "shortText": "Gets the header template." } }, "setter": { "comment": { "tags": { - "example": { - "comment": { - "text": [ - "```html", - "", - "```" - ], - "tagName": "example" - } - }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, "memberof": { "comment": { "text": "IgxCalendarComponent", diff --git a/typedoc/en/lib/calendar/IgxMonthPickerBaseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/IgxMonthPickerBaseDirective.json similarity index 100% rename from typedoc/en/lib/calendar/IgxMonthPickerBaseDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/IgxMonthPickerBaseDirective.json diff --git a/typedoc/en/lib/calendar/IgxDaysViewComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/days-view/IgxDaysViewComponent.json similarity index 100% rename from typedoc/en/lib/calendar/IgxDaysViewComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/days-view/IgxDaysViewComponent.json diff --git a/typedoc/en/lib/calendar/IgxMonthPickerComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/month-picker/IgxMonthPickerComponent.json similarity index 100% rename from typedoc/en/lib/calendar/IgxMonthPickerComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/month-picker/IgxMonthPickerComponent.json diff --git a/typedoc/en/lib/calendar/IgxMonthsViewComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/months-view/IgxMonthsViewComponent.json similarity index 100% rename from typedoc/en/lib/calendar/IgxMonthsViewComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/months-view/IgxMonthsViewComponent.json diff --git a/typedoc/en/lib/calendar/CalendarHammerConfig.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json similarity index 96% rename from typedoc/en/lib/calendar/CalendarHammerConfig.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json index 980b848e..0a7fb607 100644 --- a/typedoc/en/lib/calendar/CalendarHammerConfig.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json @@ -25,6 +25,7 @@ "methods": { "buildHammer": { "comment": { + "returns": "A HammerJS event-manager object.\n", "parameters": { "element": { "comment": { diff --git a/typedoc/en/lib/calendar/IgxYearsViewComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/calendar/years-view/IgxYearsViewComponent.json similarity index 100% rename from typedoc/en/lib/calendar/IgxYearsViewComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/calendar/years-view/IgxYearsViewComponent.json diff --git a/typedoc/en/lib/card/IgxCardActionsComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json similarity index 66% rename from typedoc/en/lib/card/IgxCardActionsComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json index d63b38df..fe84dfc3 100644 --- a/typedoc/en/lib/card/IgxCardActionsComponent.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json @@ -6,16 +6,25 @@ "properties": { "layout": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, "shortText": [ "An @Input property that sets the layout style of the actions.", "By default icons and icon buttons, as well as regular buttons", "are split into two containers, which are then positioned on both ends", "of the card-actions area.", "You can justify the elements in those groups so they are positioned equally", - "from one another taking up all the space available along the card actions axis.", - "```html", - "", - "```" + "from one another taking up all the space available along the card actions axis." ] } }, @@ -29,16 +38,25 @@ }, "reverse": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, "shortText": [ "An @Input property that sets order of the buttons the actions area.", "By default all icons/icon buttons are placed at the end of the action", "area. Any regular buttons(flat, raised) will appear before the icons/icon buttons", "placed in the actions area.", "If you want to reverse their positions so that icons appear first, use the `reverse`", - "attribute.", - "```html", - "", - "```" + "attribute." ] } } diff --git a/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardComponent.json new file mode 100644 index 00000000..5a798ebe --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardComponent.json @@ -0,0 +1,101 @@ +{ + "IgxCardComponent": { + "properties": { + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let cardId = this.card.id;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `id` of the card.", + "If not set, `id` will have value `\"igx-card-0\"`;" + ] + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `role` attribute of the card.", + "By default the value is set to `group`." + ] + } + }, + "type": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `type` attribute of the card.", + "By default the value is set to `default`. You can make the card use the", + "outlined style by setting the value to `outlined`." + ] + } + }, + "horizontal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `horizontal` attribute of the card.", + "Setting this to `true` will make the different card sections align horizontally,", + "essentially flipping the card to the side." + ] + } + } + }, + "methods": {}, + "accessors": { + "isOutlinedCard": { + "getter": { + "comment": { + "shortText": "A getter which will return true if the card type is `outlined`." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/card/IgxCardContentDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardContentDirective.json similarity index 100% rename from typedoc/en/lib/card/IgxCardContentDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardContentDirective.json diff --git a/typedoc/en/lib/card/IgxCardFooterDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json similarity index 52% rename from typedoc/en/lib/card/IgxCardFooterDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json index d6504e57..d2685283 100644 --- a/typedoc/en/lib/card/IgxCardFooterDirective.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json @@ -6,12 +6,21 @@ "properties": { "role": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, "shortText": [ "An @Input property that sets the value of the `role` attribute of the card footer.", - "By default the value is set to `footer`.", - "```html", - "", - "```" + "By default the value is set to `footer`." ] } } diff --git a/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json new file mode 100644 index 00000000..d4d78dff --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json @@ -0,0 +1,51 @@ +{ + "IgxCardHeaderComponent": { + "comment": { + "shortText": "IgxCardHeader is container for the card header" + }, + "properties": { + "vertical": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the layout style of the header.", + "By default the header elements(thumbnail and title/subtitle) are aligned horizontally." + ] + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `role` attribute of the card header.", + "By default the value is set to `header`." + ] + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/card/IgxCardHeaderSubtitleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderSubtitleDirective.json similarity index 100% rename from typedoc/en/lib/card/IgxCardHeaderSubtitleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderSubtitleDirective.json diff --git a/typedoc/en/lib/card/IgxCardHeaderTitleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderTitleDirective.json similarity index 100% rename from typedoc/en/lib/card/IgxCardHeaderTitleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardHeaderTitleDirective.json diff --git a/typedoc/en/lib/card/IgxCardMediaDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json similarity index 52% rename from typedoc/en/lib/card/IgxCardMediaDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json index ca3aee6f..c12d1415 100644 --- a/typedoc/en/lib/card/IgxCardMediaDirective.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json @@ -9,23 +9,41 @@ "properties": { "width": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, "shortText": [ "An @Input property that sets the `width` and `min-width` style property", - "of the media container. If not provided it will be set to `auto`.", - "```html", - "", - "```" + "of the media container. If not provided it will be set to `auto`." ] } }, "height": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, "shortText": [ "An @Input property that sets the `height` style property of the media container.", - "If not provided it will be set to `auto`.", - "```html", - "", - "```" + "If not provided it will be set to `auto`." ] } }, diff --git a/typedoc/en/lib/card/IgxCardThumbnailDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardThumbnailDirective.json similarity index 100% rename from typedoc/en/lib/card/IgxCardThumbnailDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardThumbnailDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardType.json b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardType.json new file mode 100644 index 00000000..faab4d99 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/card/IgxCardType.json @@ -0,0 +1,62 @@ +{ + "IgxCardType": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxCardModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-card-theme, igx-icon-theme, igx-button-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "card, button, avatar, icon", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Layouts", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Card serves as a container that allows custom content to be organized in an appealing way. There are", + "five sections in a card that you can use to organize your content. These are header, media, content, actions, and footer." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

{{title}}

", + "
{{subtitle}}
", + " ", + " ", + " ", + " ", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Card provides a way to display organized content in appealing way." + }, + "members": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/carousel/CarouselHammerConfig.json b/typedoc/en/projects/igniteui-angular/src/lib/carousel/CarouselHammerConfig.json similarity index 96% rename from typedoc/en/lib/carousel/CarouselHammerConfig.json rename to typedoc/en/projects/igniteui-angular/src/lib/carousel/CarouselHammerConfig.json index 1a86d6a1..53be88c5 100644 --- a/typedoc/en/lib/carousel/CarouselHammerConfig.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/carousel/CarouselHammerConfig.json @@ -25,6 +25,7 @@ "methods": { "buildHammer": { "comment": { + "returns": "A HammerJS event-manager object.\n", "parameters": { "element": { "comment": { diff --git a/typedoc/en/lib/carousel/ISlideEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/carousel/ISlideEventArgs.json similarity index 100% rename from typedoc/en/lib/carousel/ISlideEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/carousel/ISlideEventArgs.json diff --git a/typedoc/en/lib/carousel/IgxCarouselComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/carousel/IgxCarouselComponent.json similarity index 100% rename from typedoc/en/lib/carousel/IgxCarouselComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/carousel/IgxCarouselComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json new file mode 100644 index 00000000..116e6158 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json @@ -0,0 +1,201 @@ +{ + "IgxSlideComponent": { + "comment": { + "tags": { + "export": { + "comment": { + "tagName": "export" + } + } + }, + "text": [ + "```", + "", + " ", + "", + "```" + ], + "shortText": [ + "A slide component that usually holds an image and/or a caption text.", + "IgxSlideComponent is usually a child component of an IgxCarouselComponent." + ] + }, + "properties": { + "index": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Gets/sets the `index` of the slide inside the carousel.", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "direction": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Gets/sets the target `direction` for the slide.", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns the class of the slide component.", + "```typescript", + "let class = this.slide.cssClass;", + "```" + ] + } + } + }, + "methods": {}, + "accessors": { + "tabIndex": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns the `tabIndex` of the slide component.", + "```typescript", + "let tabIndex = this.carousel.tabIndex;", + "```" + ] + } + } + }, + "ariaSelected": { + "getter": { + "comment": { + "text": [ + "```typescript", + "let slide = this.slide.ariaSelected;", + "```" + ], + "shortText": "Returns the `aria-selected` of the slide." + } + } + }, + "ariaLive": { + "getter": { + "comment": { + "text": [ + "```typescript", + "let slide = this.slide.ariaLive;", + "```" + ], + "shortText": "Returns the `aria-live` of the slide." + } + } + }, + "active": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "text": [ + "Two-way data binding.", + "```html", + "", + " ", + "", + "```" + ], + "shortText": [ + "Gets/sets the `active` state of the slide.", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "text": [ + "Two-way data binding.", + "```html", + "", + " ", + "", + "```" + ], + "shortText": [ + "Gets/sets the `active` state of the slide.", + "```html", + "", + " ", + "", + "```" + ] + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns a reference to the carousel element in the DOM.", + "```typescript", + "let nativeElement = this.slide.nativeElement;", + "```" + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/checkbox/IChangeCheckboxEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IChangeCheckboxEventArgs.json similarity index 100% rename from typedoc/en/lib/checkbox/IChangeCheckboxEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/checkbox/IChangeCheckboxEventArgs.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json new file mode 100644 index 00000000..2bc7d233 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json @@ -0,0 +1,500 @@ +{ + "IgxCheckboxComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxCheckboxModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-checkbox-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "checkbox, label", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data entry and display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Checkbox is a selection control that allows users to make a binary choice for a certain condition.It behaves similarly", + "to the native browser checkbox." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " simple checkbox", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Allows users to make a binary choice for a certain condition." + }, + "properties": { + "nativeCheckbox": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let checkboxElement = this.checkbox.checkboxElement;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns reference to the native checkbox element." + } + }, + "nativeLabel": { + "comment": { + "text": [ + "@example", + "let labelElement = this.checkbox.nativeLabel;", + "```" + ], + "shortText": [ + "Returns reference to the native label element.", + "```typescript" + ] + } + }, + "placeholderLabel": { + "comment": { + "text": [ + "@example", + "let labelPlaceholder = this.checkbox.placeholderLabel;", + "```" + ], + "shortText": [ + "Returns reference to the label placeholder element.", + "```typescript" + ] + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let checkboxId = this.checkbox.id;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `id` of the checkbox component.", + "If not set, the `id` of the first checkbox component will be `\"igx-checkbox-0\"`." + ] + } + }, + "labelId": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let labelId = this.checkbox.labelId;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the id of the `label` element.", + "If not set, the id of the `label` in the first checkbox component will be `\"igx-checkbox-0-label\"`." + ] + } + }, + "value": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let value = this.checkbox.value;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `value` attribute." + } + }, + "name": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let name = this.checkbox.name;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `name` attribute." + } + }, + "tabindex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let tabIndex = this.checkbox.tabindex;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the value of the `tabindex` attribute." + } + }, + "labelPosition": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let labelPosition = this.checkbox.labelPosition;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + " Sets/gets the position of the `label`.", + " If not set, the `labelPosition` will have value `\"after\"`." + ] + } + }, + "disableRipple": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRippleDisabled = this.checkbox.desableRipple;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Enables/Disables the ripple effect.", + "If not set, `disableRipple` will have value `false`." + ] + } + }, + "required": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRequired = this.checkbox.required;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox is required.", + "If not set, `required` will have value `false`." + ] + } + }, + "ariaLabelledBy": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let ariaLabelledBy = this.checkbox.ariaLabelledBy;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `aria-labelledby` attribute.", + "If not set, the `aria-labelledby` will be equal to the value of `labelId` attribute." + ] + } + }, + "ariaLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let ariaLabel = this.checkbox.ariaLabel;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the value of the `aria-label` attribute." + } + }, + "change": { + "comment": { + "shortText": [ + "An event that is emitted after the checkbox state is changed.", + "Provides references to the `IgxCheckboxComponent` and the `checked` property as event arguments." + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let class = this.checkbox.cssClass;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the class of the checkbox component." + } + }, + "focused": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.checkbox.focused = true;", + "```", + "```typescript", + "let isFocused = this.checkbox.focused;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox component is on focus.", + "Default value is `false`." + ] + } + }, + "indeterminate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isIndeterminate = this.checkbox.indeterminate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the checkbox indeterminate visual state.", + "Default value is `false`;" + ] + } + }, + "checked": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isChecked = this.checkbox.checked;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox is checked.", + "Default value is `false`." + ] + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isDisabled = this.checkbox.disabled;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox is disabled.", + "Default value is `false`." + ] + } + }, + "readonly": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let readonly = this.checkbox.readonly;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox is readonly.", + "Default value is `false`." + ] + } + }, + "disableTransitions": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let disableTransitions = this.checkbox.disableTransitions;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the checkbox should disable all css transitions.", + "Default value is `false`." + ] + } + } + }, + "methods": { + "toggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.checkbox.toggle();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If `disabled` is `false`, switches the `checked` state." + } + } + }, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/checkbox/IgxCheckboxRequiredDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json similarity index 74% rename from typedoc/en/lib/checkbox/IgxCheckboxRequiredDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json index 82fa2c84..91a4a4ed 100644 --- a/typedoc/en/lib/checkbox/IgxCheckboxRequiredDirective.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json @@ -1,19 +1,6 @@ { "IgxCheckboxRequiredDirective": { - "properties": { - "required": { - "comment": { - "tags": { - "description": { - "comment": { - "text": "Tracks changes to the required attribute bound to this directive.", - "tagName": "description" - } - } - } - } - } - }, + "properties": {}, "methods": { "validate": { "comment": { @@ -50,6 +37,24 @@ } } }, - "accessors": {} + "accessors": { + "required": { + "getter": { + "comment": { + "tags": { + "description": { + "comment": { + "text": "Tracks changes to the required attribute bound to this directive.", + "tagName": "description" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } } } \ No newline at end of file diff --git a/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json new file mode 100644 index 00000000..f506f040 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json @@ -0,0 +1,539 @@ +{ + "IgxChipComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxChipsModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-chip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "chip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Chip can be templated, deleted, and selected.", + "Multiple chips can be reordered and visually connected to each other.", + "Chips reside in a container called chips area which is responsible for managing the interactions between the chips." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Chip is compact visual component that displays information in an obround." + }, + "properties": { + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that sets the value of `id` attribute. If not provided it will be automatically generated." + } + }, + "data": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that stores data related to the chip." + } + }, + "draggable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that defines if the `IgxChipComponent` can be dragged in order to change it's position.", + "By default it is set to false." + ] + } + }, + "animateOnRelease": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that enables/disables the draggable element animation when the element is released.", + "By default it's set to true." + ] + } + }, + "hideBaseOnDrag": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that enables/disables the hiding of the base element that has been dragged.", + "By default it's set to true." + ] + } + }, + "removable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that defines if the `IgxChipComponent` should render remove button and throw remove events.", + "By default it is set to false." + ] + } + }, + "removeIcon": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "delete", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that overrides the default icon that the chip applies to the remove button." + } + }, + "selectable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that defines if the `IgxChipComponent` can be selected on click or through navigation,", + "By default it is set to false." + ] + } + }, + "selectIcon": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "done_outline", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that overrides the default icon that the chip applies when it is selected." + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that defines if the `IgxChipComponent` is disabled. When disabled it restricts user interactions", + "like focusing on click or tab, selection on click or Space, dragging.", + "By default it is set to false." + ] + } + }, + "onMoveStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` moving starts.", + "Returns the moving `IgxChipComponent`." + ] + } + }, + "onMoveEnd": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` moving ends.", + "Returns the moved `IgxChipComponent`." + ] + } + }, + "onRemove": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` is removed.", + "Returns the removed `IgxChipComponent`." + ] + } + }, + "onClick": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` is clicked.", + "Returns the clicked `IgxChipComponent`, whether the event should be canceled." + ] + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits event when the `IgxChipComponent` is selected/deselected.", + "Returns the selected chip reference, whether the event should be canceled, what is the next selection state and", + "when the event is triggered by interaction `originalEvent` is provided, otherwise `originalEvent` is `null`." + ] + } + }, + "onSelectionDone": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emits event when the `IgxChipComponent` is selected/deselected and any related animations and transitions also end." + } + }, + "onKeyDown": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` keyboard navigation is being used.", + "Returns the focused/selected `IgxChipComponent`, whether the event should be canceled,", + "if the `alt`, `shift` or `control` key is pressed and the pressed key name." + ] + } + }, + "onDragEnter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when the `IgxChipComponent` has entered the `IgxChipsAreaComponent`.", + "Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as", + "the original drop event arguments." + ] + } + }, + "dragDirective": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "onMoveStart(event: IBaseChipEventArgs){", + " let dragDirective = event.owner.dragDirective;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Property that contains a reference to the `IgxDragDirective` the `IgxChipComponent` uses for dragging behavior." + } + } + }, + "methods": {}, + "accessors": { + "selected": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "Two-way data binding:", + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the `IgxChipComponent` selected state." + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('myChip')", + "public chip: IgxChipComponent;", + "selectedChip(){", + " let selectedChip = this.chip.selected;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxChipComponent` is selected." + } + } + }, + "color": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "An @Input property that sets the `IgxChipComponent` background color.", + "The `color` property supports string, rgb, hex." + ] + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('myChip')", + "public chip: IgxChipComponent;", + "ngAfterViewInit(){", + " let chipColor = this.chip.color;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the background color of the `IgxChipComponent`." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json new file mode 100644 index 00000000..837a58ce --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json @@ -0,0 +1,182 @@ +{ + "IgxChipsAreaComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxChipsModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-chip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "chip area, chip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "display", + "tagName": "igxgroup" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " {{chip.text}}", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "The chip area allows you to perform more complex scenarios with chips that require interaction,", + "like dragging, selection, navigation, etc." + ] + }, + "properties": { + "width": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that sets the width of the `IgxChipsAreaComponent`." + } + }, + "height": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that sets the height of the `IgxChipsAreaComponent`." + } + }, + "onReorder": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when `IgxChipComponent`s in the `IgxChipsAreaComponent` should be reordered.", + "Returns an array of `IgxChipComponent`s." + ] + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is selected/deselected.", + "Fired after the chips area is initialized if there are initially selected chips as well.", + "Returns an array of selected `IgxChipComponent`s and the `IgxChipAreaComponent`." + ] + } + }, + "onMoveStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved." + } + }, + "onMoveEnd": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emits an event after an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved." + } + }, + "chipsList": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "ngAfterViewInit(){", + " let chips = this.chipsArea.chipsList;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Holds the `IgxChipComponent` in the `IgxChipsAreaComponent`." + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/combo/IComboItemAdditionEvent.json b/typedoc/en/projects/igniteui-angular/src/lib/combo/IComboItemAdditionEvent.json similarity index 100% rename from typedoc/en/lib/combo/IComboItemAdditionEvent.json rename to typedoc/en/projects/igniteui-angular/src/lib/combo/IComboItemAdditionEvent.json diff --git a/typedoc/en/lib/combo/IComboSelectionChangeEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/combo/IComboSelectionChangeEventArgs.json similarity index 100% rename from typedoc/en/lib/combo/IComboSelectionChangeEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/combo/IComboSelectionChangeEventArgs.json diff --git a/typedoc/en/lib/combo/IgxComboComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json similarity index 99% rename from typedoc/en/lib/combo/IgxComboComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json index 026bdc9c..80de465f 100644 --- a/typedoc/en/lib/combo/IgxComboComponent.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json @@ -469,6 +469,7 @@ }, "selectedItems": { "comment": { + "returns": "Array of selected items\n```typescript\nlet selectedItems = this.combo.selectedItems();\n```\n", "tags": {}, "shortText": "Get current selection state" } diff --git a/typedoc/en/lib/combo/IgxComboState.json b/typedoc/en/projects/igniteui-angular/src/lib/combo/IgxComboState.json similarity index 100% rename from typedoc/en/lib/combo/IgxComboState.json rename to typedoc/en/projects/igniteui-angular/src/lib/combo/IgxComboState.json diff --git a/typedoc/en/lib/core/CancelableBrowserEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/core/CancelableBrowserEventArgs.json similarity index 100% rename from typedoc/en/lib/core/CancelableBrowserEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/CancelableBrowserEventArgs.json diff --git a/typedoc/en/lib/core/CancelableEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/core/CancelableEventArgs.json similarity index 100% rename from typedoc/en/lib/core/CancelableEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/CancelableEventArgs.json diff --git a/typedoc/en/lib/core/DisplayDensity.json b/typedoc/en/projects/igniteui-angular/src/lib/core/DisplayDensity.json similarity index 100% rename from typedoc/en/lib/core/DisplayDensity.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/DisplayDensity.json diff --git a/typedoc/en/lib/core/DisplayDensityBase.json b/typedoc/en/projects/igniteui-angular/src/lib/core/DisplayDensityBase.json similarity index 100% rename from typedoc/en/lib/core/DisplayDensityBase.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/DisplayDensityBase.json diff --git a/typedoc/en/lib/core/IBaseEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/core/IBaseEventArgs.json similarity index 100% rename from typedoc/en/lib/core/IBaseEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/IBaseEventArgs.json diff --git a/typedoc/en/lib/core/IDensityChangedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/core/IDensityChangedEventArgs.json similarity index 100% rename from typedoc/en/lib/core/IDensityChangedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/IDensityChangedEventArgs.json diff --git a/typedoc/en/lib/core/IDisplayDensityOptions.json b/typedoc/en/projects/igniteui-angular/src/lib/core/IDisplayDensityOptions.json similarity index 100% rename from typedoc/en/lib/core/IDisplayDensityOptions.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/IDisplayDensityOptions.json diff --git a/typedoc/en/lib/core/InteractionMode.json b/typedoc/en/projects/igniteui-angular/src/lib/core/InteractionMode.json similarity index 100% rename from typedoc/en/lib/core/InteractionMode.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/InteractionMode.json diff --git a/typedoc/en/lib/core/IToggleView.json b/typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IToggleView.json similarity index 100% rename from typedoc/en/lib/core/IToggleView.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IToggleView.json diff --git a/typedoc/en/lib/core/IgxNavigationCloseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationCloseDirective.json similarity index 100% rename from typedoc/en/lib/core/IgxNavigationCloseDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationCloseDirective.json diff --git a/typedoc/en/lib/core/IgxNavigationService.json b/typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationService.json similarity index 100% rename from typedoc/en/lib/core/IgxNavigationService.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationService.json diff --git a/typedoc/en/lib/core/IgxNavigationToggleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationToggleDirective.json similarity index 100% rename from typedoc/en/lib/core/IgxNavigationToggleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationToggleDirective.json diff --git a/typedoc/en/lib/data-operations/FilteringExpressionsTree.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/FilteringExpressionsTree.json similarity index 100% rename from typedoc/en/lib/data-operations/FilteringExpressionsTree.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/FilteringExpressionsTree.json diff --git a/typedoc/en/lib/data-operations/IDateParts.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IDateParts.json similarity index 100% rename from typedoc/en/lib/data-operations/IDateParts.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IDateParts.json diff --git a/typedoc/en/lib/data-operations/IFilteringExpression.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringExpression.json similarity index 100% rename from typedoc/en/lib/data-operations/IFilteringExpression.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringExpression.json diff --git a/typedoc/en/lib/data-operations/IFilteringExpressionsTree.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringExpressionsTree.json similarity index 100% rename from typedoc/en/lib/data-operations/IFilteringExpressionsTree.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringExpressionsTree.json diff --git a/typedoc/en/lib/data-operations/IFilteringOperation.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringOperation.json similarity index 100% rename from typedoc/en/lib/data-operations/IFilteringOperation.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IFilteringOperation.json diff --git a/typedoc/en/lib/data-operations/IGroupingExpression.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IGroupingExpression.json similarity index 100% rename from typedoc/en/lib/data-operations/IGroupingExpression.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IGroupingExpression.json diff --git a/typedoc/en/lib/data-operations/ISortingExpression.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/ISortingExpression.json similarity index 100% rename from typedoc/en/lib/data-operations/ISortingExpression.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/ISortingExpression.json diff --git a/typedoc/en/lib/data-operations/IgxBooleanFilteringOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxBooleanFilteringOperand.json similarity index 100% rename from typedoc/en/lib/data-operations/IgxBooleanFilteringOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxBooleanFilteringOperand.json diff --git a/typedoc/en/lib/data-operations/IgxDateFilteringOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxDateFilteringOperand.json similarity index 100% rename from typedoc/en/lib/data-operations/IgxDateFilteringOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxDateFilteringOperand.json diff --git a/typedoc/en/lib/data-operations/IgxFilteringOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxFilteringOperand.json similarity index 100% rename from typedoc/en/lib/data-operations/IgxFilteringOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxFilteringOperand.json diff --git a/typedoc/en/lib/data-operations/IgxNumberFilteringOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxNumberFilteringOperand.json similarity index 100% rename from typedoc/en/lib/data-operations/IgxNumberFilteringOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxNumberFilteringOperand.json diff --git a/typedoc/en/lib/data-operations/IgxStringFilteringOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxStringFilteringOperand.json similarity index 100% rename from typedoc/en/lib/data-operations/IgxStringFilteringOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/IgxStringFilteringOperand.json diff --git a/typedoc/en/lib/data-operations/SortingDirection.json b/typedoc/en/projects/igniteui-angular/src/lib/data-operations/SortingDirection.json similarity index 100% rename from typedoc/en/lib/data-operations/SortingDirection.json rename to typedoc/en/projects/igniteui-angular/src/lib/data-operations/SortingDirection.json diff --git a/typedoc/en/lib/date-picker/IDatePickerDisabledDateEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IDatePickerDisabledDateEventArgs.json similarity index 100% rename from typedoc/en/lib/date-picker/IDatePickerDisabledDateEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/IDatePickerDisabledDateEventArgs.json diff --git a/typedoc/en/lib/date-picker/IDatePickerValidationFailedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IDatePickerValidationFailedEventArgs.json similarity index 100% rename from typedoc/en/lib/date-picker/IDatePickerValidationFailedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/IDatePickerValidationFailedEventArgs.json diff --git a/typedoc/en/lib/date-picker/IFormatOptions.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IFormatOptions.json similarity index 100% rename from typedoc/en/lib/date-picker/IFormatOptions.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/IFormatOptions.json diff --git a/typedoc/en/lib/date-picker/IFormatViews.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IFormatViews.json similarity index 100% rename from typedoc/en/lib/date-picker/IFormatViews.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/IFormatViews.json diff --git a/typedoc/en/lib/date-picker/IgxDatePickerActionsDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerActionsDirective.json similarity index 100% rename from typedoc/en/lib/date-picker/IgxDatePickerActionsDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerActionsDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json new file mode 100644 index 00000000..b2fe2f92 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json @@ -0,0 +1,874 @@ +{ + "IgxDatePickerComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxDatePickerModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-calendar-theme, igx-icon-theme", + "tagName": "igxtheme" + } + }, + "igxgroup": { + "comment": { + "text": "Scheduling", + "tagName": "igxgroup" + } + }, + "igxkeywords": { + "comment": { + "text": "datepicker, calendar, schedule, date", + "tagName": "igxkeywords" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Date Picker displays a popup calendar that lets users select a single date." + }, + "properties": { + "label": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default label is 'Date'.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the `IgxDatePickerComponent` label." + } + }, + "labelVisibility": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the visibility is set to true.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": "", + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the `IgxDatePickerComponent` label visibility." + } + }, + "locale": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default locale is en.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the locales." + } + }, + "weekStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets on which day the week starts." + } + }, + "hideOutsideDays": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Apllies to dates that are out of the current month.", + "Default value is `false`." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let hideOutsideDays = this.datePicker.hideOutsideDays;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the inactive dates will be hidden." + } + }, + "monthsViewNumber": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default value is `1`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let monthViewsDisplayed = this.datePicker.monthsViewNumber;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of month views displayed." + } + }, + "mask": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let mask = this.datePicker.mask;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the date mask of the `IgxDatePickerComponent` when in editable dropdown mode." + } + }, + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not provided it will be automatically generated.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the value of `id` attribute." + } + }, + "formatter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom formatter function on the selected or passed date." + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables/Disables the `IgxDatePickerComponent`." + } + }, + "vertical": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the orientation of the `IgxDatePickerComponent` header." + } + }, + "todayButtonLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the today button's label." + } + }, + "cancelButtonLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "*Gets/Sets the cancel button's label." + } + }, + "mode": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the interaction mode - dialog or drop down." + } + }, + "isSpinLoop": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether date should spin continuously or stop when min/max is reached." + } + }, + "outlet": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "
", + "//..", + "", + "//..", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the container used for the popup element." + } + }, + "onOpened": { + "comment": { + "shortText": "Emitted when the `IgxDatePickerComponent` calendar is opened." + } + }, + "onClosed": { + "comment": { + "shortText": "Emitted after the `IgxDatePickerComponent` is closed." + } + }, + "onClosing": { + "comment": { + "shortText": "Emitted when the `IgxDatePickerComponent` is being closed." + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when selection is made in the calendar." + } + }, + "valueChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when date picker value is changed." + } + }, + "onDisabledDate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the user types/spins to a disabled date in the date-picker editor." + } + }, + "onValidationFailed": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the user types/spins invalid date in the date-picker editor." + } + } + }, + "methods": { + "writeValue": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "The date you want to select." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.writeValue(this.date);", + "```" + ], + "tagName": "example" + } + }, + "memberof": { + "comment": { + "text": "{@link IgxDatePickerComponent}", + "tagName": "memberof" + } + } + }, + "shortText": "Sets the selected date." + } + }, + "triggerTodaySelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Changes the input field value, @calendar.viewDate and @calendar.value.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.triggerTodaySelection();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects today's date from calendar." + } + }, + "selectDate": { + "comment": { + "parameters": { + "date": { + "comment": { + "text": "passed date that has to be set to the calendar." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "Calling this method will emit the @calendar.onSelection event,", + "which will fire @handleSelection method." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.selectDate(this.date);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Change the calendar selection." + } + }, + "deselectDate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.deselectDate();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects the calendar date." + } + }, + "openDialog": { + "comment": { + "parameters": { + "target": { + "comment": { + "text": "HTMLElement - the target element to use for positioning the drop down container according to" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.openDialog(target);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Opens the date picker drop down or dialog." + } + } + }, + "accessors": { + "formatOptions": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let formatOptions = this.datePicker.formatOptions;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the format options of the `IgxDatePickerComponent`." + } + }, + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.formatOptions = { day: \"numeric\", month: \"long\", weekday: \"long\", year: \"numeric\"};", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the format options of the `IgxDatePickerComponent`." + } + } + }, + "format": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let format = this.datePicker.format;", + "this.datePicker.format = 'yyyy-M-d';", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the date display format of the `IgxDatePickerComponent` in dropdown mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the date display format of the `IgxDatePickerComponent` in dropdown mode." + } + } + }, + "formatViews": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let formatViews = this.datePicker.formatViews;", + " this.datePicker.formatViews = {day:false, month: false, year:false};", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the format views of the `IgxDatePickerComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the format views of the `IgxDatePickerComponent`." + } + } + }, + "disabledDates": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let disabledDates = this.datepicker.disabledDates;", + "this.datePicker.disabledDates = [ {type: DateRangeType.Weekends}, ...];", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the disabled dates descriptors." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the disabled dates descriptors." + } + } + }, + "specialDates": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let specialDates = this.datepicker.specialDates;", + "this.datePicker.specialDates = [ {type: DateRangeType.Weekends}, ... ];", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the special dates descriptors." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the special dates descriptors." + } + } + }, + "modalOverlaySettings": { + "getter": { + "comment": { + "shortText": "Gets/Sets the modal overlay settings." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the modal overlay settings." + } + } + }, + "dropDownOverlaySettings": { + "getter": { + "comment": { + "shortText": "Gets/Sets the drop-down overlay settings." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the drop-down overlay settings." + } + } + }, + "displayData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let selectedDate = this.datePicker.displayData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the formatted date when `IgxDatePickerComponent` is in dialog mode." + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let template = this.template();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the input group template." + } + } + }, + "context": { + "getter": { + "comment": { + "shortText": "Gets the context passed to the input group template." + } + } + }, + "value": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the selected date." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the selected date." + } + } + }, + "onOpen": { + "getter": { + "comment": { + "tags": { + "deprecated": { + "comment": { + "text": [ + "Use 'onOpened' instead.", + "An event that is emitted when the `IgxDatePickerComponent` calendar is opened." + ], + "tagName": "deprecated" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public open(event){", + " alert(\"The date-picker calendar has been opened!\");", + "}", + "```", + "```html", + "", + "```" + ], + "tagName": "example" + } + } + } + } + }, + "setter": { + "comment": {} + } + }, + "onClose": { + "getter": { + "comment": { + "tags": { + "deprecated": { + "comment": { + "text": [ + "Use 'onClosed' instead.", + "\"An event that is emitted when the `IgxDatePickerComponent` is closed." + ], + "tagName": "deprecated" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public close(event){", + " alert(\"The date-picker has been closed!\");", + "}", + "```", + "```html", + "", + "```" + ], + "tagName": "example" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/date-picker/PredefinedFormatOptions.json b/typedoc/en/projects/igniteui-angular/src/lib/date-picker/PredefinedFormatOptions.json similarity index 100% rename from typedoc/en/lib/date-picker/PredefinedFormatOptions.json rename to typedoc/en/projects/igniteui-angular/src/lib/date-picker/PredefinedFormatOptions.json diff --git a/typedoc/en/lib/dialog/IDialogEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/dialog/IDialogEventArgs.json similarity index 100% rename from typedoc/en/lib/dialog/IDialogEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/dialog/IDialogEventArgs.json diff --git a/typedoc/en/lib/dialog/IgxDialogComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/dialog/IgxDialogComponent.json similarity index 100% rename from typedoc/en/lib/dialog/IgxDialogComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/dialog/IgxDialogComponent.json diff --git a/typedoc/en/lib/directives/AutocompleteItemSelectionEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteItemSelectionEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/AutocompleteItemSelectionEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteItemSelectionEventArgs.json diff --git a/typedoc/en/lib/directives/AutocompleteOverlaySettings.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteOverlaySettings.json similarity index 100% rename from typedoc/en/lib/directives/AutocompleteOverlaySettings.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteOverlaySettings.json diff --git a/typedoc/en/lib/directives/IgxAutocompleteDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/IgxAutocompleteDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxAutocompleteDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/autocomplete/IgxAutocompleteDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json new file mode 100644 index 00000000..a86eef86 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json @@ -0,0 +1,218 @@ +{ + "IgxButtonDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxButtonModule", + "tagName": "igxmodule" + } + }, + "igxparent": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxparent" + } + }, + "igxtheme": { + "comment": { + "text": "igx-button-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "button, span, div, click", + "tagName": "igxkeywords" + } + }, + "remarks": { + "comment": { + "text": "The Ignite UI Button directive is intended to be used by any button, span or div and turn it into a fully functional button.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "The Button directive provides the Ignite UI Button functionality to every component that's intended to be used as a button." + }, + "properties": { + "buttonClick": { + "comment": { + "shortText": "Called when the button is clicked." + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.button.role = 'navbutton';", + "let buttonRole = this.button.role;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `role` attribute." + } + }, + "selected": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Gets or sets whether the button is selected.", + "Mainly used in the IgxButtonGroup component and it will have no effect if set separately." + ] + } + } + }, + "methods": {}, + "accessors": { + "nativeElement": { + "getter": { + "comment": { + "shortText": "Returns the underlying DOM element." + } + } + }, + "type": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the type of the button." + } + } + }, + "color": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the button text color." + } + } + }, + "background": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the background color of the button." + } + } + }, + "label": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the `aria-label` attribute." + } + } + }, + "disabled": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables/disables the button." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxDividerDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/divider/IgxDividerDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxDividerDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/divider/IgxDividerDirective.json diff --git a/typedoc/en/lib/directives/IDragBaseEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragBaseEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDragBaseEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragBaseEventArgs.json diff --git a/typedoc/en/lib/directives/IDragGhostBaseEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragGhostBaseEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDragGhostBaseEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragGhostBaseEventArgs.json diff --git a/typedoc/en/lib/directives/IDragMoveEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragMoveEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDragMoveEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragMoveEventArgs.json diff --git a/typedoc/en/lib/directives/IDragStartEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragStartEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDragStartEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDragStartEventArgs.json diff --git a/typedoc/en/lib/directives/IDropBaseEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDropBaseEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDropBaseEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDropBaseEventArgs.json diff --git a/typedoc/en/lib/directives/IDropDroppedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDropDroppedEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IDropDroppedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IDropDroppedEventArgs.json diff --git a/typedoc/en/lib/directives/IgxDragDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDragDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxDragDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDragDirective.json diff --git a/typedoc/en/lib/directives/IgxDropDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDropDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxDropDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDropDirective.json diff --git a/typedoc/en/lib/directives/IgxFocusDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/focus/IgxFocusDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxFocusDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/focus/IgxFocusDirective.json diff --git a/typedoc/en/lib/directives/IForOfDataChangingEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IForOfDataChangingEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IForOfDataChangingEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IForOfDataChangingEventArgs.json diff --git a/typedoc/en/lib/directives/IForOfState.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IForOfState.json similarity index 100% rename from typedoc/en/lib/directives/IForOfState.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IForOfState.json diff --git a/typedoc/en/lib/directives/IgxForOfContext.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json similarity index 85% rename from typedoc/en/lib/directives/IgxForOfContext.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json index 0e64d8c5..5afba649 100644 --- a/typedoc/en/lib/directives/IgxForOfContext.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json @@ -1,7 +1,13 @@ { "IgxForOfContext": { "comment": { - "shortText": " @publicApi" + "tags": { + "publicapi": { + "comment": { + "tagName": "publicapi" + } + } + } }, "properties": {}, "methods": {}, diff --git a/typedoc/en/lib/directives/IgxForOfDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxForOfDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfDirective.json diff --git a/typedoc/en/lib/directives/IgxGridForOfDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxGridForOfDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxGridForOfDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/for-of/IgxGridForOfDirective.json diff --git a/typedoc/en/lib/directives/IgxHintDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/hint/IgxHintDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxHintDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/hint/IgxHintDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json new file mode 100644 index 00000000..4f4c34ba --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json @@ -0,0 +1,364 @@ +{ + "IgxInputDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxInputGroupModule", + "tagName": "igxmodule" + } + }, + "igxparent": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxparent" + } + }, + "igxtheme": { + "comment": { + "text": "igx-input-group-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "input, input group, form, field, validation", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "presentation", + "tagName": "igxgroup" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "The `igxInput` directive creates single- or multiline text elements, covering common scenarios when dealing with form inputs." + }, + "properties": { + "isInput": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isCLassAdded = this.igxInput.isInput;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the `\"igx-input-group__input\"` class is added to the host element.", + "Default value is `false`." + ] + } + }, + "isTextArea": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isCLassAdded = this.igxInput.isTextArea;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the `\"class.igx-input-group__textarea\"` class is added to the host element.", + "Default value is `false`." + ] + } + } + }, + "methods": { + "focus": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.igxInput.focus();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets a focus on the igxInput." + } + } + }, + "accessors": { + "value": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the `value` property." + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('igxInput', {read: IgxInputDirective})", + " public igxInput: IgxInputDirective;", + "let inputValue = this.igxInput.value;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the `value` propery." + } + } + }, + "disabled": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the `disabled` property." + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('igxInput', {read: IgxInputDirective})", + " public igxInput: IgxInputDirective;", + "let isDisabled = this.igxInput.disabled;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the `disabled` property" + } + } + }, + "required": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the `required` property." + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isRequired = this.igxInput.required;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets whether the igxInput is required." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputNativeElement = this.igxInput.nativeElement;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the `nativeElement` of the igxInput." + } + } + }, + "hasPlaceholder": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let hasPlaceholder = this.igxInput.hasPlaceholder;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets whether the igxInput has a placeholder." + } + } + }, + "placeholder": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputPlaceholder = this.igxInput.placeholder;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the placeholder element of the igxInput." + } + } + }, + "focused": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isFocused = this.igxInput.focused;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets whether the igxInput is focused." + } + } + }, + "valid": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputState = this.igxInput.valid;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the state of the igxInput." + } + }, + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.igxInput.valid = IgxInputState.INVALID;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the state of the igxInput." + } + } + }, + "isValid": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let valid = this.igxInput.isValid;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets whether the igxInput is valid." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxFlexDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/layout/IgxFlexDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxFlexDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/layout/IgxFlexDirective.json diff --git a/typedoc/en/lib/directives/IgxLayoutDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/layout/IgxLayoutDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxLayoutDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/layout/IgxLayoutDirective.json diff --git a/typedoc/en/lib/directives/IMaskEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/mask/IMaskEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/IMaskEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/mask/IMaskEventArgs.json diff --git a/typedoc/en/lib/directives/IgxMaskDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/mask/IgxMaskDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxMaskDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/mask/IgxMaskDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json new file mode 100644 index 00000000..5d4719d4 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json @@ -0,0 +1,282 @@ +{ + "IgxRadioGroupDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxRadioModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-radio-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "radiogroup, radio, button, input", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": "The Ignite UI Radio Group allows the user to select a single option from an available set of options that are listed side by side.", + "tagName": "remarks" + } + }, + "example:": { + "comment": { + "text": [ + "```html", + "", + " ", + " {{item}}", + " ", + "", + "```" + ], + "tagName": "example:" + } + } + }, + "shortText": "Radio group directive renders set of radio buttons." + }, + "properties": { + "radioButtons": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let radioButtons = this.radioGroup.radioButtons;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns reference to the child radio buttons." + } + }, + "change": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Provides references to the selected `IgxRadioComponent` and the `value` property as event arguments.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An event that is emitted after the radio group `value` is changed." + } + } + }, + "methods": { + "writeValue": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Checks whether the provided value is consistent to the current radio button.", + "If it is, the checked attribute will have value `true` and selected property will contain the selected `IgxRadioComponent`." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.radioGroup.writeValue('radioButtonValue');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets the \"checked\" property value on the radio input element." + } + } + }, + "accessors": { + "value": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `value` attribute." + } + }, + "setter": { + "comment": { + "shortText": "Sets/gets the `value` attribute." + } + } + }, + "name": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `name` attribute of the radio group component. All child radio buttons inherits this name." + } + }, + "setter": { + "comment": { + "shortText": "Sets/gets the `name` attribute of the radio group component. All child radio buttons inherits this name." + } + } + }, + "required": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, `required` will have value `false`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets whether the radio group is required." + } + }, + "setter": { + "comment": { + "shortText": "Sets/gets whether the radio group is required." + } + } + }, + "disabled": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "An @Input property that allows you to disable the radio group. By default it's false." + } + }, + "setter": { + "comment": { + "shortText": "An @Input property that allows you to disable the radio group. By default it's false." + } + } + }, + "labelPosition": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, `labelPosition` will have value `\"after\"`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the position of the `label` in the child radio buttons." + } + }, + "setter": { + "comment": { + "shortText": "Sets/gets the position of the `label` in the child radio buttons." + } + } + }, + "selected": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let selectedButton = this.radioGroup.selected;", + "this.radioGroup.selected = selectedButton;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the selected child radio button." + } + }, + "setter": { + "comment": { + "shortText": "Sets/gets the selected child radio button." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/directives/IgxRippleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/ripple/IgxRippleDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxRippleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/ripple/IgxRippleDirective.json diff --git a/typedoc/en/lib/directives/IActiveHighlightInfo.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/text-highlight/IActiveHighlightInfo.json similarity index 100% rename from typedoc/en/lib/directives/IActiveHighlightInfo.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/text-highlight/IActiveHighlightInfo.json diff --git a/typedoc/en/lib/directives/IgxTextHighlightDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/text-highlight/IgxTextHighlightDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxTextHighlightDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/text-highlight/IgxTextHighlightDirective.json diff --git a/typedoc/en/lib/directives/IgxTextSelectionDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/text-selection/IgxTextSelectionDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxTextSelectionDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/text-selection/IgxTextSelectionDirective.json diff --git a/typedoc/en/lib/directives/IgxOverlayOutletDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxOverlayOutletDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxOverlayOutletDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxOverlayOutletDirective.json diff --git a/typedoc/en/lib/directives/IgxToggleActionDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleActionDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxToggleActionDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleActionDirective.json diff --git a/typedoc/en/lib/directives/IgxToggleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxToggleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleDirective.json diff --git a/typedoc/en/lib/directives/ITooltipHideEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipHideEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/ITooltipHideEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipHideEventArgs.json diff --git a/typedoc/en/lib/directives/ITooltipShowEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipShowEventArgs.json similarity index 100% rename from typedoc/en/lib/directives/ITooltipShowEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipShowEventArgs.json diff --git a/typedoc/en/lib/directives/IgxTooltipDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxTooltipDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipDirective.json diff --git a/typedoc/en/lib/directives/IgxTooltipTargetDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipTargetDirective.json similarity index 100% rename from typedoc/en/lib/directives/IgxTooltipTargetDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipTargetDirective.json diff --git a/typedoc/en/lib/drop-down/DropDownActionKey.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/DropDownActionKey.json similarity index 100% rename from typedoc/en/lib/drop-down/DropDownActionKey.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/DropDownActionKey.json diff --git a/typedoc/en/lib/drop-down/IDropDownNavigationDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IDropDownNavigationDirective.json similarity index 100% rename from typedoc/en/lib/drop-down/IDropDownNavigationDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IDropDownNavigationDirective.json diff --git a/typedoc/en/lib/drop-down/ISelectionEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/ISelectionEventArgs.json similarity index 100% rename from typedoc/en/lib/drop-down/ISelectionEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/ISelectionEventArgs.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownBaseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownBaseDirective.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownBaseDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownBaseDirective.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownComponent.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownComponent.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownGroupComponent.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownGroupComponent.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownItemBaseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemBaseDirective.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownItemBaseDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemBaseDirective.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownItemComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemComponent.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownItemComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemComponent.json diff --git a/typedoc/en/lib/drop-down/IgxDropDownItemNavigationDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemNavigationDirective.json similarity index 100% rename from typedoc/en/lib/drop-down/IgxDropDownItemNavigationDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemNavigationDirective.json diff --git a/typedoc/en/lib/expansion-panel/IExpansionPanelEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IExpansionPanelEventArgs.json similarity index 100% rename from typedoc/en/lib/expansion-panel/IExpansionPanelEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IExpansionPanelEventArgs.json diff --git a/typedoc/en/lib/expansion-panel/IgxExpansionPanelBodyComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelBodyComponent.json similarity index 100% rename from typedoc/en/lib/expansion-panel/IgxExpansionPanelBodyComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelBodyComponent.json diff --git a/typedoc/en/lib/expansion-panel/IgxExpansionPanelComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelComponent.json similarity index 100% rename from typedoc/en/lib/expansion-panel/IgxExpansionPanelComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelComponent.json diff --git a/typedoc/en/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json similarity index 100% rename from typedoc/en/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json diff --git a/typedoc/en/lib/grids/IValueChangedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/IValueChangedEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IValueChangedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/IValueChangedEventArgs.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json new file mode 100644 index 00000000..99cf6f40 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json @@ -0,0 +1,3825 @@ +{ + "IgxGridBaseDirective": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands all rows." + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses all rows." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Should be run when changing DOM elements dimentions manually that affect the grid's size.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Recalculates grid width/height dimensions." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", + "If `headers` is enabled, it will use the column header (if any) instead of the column field." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`." + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "Get transactions service for the grid." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxGridCellComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridCellComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridCellComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridCellComponent.json diff --git a/typedoc/en/lib/grids/IgxGridStateDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json similarity index 77% rename from typedoc/en/lib/grids/IgxGridStateDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json index 47d23c78..684bbea8 100644 --- a/typedoc/en/lib/grids/IgxGridStateDirective.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json @@ -4,12 +4,14 @@ "methods": { "getState": { "comment": { + "returns": "Returns the serialized to JSON string IGridState object, or the non-serialized IGridState object.\n```html\n\n```\n```typescript\n@ViewChild(IgxGridStateDirective, { static: true }) public state;\nlet state = this.state.getState();\n```\n", "tags": {}, "shortText": "Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the `options` property." } }, "setState": { "comment": { + "returns": "\n```html\n\n```\n```typescript\n@ViewChild(IgxGridStateDirective, { static: true }) public state;\nthis.state.setState(gridState);\n```\n", "tags": {}, "shortText": "Restores grid features' state based on the IGridState object passed as an argument." } diff --git a/typedoc/en/lib/grids/IgxRowDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/IgxRowDirective.json similarity index 100% rename from typedoc/en/lib/grids/IgxRowDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/IgxRowDirective.json diff --git a/typedoc/en/lib/grids/IgxColumnComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnComponent.json diff --git a/typedoc/en/lib/grids/IgxColumnGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnGroupComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnGroupComponent.json diff --git a/typedoc/en/lib/grids/IgxColumnLayoutComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnLayoutComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnLayoutComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/columns/IgxColumnLayoutComponent.json diff --git a/typedoc/en/lib/grids/GridType.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/GridType.json similarity index 100% rename from typedoc/en/lib/grids/GridType.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/GridType.json diff --git a/typedoc/en/lib/grids/IColumnMovingEndEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEndEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IColumnMovingEndEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEndEventArgs.json diff --git a/typedoc/en/lib/grids/IColumnMovingEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IColumnMovingEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEventArgs.json diff --git a/typedoc/en/lib/grids/IColumnMovingStartEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingStartEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IColumnMovingStartEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnMovingStartEventArgs.json diff --git a/typedoc/en/lib/grids/IColumnResizeEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnResizeEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IColumnResizeEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IColumnResizeEventArgs.json diff --git a/typedoc/en/lib/grids/IGridCellEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridCellEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IGridCellEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridCellEventArgs.json diff --git a/typedoc/en/lib/grids/IGridEditEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridEditEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IGridEditEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridEditEventArgs.json diff --git a/typedoc/en/lib/grids/IGridKeydownEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridKeydownEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IGridKeydownEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridKeydownEventArgs.json diff --git a/typedoc/en/lib/grids/IGridToolbarExportEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridToolbarExportEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IGridToolbarExportEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IGridToolbarExportEventArgs.json diff --git a/typedoc/en/lib/grids/IPageEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IPageEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IPageEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IPageEventArgs.json diff --git a/typedoc/en/lib/grids/IPinColumnEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IPinColumnEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IPinColumnEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IPinColumnEventArgs.json diff --git a/typedoc/en/lib/grids/IRowDataEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDataEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IRowDataEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDataEventArgs.json diff --git a/typedoc/en/lib/grids/IRowDragEndEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDragEndEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IRowDragEndEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDragEndEventArgs.json diff --git a/typedoc/en/lib/grids/IRowDragStartEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDragStartEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IRowDragStartEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowDragStartEventArgs.json diff --git a/typedoc/en/lib/grids/IRowSelectionEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowSelectionEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IRowSelectionEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowSelectionEventArgs.json diff --git a/typedoc/en/lib/grids/IRowToggleEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowToggleEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IRowToggleEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/common/IRowToggleEventArgs.json diff --git a/typedoc/en/lib/grids/IgxAdvancedFilteringDialogComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/filtering/advanced-filtering/IgxAdvancedFilteringDialogComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxAdvancedFilteringDialogComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/filtering/advanced-filtering/IgxAdvancedFilteringDialogComponent.json diff --git a/typedoc/en/lib/grids/IgxGridExcelStyleFilteringComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/filtering/excel-style/IgxGridExcelStyleFilteringComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridExcelStyleFilteringComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/filtering/excel-style/IgxGridExcelStyleFilteringComponent.json diff --git a/typedoc/en/lib/grids/IGroupingDoneEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IGroupingDoneEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IGroupingDoneEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IGroupingDoneEventArgs.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json new file mode 100644 index 00000000..10884c24 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json @@ -0,0 +1,4471 @@ +{ + "IgxGridComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxGridModule", + "tagName": "igxmodule" + } + }, + "igxgroup": { + "comment": { + "text": "Grids & Lists", + "tagName": "igxgroup" + } + }, + "igxkeywords": { + "comment": { + "text": "grid, table", + "tagName": "igxkeywords" + } + }, + "igxtheme": { + "comment": { + "text": "igx-grid-theme", + "tagName": "igxtheme" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Grid is used for presenting and manipulating tabular data in the simplest way possible. Once data", + "has been bound, it can be manipulated through filtering, sorting & editing operations." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " ", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Grid provides a way to present and manipulate tabular data." + }, + "properties": { + "groupsExpanded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default rendered state is expanded.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether created groups are rendered expanded or collapsed." + } + }, + "groupsRecords": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let groupRecords = this.grid.groupsRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the hierarchical representation of the group by records." + } + }, + "dropAreaTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "", + " Custom drop area! ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the template that will be rendered as a GroupBy drop area." + } + }, + "onGroupingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "The `onGroupingDone` event would be raised only once if several columns get grouped at once by calling", + "the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.", + "The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain", + "the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation.", + "Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last**", + "grouping/ungrouping operation), not all columns which are currently grouped/ungrouped.", + "columns." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when columns are grouped/ungrouped." + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "groupBy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.", + "The onGroupingDone event would get raised only **once** if this method gets called multiple times with the same arguments." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "this.grid.groupBy([", + "{ fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },", + "{ fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },", + "{ fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }", + "]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one." + } + }, + "clearGrouping": { + "comment": { + "parameters": { + "name": { + "comment": { + "text": "Name of column or array of column names to be ungrouped." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "Clears all grouping in the grid, if no parameter is passed.", + "If a parameter is provided, clears grouping for a particular column or an array of columns." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearGrouping(); //clears all grouping", + "this.grid.clearGrouping(\"ID\"); //ungroups a single column", + "this.grid.clearGrouping([\"ID\", \"Column1\", \"Column2\"]); //ungroups multiple columns", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Clears grouping for particular column, array of columns or all columns." + } + }, + "isExpandedGroup": { + "comment": { + "parameters": { + "group": { + "comment": { + "text": "The group record." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "const expandedGroup = this.grid.isExpandedGroup(this.groupRow);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if a group is expanded or not." + } + }, + "toggleGroup": { + "comment": { + "parameters": { + "groupRow": { + "comment": { + "text": "The group record to toggle." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "const toggleExpGroup = this.grid.toggleGroup(this.groupRow);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the expansion state of a group." + } + }, + "fullyExpandGroup": { + "comment": { + "parameters": { + "groupRow": { + "comment": { + "text": "The group record to fully expand." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "this.grid.fullyExpandGroup(this.groupRow);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the specified group and all of its parent groups." + } + }, + "toggleAllGroupRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleAllGroupRows;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the expansion state of all group rows recursively." + } + }, + "getSelectedData": { + "comment": { + "tags": { + "inheritdoc": { + "comment": { + "tagName": "inheritdoc" + } + } + } + } + }, + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands all rows." + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses all rows." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Should be run when changing DOM elements dimentions manually that affect the grid's size.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Recalculates grid width/height dimensions." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not provided it will be automatically generated.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the value of the `id` attribute." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the value of the `id` attribute." + } + } + }, + "data": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the array of data that populates the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the array of data that populates the `IgxGridComponent`." + } + } + }, + "filteredData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let filteredData = this.grid.filteredData;", + "this.grid.filteredData = [...];", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets an array of objects containing the filtered data." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets an array of objects containing the filtered data." + } + } + }, + "totalItemCount": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This property is required for remote grid virtualization to function when it is bound to remote data.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const itemCount = this.grid1.totalItemCount;", + "this.grid1.totalItemCount = 55;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the total number of records in the data source." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the total number of records in the data source." + } + } + }, + "groupingExpressions": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the group by state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the group by state." + } + } + }, + "groupingExpansionState": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one (controlled through groupsExpanded and states that the user has changed.", + "Contains the expansion state (expanded: boolean) and the unique identifier for the group row (Array).", + "Supports two-way data binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of expansion states for group rows." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of expansion states for group rows." + } + } + }, + "hideGroupedColumns": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is \"false\"", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grouped columns should be hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the grouped columns should be hidden." + } + } + }, + "dropAreaMessage": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on." + } + } + }, + "groupsRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupList = this.grid.groupsRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the list of group rows." + } + } + }, + "groupRowTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const groupRowTemplate = this.grid.groupRowTemplate;", + "this.grid.groupRowTemplate = myRowTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the template reference for the group row." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the template reference for the group row." + } + } + }, + "groupAreaTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupAreaTemplate = this.grid.groupAreaTemplate;", + "this.grid.groupAreaTemplate = myAreaTemplate.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the template reference of the `IgxGridComponent`'s group area." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the template reference of the `IgxGridComponent`'s group area." + } + } + }, + "hasGroupableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupableGrid = this.grid.hasGroupableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has groupable columns." + } + } + }, + "dropAreaVisible": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dropVisible = this.grid.dropAreaVisible;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the grid's group by drop area is visible." + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "Get transactions service for the grid." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxGridExpandableCellComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridExpandableCellComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridExpandableCellComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridExpandableCellComponent.json diff --git a/typedoc/en/lib/grids/IgxGridGroupByRowComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridGroupByRowComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridGroupByRowComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridGroupByRowComponent.json diff --git a/typedoc/en/lib/grids/IgxGridRowComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridRowComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridRowComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/grid/IgxGridRowComponent.json diff --git a/typedoc/en/lib/grids/IColumnVisibilityChangedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hiding/IColumnVisibilityChangedEventArgs.json similarity index 100% rename from typedoc/en/lib/grids/IColumnVisibilityChangedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/hiding/IColumnVisibilityChangedEventArgs.json diff --git a/typedoc/en/lib/grids/IgxColumnHidingComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hiding/IgxColumnHidingComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnHidingComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/hiding/IgxColumnHidingComponent.json diff --git a/typedoc/en/lib/grids/IgxChildGridRowComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxChildGridRowComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxChildGridRowComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxChildGridRowComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json new file mode 100644 index 00000000..03927208 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json @@ -0,0 +1,3825 @@ +{ + "IgxHierarchicalGridBaseDirective": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands all rows." + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses all rows." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Should be run when changing DOM elements dimentions manually that affect the grid's size.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Recalculates grid width/height dimensions." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", + "If `headers` is enabled, it will use the column header (if any) instead of the column field." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`." + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "Get transactions service for the grid." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxHierarchicalGridCellComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridCellComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxHierarchicalGridCellComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridCellComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json new file mode 100644 index 00000000..69fe6d63 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json @@ -0,0 +1,3985 @@ +{ + "IgxHierarchicalGridComponent": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands all rows." + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses all rows." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Should be run when changing DOM elements dimentions manually that affect the grid's size.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Recalculates grid width/height dimensions." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", + "If `headers` is enabled, it will use the column header (if any) instead of the column field." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`." + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + } + }, + "data": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that lets you fill the `IgxHierarchicalGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns an array of data set to the `IgxHierarchicalGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + } + }, + "filteredData": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", + "```typescript", + "this.grid.filteredData = [{", + " ID: 1,", + " Name: \"A\"", + "}];", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + } + }, + "expandChildren": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.", + "Defult value is false.", + "```html", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Gets if all immediate children of the `IgxHierarchicalGridComponent` previously have been set to be expanded/collapsed.", + "If previously set and some rows have been manually expanded/collapsed it will still return the last set value.", + "```typescript", + "const expanded = this.grid.expandChildren;", + "```" + ] + } + } + }, + "foreignKey": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the", + "parent grid is set or an object reference of the parent record otherwise.", + "```typescript", + "const foreignKey = this.grid.foreignKey;", + "```" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "Get transactions service for the grid." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxHierarchicalRowComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalRowComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxHierarchicalRowComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalRowComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json new file mode 100644 index 00000000..86c2b123 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json @@ -0,0 +1,3888 @@ +{ + "IgxRowIslandComponent": { + "properties": { + "key": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets the key of the row island by which child data would be taken from the row data if such is provided.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "onGridCreated": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Event emmited when a grid is being created based on this row island.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands all rows." + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses all rows." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "If `formatters` is enabled, the cell value will be formatted by its respective column formatter (if any).", + "If `headers` is enabled, it will use the column header (if any) instead of the column field." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`." + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "expandChildren": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Gets if all immediate children of the grids for this `IgxRowIslandComponent` have been set to be expanded/collapsed.", + "```typescript", + "const expanded = this.rowIsland.expandChildren;", + "```" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "Get transactions service for the grid." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxColumnMovingDropDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/moving/IgxColumnMovingDropDirective.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnMovingDropDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/moving/IgxColumnMovingDropDirective.json diff --git a/typedoc/en/lib/grids/IgxColumnPinningComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnPinningComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningComponent.json diff --git a/typedoc/en/lib/grids/IgxColumnPinningItemDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningItemDirective.json similarity index 100% rename from typedoc/en/lib/grids/IgxColumnPinningItemDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningItemDirective.json diff --git a/typedoc/en/lib/grids/IgxGridSelectionService.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/selection/IgxGridSelectionService.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridSelectionService.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/selection/IgxGridSelectionService.json diff --git a/typedoc/en/lib/grids/IgxDateSummaryOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxDateSummaryOperand.json similarity index 100% rename from typedoc/en/lib/grids/IgxDateSummaryOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxDateSummaryOperand.json diff --git a/typedoc/en/lib/grids/IgxNumberSummaryOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxNumberSummaryOperand.json similarity index 100% rename from typedoc/en/lib/grids/IgxNumberSummaryOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxNumberSummaryOperand.json diff --git a/typedoc/en/lib/grids/IgxSummaryOperand.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxSummaryOperand.json similarity index 100% rename from typedoc/en/lib/grids/IgxSummaryOperand.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/summaries/IgxSummaryOperand.json diff --git a/typedoc/en/lib/grids/IgxGridToolbarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridToolbarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarComponent.json diff --git a/typedoc/en/lib/grids/IgxGridToolbarCustomContentDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarCustomContentDirective.json similarity index 100% rename from typedoc/en/lib/grids/IgxGridToolbarCustomContentDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarCustomContentDirective.json diff --git a/typedoc/en/lib/grids/IgxTreeGridCellComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridCellComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxTreeGridCellComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridCellComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json new file mode 100644 index 00000000..4c19d576 --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json @@ -0,0 +1,4213 @@ +{ + "IgxTreeGridComponent": { + "comment": { + "text": [ + "The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and", + "provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding.", + "Example:", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ], + "shortText": [ + "**Ignite UI for Angular Tree Grid** -", + "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" + ] + }, + "properties": { + "rootRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns an array of the root level `ITreeGridRecord`s.", + "```typescript", + "// gets the root record with index=2", + "const states = this.grid.rootRecords[2];", + "```" + ] + } + }, + "records": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns a map of all `ITreeGridRecord`s.", + "```typescript", + "// gets the record with primaryKey=2", + "const states = this.grid.records.get(2);", + "```" + ] + } + }, + "processedRootRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s.", + "```typescript", + "// gets the processed root record with index=2", + "const states = this.grid.processedRootRecords[2];", + "```" + ] + } + }, + "processedRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns a map of all processed (filtered and sorted) `ITreeGridRecord`s.", + "```typescript", + "// gets the processed record with primaryKey=2", + "const states = this.grid.processedRecords.get(2);", + "```" + ] + } + }, + "childDataKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that sets the child data key of the `IgxTreeGridComponent`.", + "```html", + "", + "```" + ] + } + }, + "foreignKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that sets the foreign key of the `IgxTreeGridComponent`.", + "```html", + "", + "", + "```" + ] + } + }, + "hasChildrenKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that sets the key indicating whether a row has children.", + "This property is only used for load on demand scenarios.", + "```html", + "", + "", + "```" + ] + } + }, + "cascadeOnDelete": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property indicating whether child records should be deleted when their parent gets deleted.", + "By default it is set to true and deletes all children along with the parent.", + "```html", + "", + "", + "```" + ] + } + }, + "loadChildrenOnDemand": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that provides a callback for loading child rows on demand.", + "```html", + "", + "", + "```", + "```typescript", + "public loadChildren = (parentID: any, done: (children: any[]) => void) => {", + " this.dataService.getData(parentID, children => done(children));", + "}", + "```" + ] + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether to autogenerate the columns." + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when empty." + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom template when loading." + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after filtering is performed." + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the advanced filtering expressions tree.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted after advanced filtering is performed." + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a custom `ng-template` for the pagination UI of the grid." + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid." + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid." + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the primary key." + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This will allow to bind the grid to remote data and having auto-generated columns at the same time.", + "Note that after generating the columns, this property would be disabled to avoid re-creating", + "columns each time a new data is assigned." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the built-in column hiding UI." + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the title to be displayed in the UI of the column pinning." + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Provides a callback for loading unique column values on demand.", + "If this property is provided, the unique values it generates will be used by the Excel Style Filtering." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a unique values strategy used by the Excel Style Filtering" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is clicked." + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " Returns the `IgxGridCellComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxGridCellComponent` is selected." + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " Emitted when `IgxGridRowComponent` is selected." + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The index that the column is inserted at may be changed through the `insertAtIndex` property.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when `IgxColumnComponent` is pinned." + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(e.g. `Esc` key was pressed)", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when editing and **not** submitting the value." + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell enters edit mode." + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Event is fired after editing is completed, when the cell is exiting edit mode.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when cell has been edited." + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\".", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row enters edit mode." + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emitted when [rowEditable]=\"true\" & `endEdit(true)` is called.", + "Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row,", + "performing paging operation, column resizing, pinning, moving or hitting `Done`", + "button inside of the rowEditingOverlay, or hitting the `Enter` key while editing a cell.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when exiting edit mode for a row." + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Emits when [rowEditable]=\"true\" & `endEdit(false)` is called.", + "Emitted when changing hitting `Esc` key during cell editing and when click on the `Cancel` button", + "in the row editing overlay.", + "This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when row editing is canceled." + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the column object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a column is initialized." + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expression.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when sorting is performed through the UI." + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the filtering expressions tree of the column for which filtering was performed.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when filtering is performed through the UI." + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when paging is performed." + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the data for the new `IgxGridRowComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row added through the API." + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an `IRowDataEventArgs` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a new chunk of data is loaded from virtualization." + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxColumnComponent` object's old and new width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column is resized." + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Returns the `IgxGridCellComponent` object.", + "```html", + "", + "```" + ], + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a cell is right clicked." + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the `IgxGridCellComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when a cell is double clicked." + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Args: { column: any, newValue: boolean }", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column visibility is changed." + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the moved `IgxColumnComponent` object.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving starts." + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects. This event is cancelable.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted during the column moving operation." + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the source and target `IgxColumnComponent` objects.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when column moving ends." + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This event is fired only if the key combination is supported in the grid.", + "Return the target type, target object and the original event. This event is cancelable." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when keydown is triggered over element inside grid's body." + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dragged row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when start dragging a row." + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when dropping a row." + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when a copy operation is executed." + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when the expanded state of a row gets changed." + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the filtered grid is empty." + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A template reference for the template when the grid is empty." + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row expand indicator." + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a row collapse indicator." + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header expand indicator." + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering a header collapse indicator." + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns the sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted before sorting is performed." + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides access to the `IgxToolbarComponent`." + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Emitted when an export process is initiated by the user." + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Range selection can be made either through drag selection or through keyboard selection.", + "tagName": "remarks" + } + } + }, + "shortText": "Emitted when making a range selection." + } + } + }, + "methods": { + "expandAll": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Expands all rows.", + "```typescript", + "this.grid.expandAll();", + "```" + ] + } + }, + "collapseAll": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Collapses all rows.", + "```typescript", + "this.grid.collapseAll();", + "```" + ] + } + }, + "addRow": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created", + "row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches", + "the specified parentRowID. If the parentRowID does not exist, an error would be thrown.", + "```typescript", + "const record = {", + " ID: this.grid.data[this.grid1.data.length - 1].ID + 1,", + " Name: this.newRecord", + "};", + "this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1.", + "```" + ] + } + }, + "getSelectedData": { + "comment": { + "tags": { + "inheritdoc": { + "comment": { + "tagName": "inheritdoc" + } + } + } + } + }, + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the specified column's visibility." + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Expands the row by its id." + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Collapses the row by its id." + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "The row id - primaryKey value or the data record instance." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID is either the primaryKey value or the data record instance.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the row by its id." + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`." + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxColumnComponent` by field name." + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxRowDirective` by index." + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns `IgxGridRowComponent` object by the specified primary key ." + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the `IgxGridCellComponent` that matches the conditions." + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "match any rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the primaryKey property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an `IgxGridCellComponent` object by the specified primary key and column field." + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the next page, if the grid is not already at the last page." + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the previous page, if the grid is not already at the first page." + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Moves a column to the specified drop target." + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Goes to the desired page index." + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Manually marks the `IgxGridComponent` for change detection." + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Requires that the `primaryKey` property is set.", + "The method accept rowSelector as a parameter, which is the rowID." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "the new value which is to be set." + } + }, + "rowSelector": { + "comment": { + "text": "corresponds to rowID." + } + }, + "column": { + "comment": { + "text": "corresponds to column field." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Requires that the `primaryKey` property is set.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key." + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "The row is specified by", + "rowSelector parameter and the data source record with the passed value.", + "This method will apply requested update only if primary key is specified in the grid." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Updates the `IgxGridRowComponent`" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sort a single `IgxColumnComponent`." + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters a single `IgxColumnComponent`." + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition." + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If you do not provide the customSummary, then the default summary for the column data type will be applied.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Enables summaries for the specified column and applies your customSummary." + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Disable summaries for the listed columns.", + "tagName": "remarks" + } + } + }, + "shortText": "Disable summaries for the specified column." + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Otherwise clears the filtering state of all `IgxColumnComponent`s.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`." + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "otherwise clears the sorting state of all `IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`." + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns whether the operation is successful.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Pins a column by field name." + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Unpins a column by field name. Returns whether the operation is successful." + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Should be run when changing DOM elements dimentions manually that affect the grid's size.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Recalculates grid width/height dimensions." + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "the string to search." + } + }, + "caseSensitive": { + "comment": { + "text": "optionally, if the search should be case sensitive (defaults to false)." + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the string.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible." + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns how many times the grid contains the last search.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Reapplies the existing search." + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Removes all the highlights in the cell." + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "If we should take into account the hidden columns in the pinned area." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets calculated width of the pinned area." + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "Returns an array with selected rows' IDs (primaryKey or rowData)", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get current selection state." + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "if true clears the current selection" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Select specified rows by ID." + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselect specified rows by ID." + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Selects all rows" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows.", + "If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Deselects all rows" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also can execute a custom logic over the target element,", + "through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Navigates to a posution in the grid based on provided `rowindex` and `visibleColumnIndex`." + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the next cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "You can pass callback function as a third parameter of `getPreviousCell` method.", + "The callback function accepts IgxColumnComponent as a param" + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Returns `ICellPosition` which defines the previous cell,", + "according to the current position, that match specific criteria." + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If `commit === true`, passes them from the pending state to the data (or transaction service)", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Finishes the row transactions on the current row." + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "Opens the advanced filtering dialog." + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "indicates whether the changes should be applied" + } + } + }, + "tags": {}, + "shortText": "Closes the advanced filtering dialog." + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + } + }, + "data": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + } + }, + "filteredData": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Returns an array of objects containing the filtered data in the `IgxGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + }, + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "Sets an array of objects containing the filtered data in the `IgxGridComponent`.", + "```typescript", + "this.grid.filteredData = [{", + " ID: 1,", + " Name: \"A\"", + "}];", + "```" + ] + } + } + }, + "transactions": { + "getter": { + "comment": { + "tags": { + "experimental": { + "comment": { + "text": "@hidden", + "tagName": "experimental" + } + } + }, + "shortText": "Get transactions service for the grid." + } + } + }, + "expansionDepth": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "shortText": [ + "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", + "set to `Infinity` which means all levels would be expanded.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", + "set to `Infinity` which means all levels would be expanded.", + "```html", + "", + "```" + ] + } + } + }, + "rowLoadingIndicatorTemplate": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "memberof" + } + } + }, + "text": [ + "", + "", + "```" + ], + "shortText": [ + "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", + "```html", + "", + " loop", + "" + ] + } + }, + "setter": { + "comment": { + "text": [ + "", + "", + "```" + ], + "shortText": [ + "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", + "```html", + "", + " loop", + "" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it uses EN resources.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the resource strings." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the resource strings." + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is AND.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering logic of the `IgxGridComponent`." + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering state." + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the advanced filtering state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the advanced filtering state." + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, returns browser's language.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the locale." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the locale." + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default state is disabled (false).", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the paging feature is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the paging feature is enabled." + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way binding.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the current page index." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the current page index." + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default is 15.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the number of visible items per page." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the number of visible items per page." + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the column hiding UI is enabled." + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " By default row selectors are shown", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets if the row selectors are hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the row selectors are hidden." + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether rows can be moved." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether rows can be moved." + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default it is set to false.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the rows are editable." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the rows are editable." + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the height." + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the width of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the width of the grid." + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the width of the header." + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the row height." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the row height." + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the default width of the columns." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the default width of the columns." + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Get/Sets the message displayed when there are no records." + } + }, + "getter": { + "comment": { + "shortText": "Get/Sets the message displayed when there are no records." + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets whether the grid is going to show a loading indicator." + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed when there are no records and the grid is filtered." + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Allows to apply pinning the columns to the start or the end.", + "Note that pinning to both sides at a time is not allowed." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the initial pinning configuration." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the initial pinning configuration." + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the built-in column pinning UI should be shown in the toolbar." + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets if the filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets if the filtering is enabled." + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a value indicating whether the advanced filtering is enabled." + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it's set to FilterMode.quickFilter.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the filter mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filter mode." + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is bottom.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary position." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary position." + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + }, + "remarks": { + "comment": { + "text": "By default it is rootAndChildLevels which means the summaries are calculated for the root level and each child level.", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets the summary calculation mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the summary calculation mode." + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the filtering strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the filtering strategy of the grid." + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting strategy of the grid." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting strategy of the grid." + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderGroupComponent`." + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridHeaderComponent`." + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of all `IgxGridFilteringCellComponent`." + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of `IgxGridRowComponent`." + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "A list of currently rendered `IgxGridRowComponent`'s." + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the template which will be used by the toolbar to show custom content." + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + }, + "setter": { + "comment": { + "shortText": "The custom template, if any, that should be used when rendering the row drag indicator icon" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the sorting state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the sorting state." + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the number of hidden columns." + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column hiding UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Used for the built-in column pinning UI of the`IgxColumnComponent`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the text to be displayed inside the toggle button." + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether the toolbar is shown." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the toolbar is shown." + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the toolbar's title." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the toolbar's title." + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether exporting to MS Excel is enabled or disabled." + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets whether the option for exporting to CSV is enabled or disabled.", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the main export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the main export button." + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "Gets/Sets the textual content for the MS Excel export button.", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets the textual content for the CSV export button." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the textual content for the CSV export button." + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the cell selection mode is multiple", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets cell selection mode." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets cell selection mode." + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default the row selection mode is none", + "tagName": "remarks" + } + } + }, + "shortText": "Gets/Sets row selection mode" + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets row selection mode" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one.", + "Supports two-way binding." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of key-value pairs [row ID, expansion state]." + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the native element." + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the default row height." + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Used internally for restricting header group component width.", + "The values below depend on the header cell default right/left padding values." + ], + "tagName": "remarks" + } + } + }, + "shortText": "Returns the `IgxGridHeaderGroupComponent`'s minimum allowed width." + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the current width of the container for the unpinned `IgxColumnComponent`s." + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of `IgxColumnComponent`s." + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of the pinned `IgxColumnComponent`s." + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets an array of unpinned `IgxColumnComponent`s." + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of visible `IgxColumnComponent`s." + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the total number of pages." + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets if the current page is the first page." + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Only functions when paging is enabled.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total number of records." + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the current page is the last page." + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the total width of the `IgxGridComponent`." + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has sortable columns." + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has editable columns." + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has fiterable columns." + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has summarized columns." + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has moveable columns." + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column groups." + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has column layouts for multi-row layout definition." + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array of the selected `IgxGridCellComponent`s." + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the currently transformed paged/filtered/sorted/grouped data, displayed in the grid." + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns an array containing the filtered sorted data." + } + }, + "setter": { + "comment": { + "shortText": "Returns an array containing the filtered sorted data." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/grids/IgxTreeGridRowComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridRowComponent.json similarity index 100% rename from typedoc/en/lib/grids/IgxTreeGridRowComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridRowComponent.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json new file mode 100644 index 00000000..4512093a --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json @@ -0,0 +1,285 @@ +{ + "IgxIconComponent": { + "properties": { + "ariaHidden": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", + "constructor(private cdRef:ChangeDetectorRef) {}", + "ngAfterViewInit() {", + " this.icon.ariaHidden = false;", + " this.cdRef.detectChanges();", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " This allows you to disable the `aria-hidden` attribute. By default it's applied." + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An @Input property that sets the value of the `id` attribute." + } + }, + "font": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An @Input property that sets the value of the `fontSet`. By default it's \"material\"." + } + }, + "active": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An @Input property that allows you to disable the `active` property. By default it's applied." + } + }, + "iconColor": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An @Input property that allows you to change the `iconColor` of the icon." + } + }, + "iconName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An @Input property that allows you to set the `iconName` of the icon." + } + }, + "el": { + "comment": { + "shortText": "An ElementRef property of the `igx-icon` component." + } + } + }, + "methods": {}, + "accessors": { + "getFontSet": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconFont = this.icon.getFontSet;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns the value of the font property." + } + } + }, + "getActive": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconActive = this.icon.getActive;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns the value of the active property." + } + } + }, + "getInactive": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconActive = this.icon.getInactive;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns inactive property." + } + } + }, + "getIconColor": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconColor = this.icon.getIconColor;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns the opposite value of the `iconColor` property." + } + } + }, + "getIconName": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconName = this.icon.getIconName;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns the value of the iconName property." + } + } + }, + "getSvgKey": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let svgKey = this.icon.getSvgKey;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + " An accessor that returns the key of the SVG image.", + " The key consists of the fontSet and the iconName separated by underscore." + ] + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconTemplate = this.icon.template;", + "}", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": " An accessor that returns a TemplateRef to explicit, svg or no ligature." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/icon/IgxIconService.json b/typedoc/en/projects/igniteui-angular/src/lib/icon/IgxIconService.json similarity index 100% rename from typedoc/en/lib/icon/IgxIconService.json rename to typedoc/en/projects/igniteui-angular/src/lib/icon/IgxIconService.json diff --git a/typedoc/en/lib/input-group/IgxInputGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/input-group/IgxInputGroupComponent.json similarity index 100% rename from typedoc/en/lib/input-group/IgxInputGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/input-group/IgxInputGroupComponent.json diff --git a/typedoc/en/lib/list/IListItemClickEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json similarity index 69% rename from typedoc/en/lib/list/IListItemClickEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json index 7225121e..cccb12cd 100644 --- a/typedoc/en/lib/list/IListItemClickEventArgs.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json @@ -1,5 +1,8 @@ { "IListItemClickEventArgs": { + "comment": { + "shortText": "Interface for the listItemClick igxList event arguments" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/en/lib/list/IListItemPanningEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json similarity index 69% rename from typedoc/en/lib/list/IListItemPanningEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json index 08f30a2c..841fc853 100644 --- a/typedoc/en/lib/list/IListItemPanningEventArgs.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json @@ -1,5 +1,8 @@ { "IListItemPanningEventArgs": { + "comment": { + "shortText": "Interface for the listItemPanning igxList event arguments" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/en/lib/list/IPanStateChangeEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json similarity index 69% rename from typedoc/en/lib/list/IPanStateChangeEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json index 425f25fa..0afdb9c1 100644 --- a/typedoc/en/lib/list/IPanStateChangeEventArgs.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json @@ -1,5 +1,8 @@ { "IPanStateChangeEventArgs": { + "comment": { + "shortText": "Interface for the panStateChange igxList event arguments" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/en/lib/list/IgxListActionDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListActionDirective.json similarity index 100% rename from typedoc/en/lib/list/IgxListActionDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListActionDirective.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListComponent.json new file mode 100644 index 00000000..1fe543bf --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListComponent.json @@ -0,0 +1,567 @@ +{ + "IgxListComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxListModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-list-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "list, data", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Grids & Lists", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI List displays rows of items and supports one or more header items as well as search and filtering", + "of list items. Each list item is completely templatable and will support any valid HTML or Angular component." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " Contacts", + " ", + " {{ contact.name }}", + " {{ contact.phone }}", + " ", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Displays a collection of data items in a templatable list format" + }, + "properties": { + "children": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listChildren: QueryList = this.list.children;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns a collection of all items and headers in the list." + } + }, + "emptyListTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "This template is used by IgxList in case there are no list items", + "defined and `isLoading` is set to `false`." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

No contacts! :(

", + " ", + "", + "```", + "```typescript", + "let emptyTemplate = this.list.emptyListTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the empty list template." + } + }, + "dataLoadingTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This template is used by IgxList in case there are no list items defined and `isLoading` is set to `true`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

Patience, we are currently loading your data...

", + " ", + "", + "```", + "```typescript", + "let loadingTemplate = this.list.dataLoadingTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the list loading template." + } + }, + "listItemLeftPanningTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default value is `null`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " deleteDelete", + " ", + "", + "```", + "```typescript", + "let itemLeftPanTmpl = this.list.listItemLeftPanningTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the template for left panning a list item." + } + }, + "listItemRightPanningTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default value is `null`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " callDial", + " ", + "", + "```", + "```typescript", + "let itemRightPanTmpl = this.list.listItemRightPanningTemplate;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the template for right panning a list item." + } + }, + "panEndTriggeringThreshold": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "By default this property is set to 0.5 which is 50% of the list item's width.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Provides a threshold after which the item's panning will be completed automatically." + } + }, + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not set, the `id` of the first list component will be `\"igx-list-0\"`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let listId = this.list.id;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `id` of the list." + } + }, + "allowLeftPanning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default value is `false`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isLeftPanningAllowed = this.list.allowLeftPanning;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets whether the left panning of an item is allowed." + } + }, + "allowRightPanning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Default value is `false`.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRightPanningAllowed = this.list.allowRightPanning;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets whether the right panning of an item is allowed." + } + }, + "isLoading": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Set it to display the dataLoadingTemplate while data is being retrieved.", + "Default value is `false`." + ], + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```", + "```typescript", + "let isLoading = this.list.isLoading;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets whether the list is currently loading data." + } + }, + "onLeftPan": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Provides a reference to an object of type `IListItemPanningEventArgs` as an event argument.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Event emitted when a left pan gesture is executed on a list item." + } + }, + "onRightPan": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Provides a reference to an object of type `IListItemPanningEventArgs` as an event argument.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Event emitted when a right pan gesture is executed on a list item." + } + }, + "onPanStateChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Provides references to the `IgxListItemComponent` and `IgxListPanState` as event arguments.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Event emitted when a pan gesture is executed on a list item." + } + }, + "onItemClicked": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Provides references to the `IgxListItemComponent` and `Event` as event arguments.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Event emitted when a list item is clicked." + } + } + }, + "methods": {}, + "accessors": { + "role": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listRole = this.list.role;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the `role` attribute value." + } + } + }, + "isListEmpty": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isEmpty = this.list.isListEmpty;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets a boolean indicating if the list is empty." + } + } + }, + "items": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listItems: IgxListItemComponent[] = this.list.items;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the list `items` excluding the header ones." + } + } + }, + "headers": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listHeaders: IgxListItemComponent[] = this.list.headers;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the header list `items`." + } + } + }, + "context": { + "getter": { + "comment": { + "tags": { + "remark": { + "comment": { + "text": [ + "Gets the `context` object which represents the `template context` binding into the `list container`", + "by providing the `$implicit` declaration which is the `IgxListComponent` itself." + ], + "tagName": "remark" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let listComponent = this.list.context;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets the `context` object of the template binding." + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listTemplate = this.list.template;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Gets a `TemplateRef` to the currently used template." + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "Returns the theme of the component.", + "The default theme is `comfortable`.", + "Available options are `comfortable`, `cosy`, `compact`.", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "Sets the theme of the component." + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/en/lib/list/IgxListItemComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListItemComponent.json similarity index 100% rename from typedoc/en/lib/list/IgxListItemComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListItemComponent.json diff --git a/typedoc/en/lib/list/IgxListLineDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineDirective.json similarity index 100% rename from typedoc/en/lib/list/IgxListLineDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineDirective.json diff --git a/typedoc/en/lib/list/IgxListLineSubTitleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineSubTitleDirective.json similarity index 100% rename from typedoc/en/lib/list/IgxListLineSubTitleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineSubTitleDirective.json diff --git a/typedoc/en/lib/list/IgxListLineTitleDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineTitleDirective.json similarity index 100% rename from typedoc/en/lib/list/IgxListLineTitleDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListLineTitleDirective.json diff --git a/typedoc/en/lib/list/IgxListThumbnailDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/list/IgxListThumbnailDirective.json similarity index 100% rename from typedoc/en/lib/list/IgxListThumbnailDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/list/IgxListThumbnailDirective.json diff --git a/typedoc/en/lib/navbar/IgxActionIconDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/navbar/IgxActionIconDirective.json similarity index 100% rename from typedoc/en/lib/navbar/IgxActionIconDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/navbar/IgxActionIconDirective.json diff --git a/typedoc/en/lib/navbar/IgxNavbarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/navbar/IgxNavbarComponent.json similarity index 100% rename from typedoc/en/lib/navbar/IgxNavbarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/navbar/IgxNavbarComponent.json diff --git a/typedoc/en/lib/navigation-drawer/IgxNavigationDrawerComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/navigation-drawer/IgxNavigationDrawerComponent.json similarity index 100% rename from typedoc/en/lib/navigation-drawer/IgxNavigationDrawerComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/navigation-drawer/IgxNavigationDrawerComponent.json diff --git a/typedoc/en/lib/paginator/IgxPaginatorComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/paginator/IgxPaginatorComponent.json similarity index 100% rename from typedoc/en/lib/paginator/IgxPaginatorComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/paginator/IgxPaginatorComponent.json diff --git a/typedoc/en/lib/progressbar/BaseProgress.json b/typedoc/en/projects/igniteui-angular/src/lib/progressbar/BaseProgress.json similarity index 100% rename from typedoc/en/lib/progressbar/BaseProgress.json rename to typedoc/en/projects/igniteui-angular/src/lib/progressbar/BaseProgress.json diff --git a/typedoc/en/lib/progressbar/IChangeProgressEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/progressbar/IChangeProgressEventArgs.json similarity index 100% rename from typedoc/en/lib/progressbar/IChangeProgressEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/progressbar/IChangeProgressEventArgs.json diff --git a/typedoc/en/lib/progressbar/IgxCircularProgressBarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/progressbar/IgxCircularProgressBarComponent.json similarity index 100% rename from typedoc/en/lib/progressbar/IgxCircularProgressBarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/progressbar/IgxCircularProgressBarComponent.json diff --git a/typedoc/en/lib/progressbar/IgxLinearProgressBarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/progressbar/IgxLinearProgressBarComponent.json similarity index 100% rename from typedoc/en/lib/progressbar/IgxLinearProgressBarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/progressbar/IgxLinearProgressBarComponent.json diff --git a/typedoc/en/lib/radio/IChangeRadioEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/radio/IChangeRadioEventArgs.json similarity index 100% rename from typedoc/en/lib/radio/IChangeRadioEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/radio/IChangeRadioEventArgs.json diff --git a/typedoc/en/lib/radio/IgxRadioComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/radio/IgxRadioComponent.json similarity index 100% rename from typedoc/en/lib/radio/IgxRadioComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/radio/IgxRadioComponent.json diff --git a/typedoc/en/lib/select/IgxSelectComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectComponent.json similarity index 100% rename from typedoc/en/lib/select/IgxSelectComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectComponent.json diff --git a/typedoc/en/lib/select/IgxSelectGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectGroupComponent.json similarity index 100% rename from typedoc/en/lib/select/IgxSelectGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectGroupComponent.json diff --git a/typedoc/en/lib/select/IgxSelectItemComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectItemComponent.json similarity index 100% rename from typedoc/en/lib/select/IgxSelectItemComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/select/IgxSelectItemComponent.json diff --git a/typedoc/en/lib/services/CsvFileTypes.json b/typedoc/en/projects/igniteui-angular/src/lib/services/csv/CsvFileTypes.json similarity index 100% rename from typedoc/en/lib/services/CsvFileTypes.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/csv/CsvFileTypes.json diff --git a/typedoc/en/lib/services/ICsvExportEndedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/csv/ICsvExportEndedEventArgs.json similarity index 100% rename from typedoc/en/lib/services/ICsvExportEndedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/csv/ICsvExportEndedEventArgs.json diff --git a/typedoc/en/lib/services/IgxCsvExporterOptions.json b/typedoc/en/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterOptions.json similarity index 100% rename from typedoc/en/lib/services/IgxCsvExporterOptions.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterOptions.json diff --git a/typedoc/en/lib/services/IgxCsvExporterService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterService.json similarity index 100% rename from typedoc/en/lib/services/IgxCsvExporterService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterService.json diff --git a/typedoc/en/lib/services/IExcelExportEndedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/excel/IExcelExportEndedEventArgs.json similarity index 100% rename from typedoc/en/lib/services/IExcelExportEndedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/excel/IExcelExportEndedEventArgs.json diff --git a/typedoc/en/lib/services/IgxExcelExporterOptions.json b/typedoc/en/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterOptions.json similarity index 100% rename from typedoc/en/lib/services/IgxExcelExporterOptions.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterOptions.json diff --git a/typedoc/en/lib/services/IgxExcelExporterService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterService.json similarity index 100% rename from typedoc/en/lib/services/IgxExcelExporterService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterService.json diff --git a/typedoc/en/lib/services/IColumnExportingEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IColumnExportingEventArgs.json similarity index 100% rename from typedoc/en/lib/services/IColumnExportingEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IColumnExportingEventArgs.json diff --git a/typedoc/en/lib/services/IRowExportingEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IRowExportingEventArgs.json similarity index 100% rename from typedoc/en/lib/services/IRowExportingEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IRowExportingEventArgs.json diff --git a/typedoc/en/lib/services/IgxBaseExporter.json b/typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IgxBaseExporter.json similarity index 100% rename from typedoc/en/lib/services/IgxBaseExporter.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IgxBaseExporter.json diff --git a/typedoc/en/lib/services/IgxExporterOptionsBase.json b/typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IgxExporterOptionsBase.json similarity index 100% rename from typedoc/en/lib/services/IgxExporterOptionsBase.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/exporter-common/IgxExporterOptionsBase.json diff --git a/typedoc/en/lib/services/IgxOverlayService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json similarity index 96% rename from typedoc/en/lib/services/IgxOverlayService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json index a84a10df..fd5fde9b 100644 --- a/typedoc/en/lib/services/IgxOverlayService.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json @@ -83,6 +83,7 @@ "methods": { "attach": { "comment": { + "returns": "Id of the created overlay. Valid until `onClosed` is emitted.\n", "parameters": { "component": { "comment": { @@ -109,6 +110,7 @@ }, "show": { "comment": { + "returns": "Id of the created overlay. Valid until `onClosed` is emitted.\n```typescript\nthis.overlay.show(element, settings);\n```", "parameters": { "component": { "comment": { diff --git a/typedoc/en/lib/services/OverlayAnimationEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayAnimationEventArgs.json similarity index 100% rename from typedoc/en/lib/services/OverlayAnimationEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayAnimationEventArgs.json diff --git a/typedoc/en/lib/services/OverlayCancelableEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayCancelableEventArgs.json similarity index 100% rename from typedoc/en/lib/services/OverlayCancelableEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayCancelableEventArgs.json diff --git a/typedoc/en/lib/services/OverlayClosingEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayClosingEventArgs.json similarity index 100% rename from typedoc/en/lib/services/OverlayClosingEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayClosingEventArgs.json diff --git a/typedoc/en/lib/services/OverlayEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayEventArgs.json similarity index 100% rename from typedoc/en/lib/services/OverlayEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlayEventArgs.json diff --git a/typedoc/en/lib/services/OverlaySettings.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlaySettings.json similarity index 100% rename from typedoc/en/lib/services/OverlaySettings.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/OverlaySettings.json diff --git a/typedoc/en/lib/services/PositionSettings.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/PositionSettings.json similarity index 100% rename from typedoc/en/lib/services/PositionSettings.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/PositionSettings.json diff --git a/typedoc/en/lib/services/Size.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/Size.json similarity index 100% rename from typedoc/en/lib/services/Size.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/Size.json diff --git a/typedoc/en/lib/services/AutoPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/AutoPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/AutoPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/AutoPositionStrategy.json diff --git a/typedoc/en/lib/services/BaseFitPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/BaseFitPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/BaseFitPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/BaseFitPositionStrategy.json diff --git a/typedoc/en/lib/services/ConnectedPositioningStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ConnectedPositioningStrategy.json similarity index 100% rename from typedoc/en/lib/services/ConnectedPositioningStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ConnectedPositioningStrategy.json diff --git a/typedoc/en/lib/services/ContainerPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ContainerPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/ContainerPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ContainerPositionStrategy.json diff --git a/typedoc/en/lib/services/ElasticPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ElasticPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/ElasticPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/ElasticPositionStrategy.json diff --git a/typedoc/en/lib/services/GlobalPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/GlobalPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/GlobalPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/GlobalPositionStrategy.json diff --git a/typedoc/en/lib/services/IPositionStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/IPositionStrategy.json similarity index 100% rename from typedoc/en/lib/services/IPositionStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/position/IPositionStrategy.json diff --git a/typedoc/en/lib/services/AbsoluteScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/AbsoluteScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/AbsoluteScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/AbsoluteScrollStrategy.json diff --git a/typedoc/en/lib/services/BlockScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/BlockScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/BlockScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/BlockScrollStrategy.json diff --git a/typedoc/en/lib/services/CloseScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/CloseScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/CloseScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/CloseScrollStrategy.json diff --git a/typedoc/en/lib/services/IScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/IScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/IScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/IScrollStrategy.json diff --git a/typedoc/en/lib/services/NoOpScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/NoOpScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/NoOpScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/NoOpScrollStrategy.json diff --git a/typedoc/en/lib/services/ScrollStrategy.json b/typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/ScrollStrategy.json similarity index 100% rename from typedoc/en/lib/services/ScrollStrategy.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/overlay/scroll/ScrollStrategy.json diff --git a/typedoc/en/lib/services/IgxBaseTransactionService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json similarity index 90% rename from typedoc/en/lib/services/IgxBaseTransactionService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json index f3f02921..a3f6f8ba 100644 --- a/typedoc/en/lib/services/IgxBaseTransactionService.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json @@ -16,6 +16,7 @@ }, "getTransactionLog": { "comment": { + "returns": "All transaction in the service or for the specified record\n", "tags": {}, "shortText": "Returns all recorded transactions in chronological order" } @@ -32,6 +33,7 @@ }, "getAggregatedChanges": { "comment": { + "returns": "Collection of aggregated transactions for each changed record\n", "tags": {}, "shortText": "Returns aggregated changes from all transactions" } @@ -49,6 +51,7 @@ }, "getAggregatedValue": { "comment": { + "returns": "Value with changes or **null**\n", "tags": {}, "shortText": "Returns value of the required id including all uncommitted changes" } @@ -87,6 +90,7 @@ "canRedo": { "getter": { "comment": { + "returns": "if there are any transactions in the Redo stack\n", "tags": { "inheritdoc": { "comment": { @@ -100,6 +104,7 @@ "canUndo": { "getter": { "comment": { + "returns": "if there are any transactions in the Undo stack\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/en/lib/services/IgxHierarchicalTransactionService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json similarity index 92% rename from typedoc/en/lib/services/IgxHierarchicalTransactionService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json index b7c0064b..191980c7 100644 --- a/typedoc/en/lib/services/IgxHierarchicalTransactionService.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json @@ -59,18 +59,21 @@ }, "getTransactionLog": { "comment": { + "returns": "All transaction in the service or for the specified record\n", "tags": {}, "shortText": "Returns all recorded transactions in chronological order" } }, "getState": { "comment": { + "returns": "State of the record if any\n", "tags": {}, "shortText": "Returns the state of the record with provided id" } }, "getAggregatedValue": { "comment": { + "returns": "Value with changes or **null**\n", "tags": {}, "shortText": "Returns value of the required id including all uncommitted changes" } @@ -113,6 +116,7 @@ "canUndo": { "getter": { "comment": { + "returns": "if there are any transactions in the Undo stack\n", "tags": { "inheritdoc": { "comment": { @@ -126,6 +130,7 @@ "canRedo": { "getter": { "comment": { + "returns": "if there are any transactions in the Redo stack\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/en/lib/services/IgxTransactionService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json similarity index 89% rename from typedoc/en/lib/services/IgxTransactionService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json index 071aec49..8fa964f0 100644 --- a/typedoc/en/lib/services/IgxTransactionService.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json @@ -16,24 +16,28 @@ }, "getTransactionLog": { "comment": { + "returns": "All transaction in the service or for the specified record\n", "tags": {}, "shortText": "Returns all recorded transactions in chronological order" } }, "getAggregatedChanges": { "comment": { + "returns": "Collection of aggregated transactions for each changed record\n", "tags": {}, "shortText": "Returns aggregated changes from all transactions" } }, "getState": { "comment": { + "returns": "State of the record if any\n", "tags": {}, "shortText": "Returns the state of the record with provided id" } }, "getAggregatedValue": { "comment": { + "returns": "Value with changes or **null**\n", "tags": {}, "shortText": "Returns value of the required id including all uncommitted changes" } @@ -82,6 +86,7 @@ "canUndo": { "getter": { "comment": { + "returns": "if there are any transactions in the Undo stack\n", "tags": { "inheritdoc": { "comment": { @@ -95,6 +100,7 @@ "canRedo": { "getter": { "comment": { + "returns": "if there are any transactions in the Redo stack\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/en/lib/services/TransactionService.json b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json similarity index 95% rename from typedoc/en/lib/services/TransactionService.json rename to typedoc/en/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json index 440cd903..ae615f72 100644 --- a/typedoc/en/lib/services/TransactionService.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json @@ -57,6 +57,7 @@ }, "getTransactionLog": { "comment": { + "returns": "All transaction in the service or for the specified record\n", "parameters": { "id": { "comment": { @@ -80,6 +81,7 @@ }, "getAggregatedChanges": { "comment": { + "returns": "Collection of aggregated transactions for each changed record\n", "parameters": { "mergeChanges": { "comment": { @@ -96,6 +98,7 @@ }, "getState": { "comment": { + "returns": "State of the record if any\n", "parameters": { "id": { "comment": { @@ -114,6 +117,7 @@ }, "getAggregatedValue": { "comment": { + "returns": "Value with changes or **null**\n", "parameters": { "id": { "comment": { diff --git a/typedoc/en/lib/slider/IgxSliderComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/IgxSliderComponent.json similarity index 100% rename from typedoc/en/lib/slider/IgxSliderComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/IgxSliderComponent.json diff --git a/typedoc/en/lib/slider/IgxSliderType.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/IgxSliderType.json similarity index 100% rename from typedoc/en/lib/slider/IgxSliderType.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/IgxSliderType.json diff --git a/typedoc/en/lib/slider/IgxThumbFromTemplateDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/IgxThumbFromTemplateDirective.json similarity index 100% rename from typedoc/en/lib/slider/IgxThumbFromTemplateDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/IgxThumbFromTemplateDirective.json diff --git a/typedoc/en/lib/slider/IgxThumbToTemplateDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/IgxThumbToTemplateDirective.json similarity index 100% rename from typedoc/en/lib/slider/IgxThumbToTemplateDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/IgxThumbToTemplateDirective.json diff --git a/typedoc/en/lib/slider/IgxTickLabelTemplateDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/IgxTickLabelTemplateDirective.json similarity index 100% rename from typedoc/en/lib/slider/IgxTickLabelTemplateDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/IgxTickLabelTemplateDirective.json diff --git a/typedoc/en/lib/slider/TickLabelsOrientation.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/TickLabelsOrientation.json similarity index 100% rename from typedoc/en/lib/slider/TickLabelsOrientation.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/TickLabelsOrientation.json diff --git a/typedoc/en/lib/slider/TicksOrientation.json b/typedoc/en/projects/igniteui-angular/src/lib/slider/TicksOrientation.json similarity index 100% rename from typedoc/en/lib/slider/TicksOrientation.json rename to typedoc/en/projects/igniteui-angular/src/lib/slider/TicksOrientation.json diff --git a/typedoc/en/lib/snackbar/IgxSnackbarComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/snackbar/IgxSnackbarComponent.json similarity index 100% rename from typedoc/en/lib/snackbar/IgxSnackbarComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/snackbar/IgxSnackbarComponent.json diff --git a/typedoc/en/lib/switch/IChangeSwitchEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/switch/IChangeSwitchEventArgs.json similarity index 100% rename from typedoc/en/lib/switch/IChangeSwitchEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/switch/IChangeSwitchEventArgs.json diff --git a/typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json new file mode 100644 index 00000000..1df3454f --- /dev/null +++ b/typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json @@ -0,0 +1,397 @@ +{ + "IgxSwitchComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxSwitchModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-switch-theme, igx-tooltip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "switch, states, tooltip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": "The Ignite UI Switch lets the user toggle between on/off or true/false states.", + "tagName": "remarks" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " Simple switch", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "The Switch component is a binary choice selection component." + }, + "properties": { + "nativeCheckbox": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let checkboxElement = this.switch.nativeCheckbox;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns a reference to the native checkbox element." + } + }, + "nativeLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let labelElement = this.switch.nativeLabel;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns reference to the native label element." + } + }, + "placeholderLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let labelPlaceholder = this.switch.placeholderLabel;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns reference to the label placeholder element." + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `id` of the switch component.", + "If not set, the `id` of the first switch component will be `\"igx-switch-0\"`." + ] + } + }, + "labelId": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the id of the `label` element of the switch component.", + "If not set, the label of the first switch component will have value `\"igx-switch-0-label\"`." + ] + } + }, + "value": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `value` attribute of the switch component." + } + }, + "name": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the `name` attribute of the switch component." + } + }, + "tabindex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the value of the `tabindex` attribute." + } + }, + "labelPosition": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the position of the `label` in the switch component.", + "If not set, `labelPosition` will have value `\"after\"`." + ] + } + }, + "disableRipple": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Enables/Disables the ripple effect", + "If not set, `disableRipple` will have value `false`." + ] + } + }, + "required": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether switch is required.", + "If not set, `required` will have value `false`." + ] + } + }, + "ariaLabelledBy": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `aria-labelledBy` attribute.", + "If not set, the value of `aria-labelledBy` will be equal to the value of `labelId` attribute." + ] + } + }, + "ariaLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Sets/gets the value of the `aria-label` attribute." + } + }, + "change": { + "comment": { + "shortText": [ + "An event that is emitted after the switch state is changed.", + "Provides references to the `IgxSwitchComponent` and the `checked` property as event arguments." + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let switchClass = this.switch.cssClass;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Returns the class of the switch component." + } + }, + "checked": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the switch is on or off.", + "Default value is 'false'." + ] + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets the `disabled` attribute.", + "Default value is `false`." + ] + } + }, + "focused": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.switch.focused = true;", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": [ + "Sets/gets whether the switch component is on focus.", + "Default value is `false`." + ] + } + } + }, + "methods": { + "toggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.switch.toggle();", + "```" + ], + "tagName": "example" + } + } + }, + "shortText": "Toggles the checked state of the switch." + } + } + }, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/en/lib/switch/IgxSwitchRequiredDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json similarity index 74% rename from typedoc/en/lib/switch/IgxSwitchRequiredDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json index 2b336463..42e60aa4 100644 --- a/typedoc/en/lib/switch/IgxSwitchRequiredDirective.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json @@ -1,19 +1,6 @@ { "IgxSwitchRequiredDirective": { - "properties": { - "required": { - "comment": { - "tags": { - "description": { - "comment": { - "text": "Tracks changes to the required attribute bound to this directive.", - "tagName": "description" - } - } - } - } - } - }, + "properties": {}, "methods": { "validate": { "comment": { @@ -50,6 +37,24 @@ } } }, - "accessors": {} + "accessors": { + "required": { + "getter": { + "comment": { + "tags": { + "description": { + "comment": { + "text": "Tracks changes to the required attribute bound to this directive.", + "tagName": "description" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } } } \ No newline at end of file diff --git a/typedoc/en/lib/tabbar/ISelectTabEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/tabbar/ISelectTabEventArgs.json similarity index 100% rename from typedoc/en/lib/tabbar/ISelectTabEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabbar/ISelectTabEventArgs.json diff --git a/typedoc/en/lib/tabbar/IgxBottomNavComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxBottomNavComponent.json similarity index 100% rename from typedoc/en/lib/tabbar/IgxBottomNavComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxBottomNavComponent.json diff --git a/typedoc/en/lib/tabbar/IgxTabComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxTabComponent.json similarity index 100% rename from typedoc/en/lib/tabbar/IgxTabComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxTabComponent.json diff --git a/typedoc/en/lib/tabbar/IgxTabPanelComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxTabPanelComponent.json similarity index 100% rename from typedoc/en/lib/tabbar/IgxTabPanelComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabbar/IgxTabPanelComponent.json diff --git a/typedoc/en/lib/tabs/IgxTabItemComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabItemComponent.json similarity index 100% rename from typedoc/en/lib/tabs/IgxTabItemComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabItemComponent.json diff --git a/typedoc/en/lib/tabs/IgxTabsComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabsComponent.json similarity index 100% rename from typedoc/en/lib/tabs/IgxTabsComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabsComponent.json diff --git a/typedoc/en/lib/tabs/IgxTabsGroupComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabsGroupComponent.json similarity index 100% rename from typedoc/en/lib/tabs/IgxTabsGroupComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/tabs/IgxTabsGroupComponent.json diff --git a/typedoc/en/lib/time-picker/IgxTimePickerActionsDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerActionsDirective.json similarity index 100% rename from typedoc/en/lib/time-picker/IgxTimePickerActionsDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerActionsDirective.json diff --git a/typedoc/en/lib/time-picker/IgxTimePickerComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerComponent.json similarity index 100% rename from typedoc/en/lib/time-picker/IgxTimePickerComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerComponent.json diff --git a/typedoc/en/lib/time-picker/IgxTimePickerTemplateDirective.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerTemplateDirective.json similarity index 100% rename from typedoc/en/lib/time-picker/IgxTimePickerTemplateDirective.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerTemplateDirective.json diff --git a/typedoc/en/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json similarity index 100% rename from typedoc/en/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json diff --git a/typedoc/en/lib/time-picker/IgxTimePickerValueChangedEventArgs.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValueChangedEventArgs.json similarity index 100% rename from typedoc/en/lib/time-picker/IgxTimePickerValueChangedEventArgs.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValueChangedEventArgs.json diff --git a/typedoc/en/lib/time-picker/TimeDisplayFormatPipe.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimeDisplayFormatPipe.json similarity index 100% rename from typedoc/en/lib/time-picker/TimeDisplayFormatPipe.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimeDisplayFormatPipe.json diff --git a/typedoc/en/lib/time-picker/TimeInputFormatPipe.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimeInputFormatPipe.json similarity index 100% rename from typedoc/en/lib/time-picker/TimeInputFormatPipe.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimeInputFormatPipe.json diff --git a/typedoc/en/lib/time-picker/TimePickerHammerConfig.json b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json similarity index 96% rename from typedoc/en/lib/time-picker/TimePickerHammerConfig.json rename to typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json index ad20f45f..a1f10d01 100644 --- a/typedoc/en/lib/time-picker/TimePickerHammerConfig.json +++ b/typedoc/en/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json @@ -25,6 +25,7 @@ "methods": { "buildHammer": { "comment": { + "returns": "A HammerJS event-manager object.\n", "parameters": { "element": { "comment": { diff --git a/typedoc/en/lib/toast/IgxToastComponent.json b/typedoc/en/projects/igniteui-angular/src/lib/toast/IgxToastComponent.json similarity index 100% rename from typedoc/en/lib/toast/IgxToastComponent.json rename to typedoc/en/projects/igniteui-angular/src/lib/toast/IgxToastComponent.json diff --git a/typedoc/en/lib/toast/IgxToastPosition.json b/typedoc/en/projects/igniteui-angular/src/lib/toast/IgxToastPosition.json similarity index 100% rename from typedoc/en/lib/toast/IgxToastPosition.json rename to typedoc/en/projects/igniteui-angular/src/lib/toast/IgxToastPosition.json diff --git a/typedoc/ja/globalFunctions.json b/typedoc/ja/globalFunctions.json index 84aeedf0..ec11bb65 100644 --- a/typedoc/ja/globalFunctions.json +++ b/typedoc/ja/globalFunctions.json @@ -15,6 +15,7 @@ }, "monthRange": { "comment": { + "returns": "\n", "tags": { "export": { "comment": { @@ -27,6 +28,7 @@ }, "isLeap": { "comment": { + "returns": "\n", "tags": { "export": { "comment": { diff --git a/typedoc/ja/lib/badge/IgxBadgeComponent.json b/typedoc/ja/lib/badge/IgxBadgeComponent.json deleted file mode 100644 index eb429370..00000000 --- a/typedoc/ja/lib/badge/IgxBadgeComponent.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "IgxBadgeComponent": { - "comment": { - "text": [ - "Ignite UI Badge は、視覚的な通知が必要な場合にアプリケーションでアバター、ナビゲーション メニュー、またはその他のコンポーネントをデコレートするために使用されます。", - "情報、成功、警告、またはエラーを表示するために定義済みのスタイルを持つアイコンとしてデザインされます。", - "", - "例:", - "```html", - "", - " ", - " ", - "", - "```", - "`badge-style` クラスはバッジを配置するために使用されます。", - "```css", - ".badge-style {", - " position: absolute;", - " bottom: -6px;", - " right:-50px;", - "}", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Badge** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/badge.html)" - ] - }, - "properties": { - "id": { - "comment": { - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "type": { - "comment": { - "shortText": [ - "バッジのタイプを制御する @Input プロパティ。", - "有効な値は `primary`、`info`、`success`、`warning`、または `error` です。", - "無効な値を設定すると、バッジは表示されません。", - "```html", - "", - "```" - ] - } - }, - "value": { - "comment": { - "shortText": [ - "バッジで表示する値を設定する @Input プロパティ。", - "`icon` プロパティが設定される場合、`icon` が表示されます。", - "`value` および `icon` が設定されない場合、バッジのコンテンツは空になります。", - "```html", - "", - "```" - ] - } - }, - "icon": { - "comment": { - "shortText": [ - "マテリアル アイコン セットからバッジのアイコンを設定します。", - "`value` プロパティより優先されます。", - "`value` および `icon` が設定されない場合、バッジのコンテンツは空になります。", - "無効な値を設定すると、コンテンツは表示されません。", - "```html", - "", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "role 属性に値を設定します。", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.label = \"badge-status\";", - "```" - ] - } - }, - "cssClass": { - "comment": { - "shortText": [ - "igx-badge クラスを無効にできます。デフォルトでクラスが適用されます。", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.cssClass = false;", - "```" - ] - } - }, - "label": { - "comment": { - "shortText": [ - "aria-label 属性に値を設定します。", - "```html", - "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", - "public badge: IgxBadgeComponent;", - "//...", - "badge.label = \"icon-badge\";", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/card/IgxCardComponent.json b/typedoc/ja/lib/card/IgxCardComponent.json deleted file mode 100644 index 73fd8815..00000000 --- a/typedoc/ja/lib/card/IgxCardComponent.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "IgxCardComponent": { - "properties": { - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCardComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カードの `id` を取得または設定します。", - "設定しない場合、`id` は値 `\"igx-card-0\"` を持ちます。", - "```html", - "", - "```", - "```typescript", - "let cardId = this.card.id;", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "カードの `role` 属性の値を設定する @Input プロパティ。", - "デフォルトで値が `group` に設定されています。", - "```html", - "", - "```" - ] - } - }, - "type": { - "comment": { - "shortText": [ - "カードの `type` 属性の値を設定する @Input プロパティ。", - "デフォルトで値が `default` に設定されています。値を `outlined` に設定してカードでアウトライン スタイルを使用します。", - "```html", - "", - "```" - ] - } - }, - "horizontal": { - "comment": { - "shortText": [ - "カードの `horizontal` 属性の値を設定する @Input プロパティ。", - "これを `true` に設定すると、異なるカード セクションが水平に並ぶようになり、カードを横に反転します。", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "isOutlinedCard": { - "getter": { - "comment": { - "shortText": "カード型が `アウトライン` の場合に true を返すゲッター。" - } - } - } - } - } -} diff --git a/typedoc/ja/lib/card/IgxCardFooterDirective.json b/typedoc/ja/lib/card/IgxCardFooterDirective.json deleted file mode 100644 index ea6a537f..00000000 --- a/typedoc/ja/lib/card/IgxCardFooterDirective.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "IgxCardFooterDirective": { - "comment": { - "shortText":"IgxCardFooter はカード フッターのコンテナです。" - }, - "properties": { - "role": { - "comment": { - "shortText": [ - "カード フッターの `role` 属性の値を設定する @Input プロパティ。", - "デフォルトで値が `footer` に設定されています。", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} diff --git a/typedoc/ja/lib/card/IgxCardHeaderComponent.json b/typedoc/ja/lib/card/IgxCardHeaderComponent.json deleted file mode 100644 index 92596e88..00000000 --- a/typedoc/ja/lib/card/IgxCardHeaderComponent.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "IgxCardHeaderComponent": { - "comment": { - "shortText": "IgxCardHeader はカード ヘッダーのコンテナです。" - }, - "properties": { - "vertical": { - "comment": { - "shortText": [ - "ヘッダーのレイアウト スタイルを設定する @Input プロパティ。", - "デフォルトでは、ヘッダ要素 (サムネイルとタイトル/サブタイトル) は水平に配置されています。", - "```html", - "", - "```" - ] - } - }, - "role": { - "comment": { - "shortText": [ - "カード ヘッダーの `role` 属性の値を設定する @Input プロパティ。", - "デフォルトで値が `header` に設定されています。", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/card/IgxCardType.json b/typedoc/ja/lib/card/IgxCardType.json deleted file mode 100644 index 9670262a..00000000 --- a/typedoc/ja/lib/card/IgxCardType.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "IgxCardType": { - "comment": { - "text": [ - "Ignite UI Card は、カスタム コンテンツを配置するコンテナです。 コンテンツを配置するため、カードに 5 つのセクションがあります。 それらはヘッダー、メディア、コンテンツ、アクションおよびフッターです。", - "例:", - "```html", - "", - " ", - "

{{title}}

", - "
{{subtitle}}
", - " ", - " ", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Card** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/card.html)" - ] - }, - "members": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/checkbox/IgxCheckboxComponent.json b/typedoc/ja/lib/checkbox/IgxCheckboxComponent.json deleted file mode 100644 index dc961622..00000000 --- a/typedoc/ja/lib/checkbox/IgxCheckboxComponent.json +++ /dev/null @@ -1,479 +0,0 @@ -{ - "IgxCheckboxComponent": { - "comment": { - "text": [ - "Ignite UI Checkbox は、バイナリの選択を可能にする選択コントロールです。", - "ネイティブ ブラウザーのチェックボックスと同様に動作します。", - "例:", - "```html", - "", - " simple checkbox", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Checkbox** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/checkbox.html)" - ] - }, - "properties": { - "nativeCheckbox": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ネイティブ チェックボックス要素への参照を返します。", - "```typescript", - "let checkboxElement = this.checkbox.checkboxElement;", - "```" - ] - } - }, - "nativeLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ネイティブ ラベル要素への参照を返します。", - "```typescript", - "let labelElement = this.checkbox.nativeLabel;", - "```" - ] - } - }, - "placeholderLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラベル プレースホルダー要素への参照を返します。", - "```typescript", - "let labelPlaceholder = this.checkbox.placeholderLabel;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックス コンポーネントの `id` を取得または設定します。", - "設定されない場合、最初のチェックボックス コンポーネントの `id` は `\"igx-checkbox-0\"` になります。", - "```html", - "", - "```", - "```typescript", - "let checkboxId = this.checkbox.id;", - "```" - ] - } - }, - "labelId": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`label` 要素の id を取得または設定します。", - "設定されない場合、最初のチェックボックス コンポーネントの `label` の id は `\"igx-checkbox-0-label\"` になります。", - "```html", - "", - "```", - "```typescript", - "let labelId = this.checkbox.labelId;", - "```" - ] - } - }, - "value": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`value` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let value = this.checkbox.value;", - "```" - ] - } - }, - "name": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`name` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let name = this.checkbox.name;", - "```" - ] - } - }, - "tabindex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "属性の値を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let tabIndex = this.checkbox.tabindex;", - "```" - ] - } - }, - "labelPosition": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - " `label` の位置を取得または設定します。", - " 設定しない場合、`labelPosition` は値 `\"after\"` を持ちます。", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.checkbox.labelPosition;", - "```" - ] - } - }, - "disableRipple": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リップル エフェクトを有効または無効にします。", - "設定されない場合、`disableRipple` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRippleDisabled = this.checkbox.desableRipple;", - "```" - ] - } - }, - "required": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックスが必須かどうかを取得または設定します。", - "設定されない場合、`required` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.checkbox.required;", - "```" - ] - } - }, - "ariaLabelledBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`aria-labelledby` 属性を取得または設定します。", - "設定されない場合、`aria-labelledby` は `labelId` 属性の値と等しくなります。", - "```html", - "", - "```", - "```typescript", - "let ariaLabelledBy = this.checkbox.ariaLabelledBy;", - "```" - ] - } - }, - "ariaLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`aria-label` 属性の値を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let ariaLabel = this.checkbox.aruaLabel;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックス状態が変更された後に発生するイベント。", - "イベント引数として `IgxCheckboxComponent` および `checked` プロパティへの参照を提供します。" - ] - } - }, - "cssClass": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックス コンポーネントのクラスを返します。", - "```typescript", - "let class = this.checkbox.cssClass;", - "```" - ] - } - }, - "focused": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックス コンポーネントがフォーカスされるかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```typescript", - "this.checkbox.focused = true;", - "```", - "```typescript", - "let isFocused = this.checkbox.focused;", - "```" - ] - } - }, - "indeterminate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックスの不確定ビジュアル ステートを取得または設定します。", - "デフォルトの値は `false`　です。", - "```html", - "", - "```", - "```typescript", - "let isIndeterminate = this.checkbox.indeterminate;", - "```" - ] - } - }, - "checked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックスがチェックされたかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```html", - "", - "```", - "```typescript", - "let isChecked = this.checkbox.checked;", - "```" - ] - } - }, - "disabled": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックスが無効されたかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```html", - "", - "```", - "```typescript", - "let isDisabled = this.checkbox.disabled;", - "```" - ] - } - }, - "readonly": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "チェックボックスが ReadOnly かどうかを取得または設定します。", - "デフォルト値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let readonly = this.checkbox.readonly;", - "```" - ] - } - }, - "disableTransitions": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "Checkbox は すべての css トランジションを無効に設定するかどうかを取得または設定します。", - "デフォルト値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let disableTransitions = this.checkbox.disableTransitions;", - "```" - ] - } - } - }, - "methods": { - "toggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxCheckboxComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`disabled` が `false` の場合、`checked` 状態を切り替えます。", - "```typescript", - "this.checkbox.toggle();", - "```" - ] - } - } - }, - "accessors": {} - } -} diff --git a/typedoc/ja/lib/chips/IgxChipComponent.json b/typedoc/ja/lib/chips/IgxChipComponent.json deleted file mode 100644 index da54b111..00000000 --- a/typedoc/ja/lib/chips/IgxChipComponent.json +++ /dev/null @@ -1,347 +0,0 @@ -{ - "IgxChipComponent": { - "properties": { - "id": { - "comment": { - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - }, - "data": { - "comment": { - "shortText": [ - "チップに関連するデータを保存する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "draggable": { - "comment": { - "shortText": [ - "`IgxChipComponent` の位置を変更するためにドラッグできるかどうかを定義する @Input プロパティ。", - "デフォルトで false に設定されます。", - "```html", - "", - "```" - ] - } - }, - "animateOnRelease": { - "comment": { - "shortText": [ - "要素が解放されたときにドラッグ可能な要素のアニメーションを有効/無効にする @Input プロパティ。", - "デフォルトで true に設定されます。", - "```html", - "", - "```" - ] - } - }, - "hideBaseOnDrag": { - "comment": { - "shortText": [ - "ドラッグされた基本要素の非表示を有効または無効にする @Input プロパティ。", - "デフォルトで true に設定されます。", - "```html", - "", - "```" - ] - } - }, - "removable": { - "comment": { - "shortText": [ - "`IgxChipComponent` が [削除] ボタンを描画し、削除イベントを発生するかどうかを定義する @Input プロパティ。", - "デフォルトで false に設定されます。", - "```html", - "", - "```" - ] - } - }, - "removeIcon": { - "comment": { - "shortText": [ - "チップが削除ボタンに適用するデフォルト アイコンをオーバーライドする @Input プロパティ。", - "```html", - "", - "delete", - "```" - ] - } - }, - "selectable": { - "comment": { - "shortText": [ - "`IgxChipComponent` がクリックまたはナビゲーションで選択可能かどうかを定義する @Input プロパティ。", - "デフォルトで false に設定されます。", - "```html", - "", - "```" - ] - } - }, - "selectIcon": { - "comment": { - "shortText": [ - "選択時にチップが適用するデフォルト アイコンをオーバーライドする @Input プロパティ。 ", - "```html", - "", - "done_outline", - "```" - ] - } - }, - "disabled": { - "comment": { - "shortText": [ - "`IgxChipComponent` が無効かどうかを定義する @Input プロパティ。", - "無効な場合、クリックまたはタブでフォーカス、クリックまたはスペースで選択、ドラッグなどのユーザー インタラクションを制限します。", - "デフォルトで false に設定されます。", - "```html", - "", - "```" - ] - } - }, - "onMoveStart": { - "comment": { - "shortText": [ - "`IgxChipComponent` の移動が開始するときにイベントを発生します。", - "移動している `IgxChipComponent` を返します。", - "```typescript", - "moveStarted(event: IBaseChipEventArgs){", - " let movingChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onMoveEnd": { - "comment": { - "shortText": [ - "`IgxChipComponent` の移動が終了するときにイベントを発生します。", - "移動した `IgxChipComponent` を返します。", - "```typescript", - "moveEnded(event: IBaseChipEventArgs){", - " let movedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRemove": { - "comment": { - "shortText": [ - "`IgxChipComponent` が削除されたときにイベントを発生します。", - "Returns the removed `IgxChipComponent`.", - "```typescript", - "remove(event: IBaseChipEventArgs){", - " let removedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onClick": { - "comment": { - "shortText": [ - "`IgxChipComponent` がクリックされたときにイベントを発生します。", - "クリックした `IgxChipComponent` およびイベントをキャンセルするかどうかを返します。", - "```typescript", - "chipClick(event: IChipClickEventArgs){", - " let clickedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onSelection": { - "comment": { - "shortText": [ - "`IgxChipComponent` が選択/選択解除されたときにイベントを発生します。", - "選択したチップへの参照、イベントをキャンセルするかどうか、次の選択状態を返します。", - "イベントがインタラクションでトリガーされた場合に `originalEvent` が提供されます。それ以外の場合、`originalEvent` は `null` です。", - "```typescript", - "chipSelect(event: IChipSelectEventArgs){", - " let selectedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onSelectionDone": { - "comment": { - "shortText": [ - "`IgxChipComponent` が選択/選択解除され、関連するアニメーションとトランジションが終了すると、イベントが発生します。", - "```typescript", - "chipSelectEnd(event: IBaseChipEventArgs){", - " let selectedChip = event.owner;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onKeyDown": { - "comment": { - "shortText": [ - "`IgxChipComponent` のキーボード ナビゲーションが使用されるときにイベントを発生します。", - "フォーカス/選択した `IgxChipComponent`、イベントをキャンセルするかどうかを返します。", - "`Alt、shift、control`、`shift`、`control` キーが押されていてキー名が押されたかどうか。", - "```typescript", - "chipKeyDown(event: IChipKeyDownEventArgs){", - " let keyDown = event.key;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDragEnter": { - "comment": { - "shortText": [ - "`IgxChipComponent` が `IgxChipsAreaComponent` に入ったときにイベントを発生します。", - "ターゲットの `IgxChipComponent`、ドラッグしている `IgxChipComponent`、および元のドロップ イベント引数を返します。", - "", - "```typescript", - "chipEnter(event: IChipEnterDragAreaEventArgs){", - " let targetChip = event.targetChip;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "dragDirective": { - "comment": { - "shortText": [ - "`IgxChipComponent` がドラッグ動作のために使う `IgxDragDirective` の参照を含むプロパティ。", - "```html", - "", - "```", - "```typescript", - "onMoveStart(event: IBaseChipEventArgs){", - " let dragDirective = event.owner.dragDirective;", - "}", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "selected": { - "setter": { - "comment": { - "text": [ - "双方向データ バインディング:", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxChipComponent` の選択状態を設定します。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "text": [ - "双方向データ バインディング:", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxChipComponent` が選択されるかどうかを返します。", - "```typescript", - "@ViewChild('myChip')", - "public chip: IgxChipComponent;", - "selectedChip(){", - " let selectedChip = this.chip.selected;", - "}", - "```" - ] - } - } - }, - "color": { - "setter": { - "comment": { - "shortText": [ - "`IgxChipComponent` の背景色を設定する @Input プロパティ。", - "`color` プロパティは文字列、rgb、および16 進数をサポートします。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": [ - "`IgxChipComponent` の背景色を返します。", - "```typescript", - "@ViewChild('myChip')", - "public chip: IgxChipComponent;", - "ngAfterViewInit(){", - " let chipColor = this.chip.color;", - "}", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/chips/IgxChipsAreaComponent.json b/typedoc/ja/lib/chips/IgxChipsAreaComponent.json deleted file mode 100644 index e6cbbe0e..00000000 --- a/typedoc/ja/lib/chips/IgxChipsAreaComponent.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "IgxChipsAreaComponent": { - "properties": { - "width": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` の幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "height": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` の高さを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "onReorder": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` で `IgxChipComponent` の順序が変更されたときにイベントを発生します。", - "`IgxChipComponent` の配列を返します。", - "```html", - "", - "```", - "```typescript", - "public changedOrder(event: IChipsAreaReorderEventArgs){", - " let chips: IgxChipComponent[] = event.chipsArray;", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` で `IgxChipComponent` が選択されたときにイベントを発生します。", - "初期時に選択されたチップがある場合もチップ領域が初期化された後に発生されます。", - "選択済み `IgxChipComponents` の配列および `IgxChipAreaComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public selection(event: IChipsAreaSelectEventArgs){", - " let selectedChips: IgxChipComponent[] = event.newSelection;", - "}" - ] - } - }, - "onMoveStart": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` で `IgxChipComponent` が移動されたときにイベントを発生します。", - "```html", - "", - "```", - "```typescript", - "moveStart(event: IBaseChipsAreaEventArgs){", - " let chipArea = event.owner;", - "}", - "```" - ] - } - }, - "onMoveEnd": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` で `IgxChipComponent` が移動された後にイベントを発生します。", - "```html", - "", - "```", - "```typescript", - "moveEnd(event: IBaseChipsAreaEventArgs){", - " let chipArea = event.owner;", - "}", - "```" - ] - } - }, - "chipsList": { - "comment": { - "shortText": [ - "`IgxChipsAreaComponent` で `IgxChipComponent` を含みます。", - "```typescript", - "ngAfterViewInit(){", - " let chips = this.chipsArea.chipsList;", - "}", - "```" - ] - } - } - }, - "methods": {}, - "accessors": {} - } -} diff --git a/typedoc/ja/lib/data-operations/SortingDirection.json b/typedoc/ja/lib/data-operations/SortingDirection.json deleted file mode 100644 index 62ceaa37..00000000 --- a/typedoc/ja/lib/data-operations/SortingDirection.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "SortingDirection": { - "comment": { - "shortText": "並べ替え式を表します。" - }, - "members": {} - } -} diff --git a/typedoc/ja/lib/date-picker/IgxDatePickerComponent.json b/typedoc/ja/lib/date-picker/IgxDatePickerComponent.json deleted file mode 100644 index 4ccddd45..00000000 --- a/typedoc/ja/lib/date-picker/IgxDatePickerComponent.json +++ /dev/null @@ -1,721 +0,0 @@ -{ - "IgxDatePickerComponent": { - "comment": { - "text": [ - "Ignite UI Date Picker は、日付の単一選択が可能なポップアップ カレンダーを表示します。", - "例:", - "```html", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Date Picker** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/date_picker.html)" - ] - }, - "properties": { - "label": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` ラベルを設定する @Input プロパティ。", - "デフォルト ラベルは 'Date' です。", - "```html", - "", - "```" - ] - } - }, - "labelVisibility": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` ラベルの表示状態を設定する @Input プロパティ。", - "デフォルトで表示状態は true に設定されます。", - "" - ] - } - }, - "locale": { - "comment": { - "shortText": [ - "ロケールを設定する @Input プロパティ。デフォルト ロケールは en です。", - "```html", - "", - "```" - ] - } - }, - "weekStart": { - "comment": { - "shortText": [ - "週の最初の曜日を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "hideOutsideDays": { - "comment": { - "shortText": [ - "非アクティブな日付 (現在の月以外の日付) を非表示にするかどうかを設定または取得します。", - "デフォルト値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let hideOutsideDays = this.datePicker.hideOutsideDays;", - "```" - ] - } - }, - "monthsViewNumber": { - "comment": { - "shortText": [ - "表示される月ビューの数を設定または取得します。", - "デフォルト値は `1` です。", - "```html", - "", - "```", - "```typescript", - "let monthViewsDisplayed = this.datePicker.monthsViewNumber;", - "```" - ] - } - }, - "mask": { - "comment": { - "shortText": [ - "編集可能なドロップダウン モードで `IgxDatePickerComponent` の日付マスクを返します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let mask = this.datePicker.mask;", - "}", - "```" - ] - } - }, - "id": { - "comment": { - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合は、自動的に生成されます。", - "```html", - "", - "```" - ] - } - }, - "formatter": { - "comment": { - "shortText": [ - "選択した日付または渡した日付にカスタム書式関数を適用する @Input プロパティ。", - "```typescript", - "public date: Date = new Date();", - "private dayFormatter = new Intl.DateTimeFormat(\"en\", { weekday: \"long\" });", - "private monthFormatter = new Intl.DateTimeFormat(\"en\", { month: \"long\" });", - "public formatter = (date: Date) => { return `You selected", - " ${this.dayFormatter.format(date)},", - " ${date.getDate()} ${this.monthFormatter.format(date)},", - " ${date.getFullYear()}`;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "disabled": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` を無効にする @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "vertical": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` ヘッダーの方向を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "todayButtonLabel": { - "comment": { - "shortText": [ - "カスタム ラベルを使用して [今日] ボタンを描画する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "cancelButtonLabel": { - "comment": { - "shortText": [ - "カスタム ラベルを使用して [キャンセル] ボタンを描画する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "mode": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` がダイアログまたはドロップダウン モードかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "isSpinLoop": { - "comment": { - "shortText": [ - "Min/max を達した場合に、`IgxDatePickerComponent` の日付パーツが継続してスピンまたは停止するかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "outlet": { - "comment": { - "text": [ - "```html", - "
", - "//..", - "", - "//..", - "```", - "`Outlet` は `IgxOverlayOutletDirective` または `ElementRef` のインスタンスです。" - ], - "shortText": "Popup 要素を結び付けるコンテナを決定します。" - } - }, - "onOpened": { - "comment": { - "shortText": "`IgxDatePickerComponent` カレンダーが開いたときに発生されるイベント。" - } - }, - "onClosed": { - "comment": { - "shortText": "`IgxDatePickerComponent` が閉じたときに発生されるイベント。" - } - }, - "onClosing": { - "comment": { - "shortText": "`IgxDatePickerComponent` が閉じたときに発生されるイベント。" - } - }, - "onSelection": { - "comment": { - "shortText": [ - "カレンダーで選択が実行されるときに発生する @Output プロパティ。", - "```typescript", - "public selection(event){", - " alert(\"A date has been selected!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "valueChange": { - "comment": { - "shortText": [ - "日付ピッカーの値が変更されたときに発生する @Output プロパティ。", - "```typescript", - "public valueChanged(event){", - " alert(\"Date picker value is changed\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDisabledDate": { - "comment": { - "shortText": [ - "日付ピッカー エディターでユーザーが無効な日付を入力またはスピンした場合に発生する @Output プロパティ。", - "```typescript", - "public onDisabledDate(event){", - " alert(\"This date is disabled!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onValidationFailed": { - "comment": { - "shortText": [ - "日付ピッカー エディターでユーザーが無効な日付を入力またはスピンした場合に発生する @Output。", - "```typescript", - "public onValidationFailed(event){", - " alert(\"This date is not valid!\");", - "}", - "```", - "```html", - "", - "```" - ] - } - } - }, - "methods": { - "writeValue": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "選択する日付。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "選択した日付を設定するメソッド。", - "```typescript", - "public date = new Date();", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.writeValue(this.date);", - "}", - "```" - ] - } - }, - "triggerTodaySelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "今日の日付をカレンダーで選択し、入力フィールドの値、@calendar.viewDate、および @calendar.value を変更します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.triggerTodaySelection();", - "}", - "```" - ] - } - }, - "selectDate": { - "comment": { - "parameters": { - "date": { - "comment": { - "text": "カレンダーに設定される渡された日付" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カレンダー選択の変更およびこのメソッドの呼び出しは @calendar.onSelection イベントを発生し、@handleSelection メソッドを発生します。", - "", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.selectDate(this.date);", - "}", - "```" - ] - } - }, - "deselectDate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "{@link IgxDatePickerComponent}", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カレンダー日付を選択解除します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - "this.datePicker.deselectDate();", - "}", - "```" - ] - } - }, - "openDialog": { - "comment": { - "parameters": { - "target": { - "comment": { - "text": [ - "HTMLElement - 次に従ってドロップダウンコンテナを配置するために使用するターゲット要素。", - "```html", - "", - " ", - " ", - " ", - " ", - " alarm", - " ", - " ", - " ", - "", - "```" - ] - } - } - }, - "tags": {}, - "shortText": "日付ピッカーのドロップダウンまたはダイアログを開きます。" - } - } - }, - "accessors": { - "formatOptions": { - "getter": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` の書式設定オプションを返します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let formatOptions = this.datePicker.formatOptions;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` の書式設定オプションを設定します。", - "```typescript", - "public Options;", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.Options = {", - " day: \"numeric\",", - " month: \"long\",", - " weekday: \"long\",", - " year: \"numeric\"", - " }", - "this.datePicker.formatOptions = this.Options;", - "}", - "```" - ] - } - } - }, - "format": { - "getter": { - "comment": { - "shortText": [ - "編集可能なモード `IgxDatePickerComponent` の日付表示書式を返します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let format = this.datePicker.format;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "編集可能なドロップダウン モードで `IgxDatePickerComponent` の日付書式を設定します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "this.datePicker.format = 'yyyy-M-d';", - "}", - "```" - ] - } - } - }, - "formatViews": { - "getter": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` の書式設定ビューを返します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " let formatViews = this.datePicker.formatViews;", - "}", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` の書式設定ビューを設定します。", - "```typescript", - "public Views;", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.Views = {day:false, month: false, year:false};", - " this.datePicker.formatViews = this.Views;", - "}", - "```" - ] - } - } - }, - "disabledDates": { - "getter": { - "comment": { - "shortText": [ - "無効な日付記述子を取得します。", - "```typescript", - "let disabledDates = this.datepicker.disabledDates;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "無効な日付記述子を設定します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.disabledDates = [", - " {type: DateRangeType.Between, dateRange: [new Date(\"2020-1-1\"), new Date(\"2020-1-15\")]},", - " {type: DateRangeType.Weekends}];", - "}", - "```" - ] - } - } - }, - "specialDates": { - "getter": { - "comment": { - "shortText": [ - "特別な日付記述子を取得します。", - "```typescript", - "let specialDates = this.datepicker.specialDates;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "特別な日付記述子を設定します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "ngAfterViewInit(){", - " this.datePicker.specialDates = [", - " {type: DateRangeType.Between, dateRange: [new Date(\"2020-1-1\"), new Date(\"2020-1-15\")]},", - " {type: DateRangeType.Weekends}];", - "}", - "```" - ] - } - } - }, - "displayData": { - "getter": { - "comment": { - "shortText": [ - "`IgxDatePickerComponent` はダイアログ モードで、書式設定された日付を返します。", - "```typescript", - "@ViewChild(\"MyDatePicker\")", - "public datePicker: IgxDatePickerComponent;", - "public selection(event){", - " let selectedDate = this.datePicker.displayData;", - " alert(selectedDate);", - "}", - "```", - "```html", - "", - "```" - ] - } - } - }, - "transformedDate": { - "getter": { - "comment": { - "shortText": "非表示" - } - }, - "setter": { - "comment": { - "shortText": "非表示" - } - } - }, - "template": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxDatePickerComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "入力グループのテンプレートを取得します。", - "```typescript", - "let template = this.template();", - "```" - ] - } - } - }, - "context": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxDatePickerComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "入力グループのテンプレートに渡されたコンテキストを取得します。" - } - } - }, - "value": { - "getter": { - "comment": { - "shortText": [ - "選択した日付を取得する @Input プロパティ。", - "```typescript", - "public date: Date = new Date();", - "```", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "選択した日付を取得する @Input プロパティ。", - "```typescript", - "public date: Date = new Date();", - "```", - "```html", - "", - "```" - ] - } - } - }, - "onOpen": { - "getter": { - "comment": { - "tags": { - "deprecated": { - "comment": { - "text": [ - "代わりに `onOpened` を使用してください。", - "`IgxDatePickerComponent` カレンダーが開いたときに発生されるイベント。", - "```typescript", - "public open(event){", - " alert(\"The date-picker calendar has been opened!\");", - "}", - "```", - "```html", - "", - "```" - ], - "tagName": "非推奨。" - } - } - } - } - }, - "setter": { - "comment": {} - } - }, - "onClose": { - "getter": { - "comment": { - "tags": { - "deprecated": { - "comment": { - "text": [ - "代わりに `onClosed` を使用してください。", - "\"`IgxDatePickerComponent` が閉じたときに発生されるイベント。", - "```typescript", - "public close(event){", - " alert(\"The date-picker has been closed!\");", - "}", - "```", - "```html", - "", - "```" - ], - "tagName": "非推奨。" - } - } - } - } - }, - "setter": { - "comment": {} - } - } - } - } -} diff --git a/typedoc/ja/lib/directives/IgxButtonDirective.json b/typedoc/ja/lib/directives/IgxButtonDirective.json deleted file mode 100644 index ad30c62a..00000000 --- a/typedoc/ja/lib/directives/IgxButtonDirective.json +++ /dev/null @@ -1,180 +0,0 @@ -{ - "IgxButtonDirective": { - "properties": { - "buttonClick": { - "comment": { - "shortText": "ボタンがクリックされたときに呼び出されます。" - } - }, - "role": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`role` 属性を取得または設定します。", - "```typescript", - "this.button.role = 'navbutton';", - "```", - "```typescript", - "let buttonRole = this.button.role;", - "```" - ] - } - }, - "selected": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ボタンが選択されるかどうかを取得または設定します。", - "IgxButtonGroup コンポーネントで使用されます。別に設定される場合に影響しません。", - "```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "nativeElement": { - "getter": { - "comment": { - "shortText": "基本の DOM 要素を返します。" - } - } - }, - "type": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ボタンの種類を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "color": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ボタンのテキスト色を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "background": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ボタンの背景色を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "label": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`aria-label` 属性を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "disabled": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxButtonDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ボタンを有効/無効にします。", - " ```html", - "", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} diff --git a/typedoc/ja/lib/directives/IgxInputDirective.json b/typedoc/ja/lib/directives/IgxInputDirective.json deleted file mode 100644 index 115d6b62..00000000 --- a/typedoc/ja/lib/directives/IgxInputDirective.json +++ /dev/null @@ -1,334 +0,0 @@ -{ - "IgxInputDirective": { - "properties": { - "isInput": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "\"igx-input-group__input\"` クラスがホスト要素に追加されるかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```typescript", - "this.igxInput.isInput = true;", - "```", - "```typescript", - "let isCLassAdded = this.igxInput.isInput;", - "```" - ] - } - }, - "isTextArea": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`\"class.igx-input-group__textarea\"` クラスがホスト要素に追加されるかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```typescript", - "this.igxInput.isTextArea = true;", - "```", - "```typescript", - "let isCLassAdded = this.igxInput.isTextArea;", - "```" - ] - } - } - }, - "methods": { - "focus": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput にフォーカスを設定します。", - "```typescript", - "this.igxInput.focus();", - "```" - ] - } - } - }, - "accessors": { - "value": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`value` プロパティを設定します。", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`value` プロパティを取得します。", - "```typescript", - "@ViewChild('igxInput', {read: IgxInputDirective})", - " public igxInput: IgxInputDirective;", - "let inputValue = this.igxInput.value;", - "```" - ] - } - } - }, - "disabled": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`disabled` プロパティを設定します。", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`disabled` プロパティを取得します。", - "```typescript", - "@ViewChild('igxInput', {read: IgxInputDirective})", - " public igxInput: IgxInputDirective;", - "let isDisabled = this.igxInput.disabled;", - "```" - ] - } - } - }, - "required": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`required` プロパティを設定します。", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput が必須かどうかを取得します。", - "```typescript", - "let isRequired = this.igxInput.required;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput の `nativeElement` を取得します。", - "```typescript", - "let igxInputNativeElement = this.igxInput.nativeElement;", - "```" - ] - } - } - }, - "hasPlaceholder": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput にプレースホルダーがあるかどうかを取得します。", - "```typescript", - "let hasPlaceholder = this.igxInput.hasPlaceholder;", - "```" - ] - } - } - }, - "placeholder": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput のプレースホルダー要素を取得します。", - "```typescript", - "let igxInputPlaceholder = this.igxInput.placeholder;", - "```" - ] - } - } - }, - "focused": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput がフォーカスされるかどうかを取得します。", - "```typescript", - "let isFocused = this.igxInput.focused;", - "```" - ] - } - } - }, - "valid": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput の状態を取得します。", - "```typescript", - "let igxInputState = this.igxInput.valid;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput の状態を設定します。", - "```typescript", - "this.igxInput.valid = IgxInputState.INVALID;", - "```" - ] - } - } - }, - "isValid": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxInputDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "igxInput が有効かどうかを取得します。", - "```typescript", - "let valid = this.igxInput.isValid;", - "```" - ] - } - } - } - } - } -} diff --git a/typedoc/ja/lib/directives/IgxRadioGroupDirective.json b/typedoc/ja/lib/directives/IgxRadioGroupDirective.json deleted file mode 100644 index f5d9ed85..00000000 --- a/typedoc/ja/lib/directives/IgxRadioGroupDirective.json +++ /dev/null @@ -1,282 +0,0 @@ -{ - "IgxRadioGroupDirective": { - "comment": { - "text": [ - "Ignite UI Radio Group を使用すると、隣に表示されるオプションのセットから単一のオプションを選択する機能を提供します。", - "例:", - "```html", - "", - " ", - " {{item}}", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Radio Group** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/radio_button.html)" - ] - }, - "properties": { - "radioButtons": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "子ラジオ ボタンへの参照を返します。", - "```typescript", - "let radioButtons = this.radioGroup.radioButtons;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラジオ グループの `value` が変更された後に発生するイベント。", - "イベント引数として選択した `IgxRadioComponent` および `value` プロパティへの参照を提供します。" - ] - } - } - }, - "methods": { - "writeValue": { - "comment": { - "shortText": [ - "提供された値が現在のラジオ ボタンと一貫性のあるかどうかを確認します。", - "一貫性がある場合、checked 属性の値は `true` になり、selected プロパティは選択した `IgxRadioComponent` を含みます。", - "```typescript", - "this.radioGroup.writeValue('radioButtonValue');", - "```" - ] - } - } - }, - "accessors": { - "value": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`value` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let value = this.radioGroup.value;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`value` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let value = this.radioGroup.value;", - "```" - ] - } - } - }, - "name": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラジオ グループ コンポーネントの `name` 属性を取得または設定します。すべての子ラジオ ボタンはこの名前を継承します。", - "```html", - "", - " ```", - "```typescript", - "let name = this.radioGroup.name;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "ラジオ グループ コンポーネントの `name` 属性を取得または設定します。すべての子ラジオ ボタンはこの名前を継承します。", - "```html", - "", - " ```", - "```typescript", - "let name = this.radioGroup.name;", - "```" - ] - } - } - }, - "required": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラジオ グループが必須かどうかを取得または設定します。", - "設定されない場合、`required` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.radioGroup.required;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "ラジオ グループが必須かどうかを取得または設定します。", - "設定されない場合、`required` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.radioGroup.required;", - "```" - ] - } - } - }, - "disabled": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラジオ グループの無効化を許可する @Input プロパティ。デフォルトで false です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "ラジオ グループの無効化を許可する @Input プロパティ。デフォルトで false です。", - "```html", - "", - "```" - ] - } - } - }, - "labelPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "子ラジオ ボタンの `label` の位置を取得または設定します。", - "設定されない場合、`labelPosition` の値は `\"after\"` です。", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.radioGroup.labelPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "子ラジオ ボタンの `label` の位置を取得または設定します。", - "設定されない場合、`labelPosition` の値は `\"after\"` です。", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.radioGroup.labelPosition;", - "```" - ] - } - } - }, - "selected": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRadioGroupDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "選択した子ラジオ ボタンを取得または設定します。", - "```typescript", - "let selectedButton = this.radioGroup.selected;", - "this.radioGroup.selected = selectedButton;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "選択した子ラジオ ボタンを取得または設定します。", - "```typescript", - "let selectedButton = this.radioGroup.selected;", - "this.radioGroup.selected = selectedButton;", - "```" - ] - } - } - } - } - } -} diff --git a/typedoc/ja/lib/grids/IgxGridBaseDirective.json b/typedoc/ja/lib/grids/IgxGridBaseDirective.json deleted file mode 100644 index 2a597505..00000000 --- a/typedoc/ja/lib/grids/IgxGridBaseDirective.json +++ /dev/null @@ -1,4205 +0,0 @@ -{ - "IgxGridBaseDirective": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された後に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列の値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供される場合、生成される一意の値は Excel スタイル フィルタリングで使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - " `IgxGridCellComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集が完了して、セルは編集モードを終了する時、イベントが発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モードで編集した行の編集禁止セルを選択し、行の編集時にページング操作をして、列のサイズ変更時、列ピン固定時、rowEditingOverlay 内で `Commit` ボタンを押下また移動時、またはセル編集時に `Enter` キーを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。Args: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発行されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID。", - " const rowID = event.rowID;", - " // 新しい展開状態。", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント。", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか。", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します。", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowComponent` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出で手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID.に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` をフィルターします。", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの幅/高さのサイズを再計算します。グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。", - "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", - "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを設定します。", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されている場合は true を返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトの設定は false です。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがなく、グリッドがフィルターされた場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトで bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "グリッドのためのトランザクション サービスを取得します。" - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは複数です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトのヘッダーのサイズ設定モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの最大幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみに操作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` 選択されているメモの配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridComponent.json b/typedoc/ja/lib/grids/IgxGridComponent.json deleted file mode 100644 index 48061202..00000000 --- a/typedoc/ja/lib/grids/IgxGridComponent.json +++ /dev/null @@ -1,4881 +0,0 @@ -{ - "IgxGridComponent": { - "comment": { - "text": [ - "Ignite UI Grid は簡単に表データを表示して操作するために使用されます。", - "データをバインドした後、フィルタリング、並べ替え、および編集操作を使用して変更できます。", - "例:", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Grid** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" - ] - }, - "properties": { - "groupsExpanded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "作成したグループを展開または縮小として描画されるかどうかを決定する @Input プロパティ。", - "デフォルトの描画状態は展開です。", - "```html", - "", - "```" - ] - } - }, - "groupsRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードによるグループの階層表現。", - "```typescript", - "let groupRecords = this.grid.groupsRecords;", - "```" - ] - } - }, - "dropAreaTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "GroupBy ドロップ領域として描画されるテンプレートを設定する @Input プロパティ。", - "注: GroupBy 領域を表示するためにグリッドでグループ可能な列が 1 列以上必要です。", - "```html", - "", - " ", - "", - "", - " Custom drop area! ", - "", - "```", - "```ts", - "@ViewChild('myDropArea', { read: TemplateRef })", - "public dropAreaRef: TemplateRef;", - "```" - ] - } - }, - "onGroupingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "Group By API を使用して新しい `IgxColumnComponent` のグループ化/グループ解除、または複数列がグループ化/グループ化解除されたときに発生します。", - "groupBy()` または `clearGrouping()` API メソッドを呼び出して引数として渡すことにより複数列がｚ一度にグループ化された場合に `onGroupingDone` イベントは一度のみ発生します。", - "イベント引数は、`ISortingExpression` とグループ化/グループ解除操作と関連する `IgxColumnComponent` を含む `expressions`、`groupedColumns`、`ungroupedColumns` プロパティを提供します。", - "`groupedColumns` と `ungroupedColumns` は新しく変更 (**最近**のグループ化/グループ解除操作によって影響) された列のみ表示し、現在グループ化/グループ解除されているすべての列ではありません。", - "列。", - "```typescript", - "groupingDone(event: IGroupingDoneEventArgs){", - " const expressions = event.expressions;", - " //新しくグループ化された列", - " const groupedColumns = event.groupedColumns;", - " //新しくグループ解除された列", - " const ungroupedColumns = event.ungroupedColumns;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された後に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された時) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集を完了してセルの編集モードを終了する時にイベントが発生します。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モードで編集した行の編集禁止セルを選択し、行の編集時にページング操作をして、列のサイズ変更時、列ピン固定時、rowEditingOverlay 内で `Commit` ボタンを押下また移動時、またはセル編集時に `Enter` キーを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータの塊が可視化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。引数: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発生されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID。", - " const rowID = event.rowID;", - " // 新しい展開状態。", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント。", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか。", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "groupBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxColumnComponent` を提供された式によってグループ化、または既存の式を変更します。", - "`ISortingExpression` の配列が渡されると複数列を一度にグループ化できるようになります。", - "このメソッドが同じ引数で複数回呼びだされた場合、onGroupingDone イベントは 1 度のみ発生します。", - "```typescript", - "this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "this.grid.groupBy([", - "{ fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },", - "{ fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },", - "{ fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }", - "]);", - "```" - ] - } - }, - "clearGrouping": { - "comment": { - "shortText": [ - "パラメーターが渡されない場合、グリッドのグループ化をすべて解除します。", - "パラメーターが提供された場合、特定の列または列の配列のグループ化を解除します。", - "```typescript", - "this.grid.clearGrouping(); //すべてのグループ化を解除します", - "this.grid.clearGrouping(\"ID\"); //単一の列のグループ化を解除します", - "this.grid.clearGrouping([\"ID\", \"Column1\", \"Column2\"]); //複数列のグループ化を解除します", - "```" - ] - } - }, - "isExpandedGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グループが展開されているかどうかを返します。", - "```typescript", - "public groupRow: IGroupByRecord;", - "const expandedGroup = this.grid.isExpandedGroup(this.groupRow);", - "```" - ] - } - }, - "toggleGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グループの展開状態を切り替えます。", - "```typescript", - "public groupRow: IGroupByRecord;", - "const toggleExpGroup = this.grid.toggleGroup(this.groupRow);", - "```" - ] - } - }, - "fullyExpandGroup": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したグループとそのすべての親グループを展開します。", - "```typescript", - "public groupRow: IGroupByRecord;", - "this.grid.fullyExpandGroup(this.groupRow);", - "```" - ] - } - }, - "toggleAllGroupRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべてのグループ行の展開状態を再帰的に切り替えます。", - "```typescript", - "this.grid.toggleAllGroupRows;", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "tags": { - "inheritdoc": { - "comment": { - "tagName": "inheritdoc" - } - } - } - } - }, - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します。", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowDirective` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出のため手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および相対するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` をフィルターします。", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの幅/高さのサイズを再計算します。グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択します。", - "注: フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にデータの配列をインポートする @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` にデータの配列をインポートする @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "filteredData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター済みデータを含むオブジェクトの配列を返します。", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター済みデータを含むオブジェクトの配列を設定します。", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - } - }, - "totalItemCount": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "データ ソース内のレコードの総数を設定します。", - "このプロパティは、リモート グリッド仮想化がリモート データにバインドされているときに機能するために必要です。", - "```typescript", - "this.grid1.totalItemCount = 55;", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "データ ソース内のレコードの総数を返します。", - "リモートのグリッド仮想化のみに操作します。", - "```typescript", - "const itemCount = this.grid1.totalItemCount;", - "```" - ] - } - } - }, - "groupingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` のグループ化状態を返します。", - "```typescript", - "let groupByState = this.grid.groupingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の状態によってグループ化を設定し、適切な引数で `onGroupingDone` イベントを発生します。", - "```typescript", - "this.grid.groupingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Asc,", - " ignoreCase: false", - "}];", - "```" - ] - } - } - }, - "groupingExpansionState": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "グループ行の展開状態のリストを返します。", - "デフォルト状態と異なる groupsExpanded によって制御されるか、ユーザーが変更された状態のみを含みます。", - "展開状態 (expanded: ブール値) およびグループ行の一意識別子 (Array) を含みます。", - "```typescript", - "const groupExpState = this.grid.groupingExpansionState;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "グループ行の展開状態のリストを設定します。", - "```typescript", - " this.grid.groupingExpansionState = [{", - " expanded: false,", - " hierarchy: [{ fieldName: 'ID', value: 1 }]", - " }];", - "// `IgxGridRowComponent` を取得するため DataUtil.getHierarchy(groupRow) を使用できます。", - "```" - ] - } - } - }, - "hideGroupedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グループ化された列が非表示に設定されるかどうかの @Input プロパティ。", - "デフォルト値は \"false\" です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グループ化された列が非表示に設定されるかどうかの @Input プロパティ。", - "デフォルト値は \"false\" です。", - "```html", - "", - "```" - ] - } - } - }, - "dropAreaMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列にドラッグできる GroupBy のドロップ領域に表示されるメッセージを設定する @Input プロパティ。", - "注: GroupBy 領域を表示するためにグリッドでグループ可能な列が 1 列以上必要です。", - "```html", - "", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "列にドラッグできる GroupBy のドロップ領域に表示されるメッセージを返すアクセサー。" - } - } - }, - "groupsRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべてのグループ行のリスト。", - "```typescript", - "const groupList = this.grid.groupsRowList;", - "```" - ] - } - } - }, - "groupRowTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のグループ行のテンプレート参照を返します。", - "```", - "const groupRowTemplate = this.grid.groupRowTemplate;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のグループ `IgxGridRowComponent` のテンプレート参照を設定します。", - "```typescript", - "this.grid.groupRowTemplate = myRowTemplate.", - "```" - ] - } - } - }, - "groupAreaTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のグループ領域のテンプレート参照を返します。", - "```typescript", - "const groupAreaTemplate = this.grid.groupAreaTemplate;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のグループ領域のテンプレート参照を設定します。", - "```typescript", - "this.grid.groupAreaTemplate = myAreaTemplate.", - "```" - ] - } - } - }, - "hasGroupableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にグループ化可能な列があるかどうかを返します。", - "```typescript", - "const groupableGrid = this.grid.hasGroupableColumns;", - "```" - ] - } - } - }, - "dropAreaVisible": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのグループ化ドロップ領域が表示されるかどうかを返します。", - "```typescript", - "const dropVisible = this.grid.dropAreaVisible;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを設定します", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されているかどうか返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトで false に設定されます。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがなく、グリッドがフィルターされた場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトは bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトは rootAndChildLevels で、集計はルート レベルと各子レベルが計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "グリッドのためのトランザクション サービスを取得します。" - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは multiple です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在の行選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトでは、行選択モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定されない `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定されない `IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "表示される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみに操作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "選択される `IgxGridCellComponent` の配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxHierarchicalGridBaseDirective.json b/typedoc/ja/lib/grids/IgxHierarchicalGridBaseDirective.json deleted file mode 100644 index b79df639..00000000 --- a/typedoc/ja/lib/grids/IgxHierarchicalGridBaseDirective.json +++ /dev/null @@ -1,4206 +0,0 @@ -{ - "IgxHierarchicalGridBaseDirective": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された後に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集を完了してセルの編集モードを終了する時にイベントが発生します。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。引数: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発生されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} を通じてコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID", - " const rowID = event.rowID;", - " // 新しい展開状態", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowComponent` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出で手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "Filters a single `IgxColumnComponent`.", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの幅/高さのサイズを再計算します。グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択します。", - "注: フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。", - "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", - "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを設定します。", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されているかどうか返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトで false に設定されます。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがなく、グリッドがフィルターされた場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトは bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトは rootAndChildLevels で、集計はルート レベルと各子レベルが計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "グリッドのためのトランザクション サービスを取得します。" - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは multiple です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在の行選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトでは、行選択モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの最大幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみに操作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` 選択されているメモの配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxHierarchicalGridComponent.json b/typedoc/ja/lib/grids/IgxHierarchicalGridComponent.json deleted file mode 100644 index ae2fd7e5..00000000 --- a/typedoc/ja/lib/grids/IgxHierarchicalGridComponent.json +++ /dev/null @@ -1,4372 +0,0 @@ -{ - "IgxHierarchicalGridComponent": { - "properties": { - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された前に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列の値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供される場合、生成される一意の値は Excel スタイル フィルタリングで使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - " `IgxGridCellComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集が完了して、セルは編集モードを終了する時、イベントが発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モードで編集した行の編集禁止セルを選択し、行の編集時にページング操作をして、列のサイズ変更時、列ピン固定時、rowEditingOverlay 内で `Commit` ボタンを押下また移動時、またはセル編集時に `Enter` キーを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。引数: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発行されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} を通じてコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID", - " const rowID = event.rowID;", - " // 新しい展開状態", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の階層グリッドのすべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します。", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowComponent` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出で手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID.に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` をフィルターします。", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの幅/高さのサイズを再計算します。 グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "Selects all rows", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。", - "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", - "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`Id` 属性の値を設定します。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` にデータの配列をインポートする @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` に設定されたデータ の配列に設定されたを返します。", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - } - }, - "filteredData": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` のフィルター済みデータを含むオブジェクトの配列を設定します。", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` のフィルター済みデータを含むオブジェクトの配列を返します。", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - } - }, - "expandChildren": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` の直下の子が展開または縮小されるかどうかを設定します。", - "デフォルトの値は false です。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxHierarchicalGridComponent` の直下の子が以前展開または縮小に設定されたかどうかを取得します。", - "以前に設定した行の一部が手動的に展開または縮小された場合、最後に設定された値を返します。", - "```typescript", - "const expanded = this.grid.expandChildren;", - "```" - ] - } - } - }, - "foreignKey": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxHierarchicalGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "親行の一意の識別子を取得します。It may be a `string` or `number` if `primaryKey` of the parent grid is set or an object reference of the parent record otherwise.", - "```typescript", - "const foreignKey = this.grid.foreignKey;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを設定します。", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されている場合は true を返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトの設定は false です。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを返します。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトで bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "グリッドのためのトランザクション サービスを取得します。" - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは multiple です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトのヘッダーのサイズ設定モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの最大幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみに操作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent`　が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` 選択されているメモの配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxRowIslandComponent.json b/typedoc/ja/lib/grids/IgxRowIslandComponent.json deleted file mode 100644 index 95d4631f..00000000 --- a/typedoc/ja/lib/grids/IgxRowIslandComponent.json +++ /dev/null @@ -1,4281 +0,0 @@ -{ - "IgxRowIslandComponent": { - "properties": { - "key": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行データから子データの取得に使用される行アイランドのキーを設定します。", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "onGridCreated": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "この行アイランドに基づくグリッドが生成される時に発生されるイベント。", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された後に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列の値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供される場合、生成される一意の値は Excel スタイル フィルタリングで使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"The cell has been clicked!\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"The cell has been selected!\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - " `IgxGridCellComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"The selected row has been changed!\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された時) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集を完了してセルの編集モードを終了する時にイベントが発生します。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モードで編集した行の編集禁止セルを選択し、行の編集時にページング操作をして、列のサイズ変更時、列ピン固定時、rowEditingOverlay 内で `Commit` ボタンを押下また移動時、またはセル編集時に `Enter` キーを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。引数: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発生されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} を通じてコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID", - " const rowID = event.rowID;", - " // 新しい展開状態", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します。", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowComponent` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出で手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。", - "```typescript", - "const record = {", - " ID: this.grid1.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid1.addRow(record);", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` をフィルターします。", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "Selects all rows", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "shortText": [ - "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。", - "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", - "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "expandChildren": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの直下の子はこの `IgxRowIslandComponent` のためにに展開または縮小されるかどうかを設定します。", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxRowIslandComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの直下の子はこの `IgxRowIslandComponent` のために展開または縮小に設定されたかどうかを取得します。", - "```typescript", - "const expanded = this.rowIsland.expandChildren;", - "```" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを設定します。", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されている場合は true を返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトの設定は false です。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがなく、グリッドがフィルターされた場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトで bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "shortText": "グリッドのためのトランザクション サービスを取得します。" - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは複数です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトのヘッダーのサイズ設定モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの最大幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみ動作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` 選択されているメモの配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxTreeGridComponent.json b/typedoc/ja/lib/grids/IgxTreeGridComponent.json deleted file mode 100644 index 7c10fc70..00000000 --- a/typedoc/ja/lib/grids/IgxTreeGridComponent.json +++ /dev/null @@ -1,4596 +0,0 @@ -{ - "IgxTreeGridComponent": { - "comment": { - "text": [ - "Ignite UI Tree Grid は統一性のあるテーブルとして書式設定されたスキーマで階層型データを表示および操作し、並べ替え、フィルタリング、エディティング、列ピン固定、ページング、列移動、非表示など高度な機能を提供します。", - "例:", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Tree Grid** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" - ] - }, - "properties": { - "rootRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`ITreeGridRecord` のルート レベルの配列を返します。", - "```typescript", - "// index=2 のルート レベルを取得します。", - "const states = this.grid.rootRecords[2];", - "```" - ] - } - }, - "records": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `ITreeGridRecord` のマップを返します。", - "```typescript", - "// primaryKey=2 のルート レベルを取得します。", - "const states = this.grid.records.get(2);", - "```" - ] - } - }, - "processedRootRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "処理済み (フィルターと並べ替え済み) のルート`ITreeGridRecord` の配列を返します。", - "```typescript", - "// index=2 の処理済みルート レコールドを取得します。", - "const states = this.grid.processedRootRecords[2];", - "```" - ] - } - }, - "processedRecords": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "処理済み (フィルターと並べ替え済み) のルート`ITreeGridRecord` の配列のマップを返します。", - "```typescript", - "// primaryKey=2 の処理済みレコードを取得します。", - "const states = this.grid.processedRecords.get(2);", - "```" - ] - } - }, - "childDataKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxTreeGridComponent` の子データ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "foreignKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxTreeGridComponent` の外部キーを設定する @Input プロパティ。", - "```html", - "", - "", - "```" - ] - } - }, - "hasChildrenKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行に子があるかどうかを示すキーを設定する @Input プロパティ。", - "このプロパティは、ロードオンデマンドの場合のみ使用されます。", - "```html", - "", - "", - "```" - ] - } - }, - "cascadeOnDelete": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "親が削除されると子レコードも削除されるかどうかを表す @Input プロパティ。", - "デフォルトで true に設定されて、親とともにすべての子を削除します。", - "```html", - "", - "", - "```" - ] - } - }, - "loadChildrenOnDemand": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "要求に応じて子行をロードするためのコールバックを提供する @Input プロパティ。", - "```html", - "", - "", - "```", - "```typescript", - "public loadChildren = (parentID: any, done: (children: any[]) => void) => {", - " this.dataService.getData(parentID, children => done(children));", - "}", - "```" - ] - } - }, - "autoGenerate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` 列を自動生成する @Input プロパティ。", - "デフォルト値は False です。", - "```html", - "", - "```" - ] - } - }, - "emptyGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "loadingGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が読み込み中の場合にカスタム テンプレートを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "filteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行された後に発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "advancedFilteringExpressionsTreeChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度フィルタリングが UI で実行された後に発生されます。", - "高度フィルタリング式ツリーを返します。", - "```typescript", - "advancedFilteringExprTreeChange(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "paginationTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドのページング UI のためにカスタム `ng-template` を提供できます。", - "```html", - "", - "```" - ] - } - }, - "evenRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての偶数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "oddRowCSS": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドですべての奇数な `IgxGridRowComponent` にスタイル クラスを追加する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "primaryKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のプライマリ キーを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "shouldGenerate": { - "comment": { - "shortText": [ - "グリッドの初期化後に列が自動で再生成されることを許可するプロパティ。", - "これにより、グリッドのリモート データへのバインドと列の自動生成を同時に行うことができます。", - "新しいデータが割り当てらる時に列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。", - "```typescript", - " this.grid.shouldGenerate = true;", - " this.remoteData = this.remoteService.remoteData;", - "```" - ] - } - }, - "columnHidingTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列非表示 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "columnPinningTitle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列ピン固定 UI に表示されるタイトルを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "uniqueColumnValuesStrategy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "```typescript", - "public columnValuesStrategy = (column: IgxColumnComponent,", - " filteringExpressionsTree: IFilteringExpressionsTree,", - " done: (uniqueValues: any[]) => void) => {", - " this.dataService.getColumnData(column, filteringExpressionsTree, uniqueValues => done(uniqueValues));", - "}", - "```" - ], - "shortText": [ - "要求に応じて一意の列の値をロードするためのコールバックを提供する @Input プロパティ。", - "このプロパティが提供される場合、生成される一意の値は Excel スタイル フィルタリングで使用されます。", - "```html", - "", - "```" - ] - } - }, - "onCellClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がクリックされたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellClick(e){", - " alert(\"セルはクリックされました。\");", - "}", - "```" - ] - } - }, - "onSelection": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が選択されたときに発生します。`IgxGridCellComponent` を返します。", - "```html", - "", - "```", - "```typescript", - "public onCellSelect(e){", - " alert(\"セルは選択されました。\");", - "}", - "```" - ] - } - }, - "onRowSelectionChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - " `IgxGridCellComponent` が選択されたときに発生します。", - "```html", - "", - "```", - "```typescript", - "public onCellClickChange(e){", - " alert(\"選択された行は変更されました。\");", - "}", - "```" - ] - } - }, - "onColumnPinning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がピン固定されたときに発生します。", - "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", - "```typescript", - "public columnPinning(event) {", - " if (event.column.field === \"Name\") {", - " event.insertAtIndex = 0;", - " }", - "}", - "```" - ] - } - }, - "onCellEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editCancel(event: IGridEditEventArgs){", - " const rowID: IgxColumnComponent = event.rowID;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` 編集を実行した後に値が**送信されてない** (Esc キーが押された) 場合にイベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editStart(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "`IgxGridCellComponent` は編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onCellEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " cellID: {", - " columnID: int,", - " rowID: int,", - " rowIndex: int", - " }", - " newValue: object,", - " oldValue: object,", - " rowID: int", - " }", - "```typescript", - "editDone(event: IGridEditEventArgs){", - " const value: IgxColumnComponent = event.newValue;", - "}", - "```", - "```html", - "", - " ", - " ", - " ", - "", - "```" - ], - "shortText": [ - "グリッドで `IgxGridCellComponent` の編集が実行されたときにイベントを発生する @Output プロパティ。", - "編集を完了してセルの編集モードを終了する時にイベントが発生します。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditEnter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " oldValue: ,", - " rowID: int", - " }", - "Bind to the event in markup as follows:", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editStart(event: IGridEditEventArgs) {", - " const editedRowObj = event.oldValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" 行が編集モードに入るときに、イベントを発生する @Output プロパティ。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEdit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editDone(event: IGridEditEventArgs) {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに、イベントを発生する @Output プロパティ。", - "編集モードで編集した行の編集禁止セルを選択し、行の編集時にページング操作をして、列のサイズ変更時、列ピン固定時、rowEditingOverlay 内で `Commit` ボタンを押下また移動時、またはセル編集時に `Enter` キーを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onRowEditCancel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "args: IGridEditEventArgs = {", - " cancel: bool,", - " newValue: ,", - " oldValue: ,", - " rowID: int", - " }", - "次のようにマークアップでのイベントにバインとします。", - "```html", - "", - " ", - " ", - " ", - "", - "```", - "```typescript", - " editCancel(emitted: { row: IgxGridRowComponent, newValue: any, oldValue: any }): void {", - " const originalRowObj = event.oldValue;", - " const updatedRowObj = event.newValue;", - " const cancelValue = event.cancel;", - " const rowID = event.rowID;", - " }", - "```" - ], - "shortText": [ - "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときにイベントを発生する @Output プロパティ。", - "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", - "このイベントはキャンセルできます。" - ] - } - }, - "onColumnInit": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッド列が初期化されるときに発生します。列オブジェクトを返します。", - "```html", - "", - "```", - "```typescript", - "initColumns(event: IgxColumnComponent) {", - "const column: IgxColumnComponent = event;", - " column.filterable = true;", - " column.sortable = true;", - " column.editable = true;", - "}", - "```" - ] - } - }, - "onSortingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行されたときに発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingDone(event: SortingDirection){", - " const sortingDirection = event;", - "}", - "```" - ] - } - }, - "onFilteringDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが UI で実行されたときに発生されます。", - "フィルターされた列のフィルタリング式ツリーを返します。", - "```typescript", - "filteringDone(event: IFilteringExpressionsTree){", - " const filteringTree = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onPagingDone": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページングが実行されたときに発生されます。前のページおよび次のページを含むオブジェクトを返します。", - "```typescript", - "pagingDone(event: IPageEventArgs){", - " const paging = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowAdded": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が API によって `IgxGridComponent` に追加されている間に発生されます。", - "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", - "```typescript", - "rowAdded(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onRowDeleted": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が `IgxGridComponent` API によって削除されたときに発生されます。", - "`IRowDataEventArgs` オブジェクトを返します。", - "```typescript", - "rowDeleted(event: IRowDataEventArgs){", - " const rowInfo = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDataPreLoad": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "新しいデータ チャンクが可視化から読み込まれたときに発生されます。", - "```typescript", - " ", - "```" - ] - } - }, - "onColumnResized": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` がサイズ変更されたときに発生します。", - "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", - "```typescript", - "resizing(event: IColumnResizeEventArgs){", - " const grouping = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onContextMenu": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` が右クリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "contextMenu(event: IGridCellEventArgs){", - " const resizing = event;", - " console.log(resizing);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onDoubleClick": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` がダブルクリックされたときに発生されます。`IgxGridCellComponent` オブジェクトを返します。", - "```typescript", - "dblClick(event: IGridCellEventArgs){", - " const dblClick = event;", - " console.log(dblClick);", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnVisibilityChanged": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の表示状態を変更するときに発生されます。 引数: { column: any, newValue: boolean }", - "```typescript", - "visibilityChanged(event: IColumnVisibilityChangedEventArgs){", - " const visiblity = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingStart": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を開始したときに発生されます。移動した `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingStart(event: IColumnMovingStartEventArgs){", - " const movingStarts = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMoving": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` 移動操作の間に発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。このイベントはキャンセルできます。", - "```typescript", - "moving(event: IColumnMovingEventArgs){", - " const moving = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onColumnMovingEnd": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の移動を終了したときに発生されます。", - "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", - "```typescript", - "movingEnds(event: IColumnMovingEndEventArgs){", - " const movingEnds = event;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "onGridKeydown": { - "comment": { - "shortText": [ - "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。", - "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", - "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。", - "```typescript", - "customKeydown(args: IGridKeydownEventArgs) {", - " const keydownEvent = args.event;", - "}", - "```", - "```html", - " ", - "```" - ] - } - }, - "onRowDragStart": { - "comment": { - "shortText": [ - "行をドラッグし始めたときに発生します。", - "ドラッグされた行を返します。" - ] - } - }, - "onRowDragEnd": { - "comment": { - "shortText": [ - "行をドロップしたときに発行されます。", - "ドロップされた行を返します。" - ] - } - }, - "onGridCopy": { - "comment": { - "shortText": [ - "コピー操作が実行されたときに発生します。", - "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} を通じてコピー動作が有効になっている場合にのみ発生します。" - ] - } - }, - "onRowToggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の展開状態が変更されているときに呼び出されます。", - "```typescript", - "rowToggle(event: IRowToggleEventArgs){", - " //行の ID。", - " const rowID = event.rowID;", - " // 新しい展開状態。", - " const newExpandedState = event.expanded;", - " // onRowToggle をトリガーした元のイベント。", - " const originalEvent = event.event;", - " // イベントをキャンセルするかどうか。", - " event.cancel = true;", - "}", - "```", - "```html", - "", - "```" - ] - } - }, - "emptyFilteredGridTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされた `IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "emptyGridDefaultTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が空の場合に表示されるテンプレートのテンプレート参照。", - "```", - "const emptyTempalte = this.grid.emptyGridTemplate;", - "```" - ] - } - }, - "rowExpandedIndicatorTemplate": { - "comment": { - "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "rowCollapsedIndicatorTemplate": { - "comment": { - "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerExpandIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "headerCollapseIndicatorTemplate": { - "comment": { - "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" - } - }, - "sortingExpressionsChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "並べ替えが UI で実行された前に発生されます。並べ替え式を返します。", - "```html", - "", - "```", - "```typescript", - "sortingExprChange(event: ISortingExpression[]){", - " const sortingExpressions = event;", - "}", - "```" - ] - } - }, - "toolbar": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxToolbarComponent` へのアクセスを提供します。", - "```typescript", - "const gridToolbar = this.grid.toolbar;", - "```" - ] - } - }, - "onToolbarExporting": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ユーザーがエクスポート処理が開始すると発生されます。", - "```typescript", - "toolbarExporting(event: IGridToolbarExportEventArgs){", - " const toolbarExporting = event;", - "}", - "```" - ] - } - }, - "onRangeSelection": { - "comment": { - "shortText": [ - "ドラッグ選択またはキーボード選択による範囲選択を行ったときに発生します。" - ] - } - } - }, - "methods": { - "expandAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を展開します。", - "```typescript", - "this.grid.expandAll();", - "```" - ] - } - }, - "collapseAll": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を縮小します。", - "```typescript", - "this.grid.collapseAll();", - "```" - ] - } - }, - "addRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "所定のデータで新しい `IgxTreeGridRowComponent` を作成します。parentRowID を指定しない場合、新しく作成された行はルート レベルに追加されます。そうでない場合、指定した parentRowID に一致する primaryKey の行は子として追加されます。parentRowID は存在しない場合、エラーを発生します。", - "```typescript", - "const record = {", - " ID: this.grid.data[this.grid1.data.length - 1].ID + 1,", - " Name: this.newRecord", - "};", - "this.grid.addRow(record, 1); // ID=1 の行に新しい子行を追加します。", - "```" - ] - } - }, - "getSelectedData": { - "comment": { - "tags": { - "inheritdoc": { - "comment": { - "tagName": "inheritdoc" - } - } - } - } - }, - "toggleColumnVisibility": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列の表示状態を切り替えます。", - "```typescript", - "this.grid1.toggleColumnVisibility({", - " column: this.grid1.columns[0],", - " newValue: true", - "});", - "```" - ] - } - }, - "expandRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を展開します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.expandRow(rowID);", - "```" - ] - } - }, - "collapseRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を縮小します。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.collapseRow(rowID);", - "```" - ] - } - }, - "toggleRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ID によって行を切り替えます。ID は、primaryKey 値またはデータ レコード インスタンスです。", - "```typescript", - "this.grid.toggleRow(rowID);", - "```" - ] - } - }, - "getHeaderGroupWidth": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を返します。" - } - }, - "getColumnByName": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィールド名によって `IgxColumnComponent` を返します。", - "```typescript", - "const myCol = this.grid1.getColumnByName(\"ID\");", - "```" - ] - } - }, - "getRowByIndex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "インデックスによって `IgxRowComponent` を返します。", - "```typescript", - "const myRow = this.grid1.getRowByIndex(1);", - "```" - ] - } - }, - "getRowByKey": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "const myRow = this.grid1.getRowByKey(\"cell5\");", - "```" - ] - } - }, - "getCellByColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "条件と一致する `IgxGridCellComponent` を返します。", - "```typescript", - "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", - "```" - ] - } - }, - "getCellByKey": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "いずれかの rowID に一致します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定されたプライマリキーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。", - "primaryKey プロパティの設定が必要です。", - "```typescript", - "grid.getCellByKey(1, 'index');", - "```" - ] - } - }, - "nextPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最後のページにない場合、`IgxGridComponent` の次のページに移動します。", - "```typescript", - "this.grid1.nextPage();", - "```" - ] - } - }, - "previousPage": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドが最初のページにない場合、`IgxGridComponent` の前のページに移動します。", - "```typescript", - "this.grid1.previousPage();", - "```" - ] - } - }, - "moveColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列を指定したドロップ ターゲットに移動します。", - "```typescript", - "grid.moveColumn(compName, persDetails);", - "```" - ] - } - }, - "paginate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定したページ インデックスに移動します。", - "```typescript", - "this.grid1.paginate(1);", - "```" - ] - } - }, - "markForCheck": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` を変更検出のため手動的にマークします。", - "```typescript", - "this.grid1.markForCheck();", - "```" - ] - } - }, - "deleteRow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。", - "`primaryKey` プロパティの設定が必要です。", - "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。", - "```typescript", - "this.grid1.deleteRow(0);", - "```" - ] - } - }, - "updateCell": { - "comment": { - "parameters": { - "value": { - "comment": { - "text": "設定する新しい値。" - } - }, - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - }, - "column": { - "comment": { - "text": "列フィールドに対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。", - "`primaryKey` プロパティの設定が必要です。", - "```typescript", - "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", - "```" - ] - } - }, - "updateRow": { - "comment": { - "parameters": { - "rowSelector": { - "comment": { - "text": "rowID に対応します。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "rowSelector パラメーター と指定された値を持つデータ ソース レコードに指定される `IgxGridRowComponent` を更新します。", - "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。", - "```typescript", - "grid.updateRow({", - " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", - " }, 1);", - "```" - ] - } - }, - "sort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` を並べ替えます。", - "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", - "```typescript", - "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", - "```" - ] - } - }, - "filter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "単一の `IgxColumnComponent` をフィルターします。", - "```typescript", - "public filter(term) {", - " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", - "}", - "```" - ] - } - }, - "filterGlobal": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。", - "```typescript", - "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", - "```" - ] - } - }, - "enableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した列で集計を有効にし、customSummary を適用します。", - "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", - "```typescript", - "grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);", - "```", - "配列の列で集計を有効にします。", - "```typescript", - "grid.enableSummaries('ProductName');", - "```" - ] - } - }, - "disableSummaries": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "配列の列で集計を無効にします。", - "```typescript", - "grid.disableSummaries([{ fieldName: 'ProductName' }]);", - "```" - ], - "shortText": [ - "指定した列で集計を無効にします。", - "```typescript", - "grid.disableSummaries('ProductName');", - "```" - ] - } - }, - "clearFilter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", - "```typescript", - "this.grid.clearFilter();", - "```" - ] - } - }, - "clearSort": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "name が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", - "```typescript", - "this.grid.clearSort();", - "```" - ] - } - }, - "pinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "unpinColumn": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "列をフィールド名によってピン固定解除します。操作が成功したかどうかを返します。", - "```typescript", - "this.grid.pinColumn(\"ID\");", - "```" - ] - } - }, - "reflow": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドの幅/高さのサイズを再計算します。グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", - "```typescript", - "this.grid.reflow();", - "```" - ] - } - }, - "findNext": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findNext(\"financial\");", - "```" - ] - } - }, - "findPrev": { - "comment": { - "parameters": { - "text": { - "comment": { - "text": "検索する文字列。" - } - }, - "caseSensitive": { - "comment": { - "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" - } - }, - "exactMatch": { - "comment": { - "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。", - "グリッドに文字列が何回含まれるかを返します。", - "```typescript", - "this.grid.findPrev(\"financial\");", - "```" - ] - } - }, - "refreshSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "既存の検索を再適用します。", - "グリッドに前回の検索テキストが何回含まれるかを返します。", - "```typescript", - "this.grid.refreshSearch();", - "```" - ] - } - }, - "clearSearch": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セルのすべての強調表示を削除します。", - "```typescript", - "this.grid.clearSearch();", - "```" - ] - } - }, - "getPinnedWidth": { - "comment": { - "parameters": { - "takeHidden": { - "comment": { - "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定領域の計算幅を取得します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth();", - "```" - ] - } - }, - "selectedRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在の選択状態を取得します。", - "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", - "```typescript", - "const selectedRows = this.grid.selectedRows();", - "```" - ] - } - }, - "selectRows": { - "comment": { - "parameters": { - "clearCurrentSelection": { - "comment": { - "text": "True の場合、現在の選択をクリアします。" - } - } - }, - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択します。", - "```typescript", - "this.grid.selectRows([1,2,5], true);", - "```" - ] - } - }, - "deselectRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "指定した行を ID によって選択解除します。", - "```typescript", - "this.grid.deselectRows([1,2,5]);", - "```" - ] - } - }, - "selectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.selectAllRows();", - "this.grid.selectAllRows(false);", - "```" - ] - } - }, - "deselectAllRows": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての行を選択解除します。", - "注: デフォルトで、フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", - "パラメーター onlyFilterData を false に設定する場合、削除された行を除くグリッド内のすべての行が選択されます。", - "```typescript", - "this.grid.deselectAllRows();", - "```" - ] - } - }, - "navigateTo": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "このメソッドは提供された `rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置にナビゲートすることを可能にし、{targetType：GridKeydownTargetType、target：Object} を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。", - "```typescript", - " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", - "```" - ] - } - }, - "getNextCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "getPreviousCell": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。", - "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", - "コールバック関数は、引数として IgxColumnComponent を受け入れます。", - "```typescript", - " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", - "```" - ] - } - }, - "endEdit": { - "comment": { - "tags": {}, - "text": [ - "イベントにバインドします。", - "```html", - "", - "```" - ], - "shortText": [ - "現在の行の行トランザクションを完成します。", - "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。" - ] - } - }, - "openAdvancedFilteringDialog": { - "comment": { - "shortText": "高度なフィルタリング ダイアログを開きます。" - } - }, - "closeAdvancedFilteringDialog": { - "comment": { - "parameters": { - "applyChanges": { - "comment": { - "text": "変更を適用する必要があるかどうかを示します。" - } - } - }, - "tags": {}, - "shortText": "高度なフィルタリング ダイアログを閉じます。" - } - } - }, - "accessors": { - "id": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", - "```html", - "", - "```" - ] - } - } - }, - "data": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxTreeGridComponent` にデータの配列をインポートする @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxTreeGridComponent` にデータの配列をインポートする @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "filteredData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター済みデータを含むオブジェクトの配列を返します。", - "```typescript", - "let filteredData = this.grid.filteredData;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター済みデータを含むオブジェクトの配列を設定します。", - "```typescript", - "this.grid.filteredData = [{", - " ID: 1,", - " Name: \"A\"", - "}];", - "```" - ] - } - } - }, - "transactions": { - "getter": { - "comment": { - "tags": { - "experimental": { - "comment": { - "text": "@hidden", - "tagName": "試験段階" - } - } - }, - "shortText": "グリッドのトランザクション サービスを取得します。" - } - } - }, - "expansionDepth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxTreeGridComponent` で展開されるレベルの数を設定する @Input プロパティ。デフォルトで `Infinity` に設定されて、つまりすべてのレベルは展開されます。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxTreeGridComponent` で展開されるレベルの数を設定する @Input プロパティ。デフォルトで `Infinity` に設定されて、つまりすべてのレベルは展開されます。", - "```html", - "", - "```" - ] - } - } - }, - "rowLoadingIndicatorTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTreeGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "", - "", - "```" - ], - "shortText": [ - "ロードオンデマンドが有効になっているときに行ローディング インジケーターのテンプレートを提供する @Input プロパティ。", - "```html", - "", - " loop", - "" - ] - } - }, - "setter": { - "comment": { - "text": [ - "", - "", - "```" - ], - "shortText": [ - "ロードオンデマンドが有効になっているときに行ローディング インジケータのテンプレートを提供する @Input プロパティ。", - "```html", - "", - " loop", - "" - ] - } - } - }, - "resourceStrings": { - "setter": { - "comment": { - "shortText": [ - "リソース文字列を設定するアクセサー。", - "デフォルトで EN リソースを使用します。" - ] - } - }, - "getter": { - "comment": { - "shortText": "リソース文字列を返すアクセサー。" - } - } - }, - "filteringLogic": { - "getter": { - "comment": { - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルター ロジックを設定します。", - "デフォルト値は AND です。", - "```html", - "", - "```" - ] - } - } - }, - "filteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を返します。", - "```typescript", - "let filteringExpressionsTree = this.grid.filteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And, \"ID\");", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " }", - "];", - "this.grid.filteringExpressionsTree = (logic);", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "advancedFilteringExpressionsTree": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を返します。", - "```typescript", - "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高度なフィルタリング状態を設定します。", - "```typescript", - "const logic = new FilteringExpressionsTree(FilteringLogic.And);", - "logic.filteringOperands = [", - " {", - " condition: IgxNumberFilteringOperand.instance().condition('greaterThan'),", - " fieldName: 'ID',", - " searchVal: 1", - " },", - " {", - " condition: IgxStringFilteringOperand.instance().condition('contains'),", - " fieldName: 'CompanyName',", - " searchVal: 'a'", - " }", - "];", - "this.grid.advancedFilteringExpressionsTree = logic;", - "```" - ] - } - } - }, - "locale": { - "getter": { - "comment": { - "shortText": [ - "グリッドのロケールを返します。", - "設定されていない場合、ブラウザーの言語設定を返します。" - ] - } - }, - "setter": { - "comment": { - "shortText": "グリッドのロケールを設定します。" - } - } - }, - "paging": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能が有効または無効かどうかを返します。", - "デフォルト状態は無効 (false) です。", - "```", - "const paging = this.grid.paging;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ページング機能を有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "page": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ インデックスを返します。", - "```html", - "let gridPage = this.grid.page;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページ 指数を返します。", - "```html", - "", - "```", - "双方向データ バインディング。", - "```html", - "", - "```" - ] - } - } - }, - "perPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を返します。", - "デフォルトは 15 です。", - "```html", - "let itemsPerPage = this.grid.perPage;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` でページごとに表示される項目の数を設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnHiding": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを返します。", - "デフォルトで無効 (false) に設定されます。", - "```typescript", - "let gridColHiding = this.grid.columnHiding;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列非表示 UI が有効かどうかを設定します。", - "UI を操作するには、以下の例のようにツールバーを有効にする必要があります。.", - "```html", - "", - "```" - ] - } - } - }, - "hideRowSelectors": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "行セレクターが非表示されている場合は true を返します。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行セレクターの可視性を変更できます。", - "デフォルトでは、行セレクターが表示されます。" - ] - } - } - }, - "rowDraggable": { - "getter": { - "comment": { - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を移動できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "rowEditable": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` が編集可能かどうかを設定します。", - "デフォルトで false に設定されます。", - "```typescript", - "let rowEditable = this.grid.rowEditable;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行を編集できるかどうかを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "height": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを返します。", - "```typescript", - "let gridHeight = this.grid.height;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "width": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の幅を返します。", - "```typescript", - "let gridWidth = this.grid.width;", - "```" - ] - } - } - }, - "headerWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のヘッダーの幅を返します。", - "```html", - "let gridHeaderWidth = this.grid.headerWidth;", - "```" - ] - } - } - }, - "rowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを返します。", - "```typescript", - "const rowHeight = this.grid.rowHeight;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行の高さを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "columnWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "`IgxGridComponent` の列のデフォルト幅を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - } - }, - "emptyGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがない場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "isLoading": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドは読み込みインジケータを表すかどうかを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "グリッドは読み込みインジケータを表すかどうかを返すアクセサー。" - } - } - }, - "emptyFilteredGridMessage": { - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "getter": { - "comment": { - "shortText": "レコードがなく、グリッドがフィルターされた場合に表示されるメッセージを返すアクセサー。" - } - } - }, - "columnPinning": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを返します。", - "```typescript", - " let colPinning = this.grid.columnPinning;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "定義済みの列固定 UI をツールバーに表示するかどうかを設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうかを返します。", - "```typescript", - " let filtering = this.grid.allowFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルタリングが有効かどうか設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "allowAdvancedFiltering": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "高度なフィルタリングが有効かどうかを示す値を返します。", - "```typescript", - " let filtering = this.grid.allowAdvancedFiltering;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "拡張フィルタリングが有効かどうかを示す値を設定します。", - "デフォルトで無効です。", - "```html", - "", - "```" - ] - } - } - }, - "filterMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを返します。", - "```typescript", - " let filtering = this.grid.filterMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルター モードを設定します。", - "デフォルトで FilterMode.quickFilter に設定されます。", - "```html", - "", - "```" - ] - } - } - }, - "summaryPosition": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を返します。", - "```typescript", - " let summaryPosition = this.grid.summaryPosition;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計位置を設定します。", - "デフォルトは bottom です。", - "```html", - "", - "```" - ] - } - } - }, - "summaryCalculationMode": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを返します。", - "```typescript", - " let summaryCalculationMode = this.grid.summaryCalculationMode;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "集計計算モードを設定します。", - "デフォルトは rootAndChildLevels で、集計はルート レベルと各子レベルが計算されます。", - "```html", - "", - "```" - ] - } - } - }, - "filterStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを取得します。", - "```typescript", - " let filterStrategy = this.grid.filterStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドのフィルタリング ストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "sortStrategy": { - "getter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを取得します。", - "```typescript", - " let sortStrategy = this.grid.sortStrategy", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "グリッドの並べ替えストラテジを設定します。", - "```html", - " ", - "```" - ] - } - } - }, - "headerGroupsList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderGroupComponent` のリスト。", - "```typescript", - "const headerGroupsList = this.grid.headerGroupsList;", - "```" - ] - } - } - }, - "headerCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridHeaderComponent` のリスト。", - "```typescript", - "const headers = this.grid.headerCellList;", - "```" - ] - } - } - }, - "filterCellList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "すべての `IgxGridFilteringCellComponent` のリスト。", - "```typescript", - "const filterCells = this.grid.filterCellList;", - "```" - ] - } - } - }, - "rowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridRowComponent` のリスト。", - "```typescript", - "const rowList = this.grid.rowList;", - "```" - ] - } - } - }, - "dataRowList": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在描画されている `IgxGridRowComponent` のリスト。", - "```typescript", - "const dataList = this.grid.dataRowList;", - "```" - ] - } - } - }, - "toolbarCustomContentTemplate": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。", - "```typescript", - "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", - "```" - ] - } - } - }, - "dragIndicatorIconTemplate": { - "getter": { - "comment": { - "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - }, - "setter": { - "comment": { - "shortText": "Tカスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" - } - } - }, - "sortingExpressions": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を返します。", - "```typescript", - "const sortingState = this.grid.sortingExpressions;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "```" - ], - "shortText": [ - "`IgxGridComponent` の並べ替え状態を設定します。", - "```typescript", - "this.grid.sortingExpressions = [{", - " fieldName: \"ID\",", - " dir: SortingDirection.Desc,", - " ignoreCase: true", - "}];", - "```" - ] - } - } - }, - "hiddenColumnsCount": { - "getter": { - "comment": { - "shortText": [ - "非表示の `IgxColumnComponent` の数を返します。", - "```typescript", - "const hiddenCol = this.grid.hiddenColumnsCount;", - "``" - ] - } - } - }, - "hiddenColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const hiddenColText = this.grid.hiddenColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列非表示 UI のトグル ボタンに表示されるテキストを設定します。", - "```typescript", - "", - "```" - ] - } - } - }, - "pinnedColumnsText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを返します。", - "```typescript", - "const pinnedText = this.grid.pinnedColumnsText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxColumnComponent` の定義済みの列ピン固定 UI のトグル ボタンに表示されるテキストを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "showToolbar": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーが表示されるかどうかを返します。", - "```typescript", - "const toolbarGrid = this.grid.showToolbar;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のツールバーを表示または非表示にします。", - "```html", - "", - "```" - ] - } - } - }, - "toolbarTitle": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを返します。", - "```typescript", - "const toolbarTitle = this.grid.toolbarTitle;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ツールバーのタイトルを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcel": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "cosnt excelExporter = this.grid.exportExcel;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Excel へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsv": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションが有効かどうかを返します。", - "```typescript", - "const exportCsv = this.grid.exportCsv;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV へのエクスポート オプションを有効または無効にします。", - "```html", - "", - "```" - ] - } - } - }, - "exportText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const exportText = this.grid.exportText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportExcelText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const excelText = this.grid.exportExcelText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "MS Export エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "exportCsvText": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを返します。", - "```typescript", - "const csvText = this.grid.exportCsvText;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "CSV エクスポート ボタンのテキスト コンテンツを設定します。", - "```html", - "", - "```" - ] - } - } - }, - "cellSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "セル選択モードを設定できます。", - "デフォルトでは、セル選択モードは複数です。" - ] - } - } - }, - "rowSelection": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": "現在のセル選択状態を返します。これは、none、single、または multiple になります。" - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "行選択モードを設定できます。", - "デフォルトのヘッダーのサイズ設定モードは none です。" - ] - } - } - }, - "expansionStates": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを返します。デフォルト状態に異なる状態のみ含まれます。", - "```typescript", - "const expansionStates = this.grid.expansionStates;", - "```" - ] - } - }, - "setter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "text": [ - "双方向データ バインディング。", - "```html", - "", - "", - "
", - "
{{dataItem.Category?.CategoryName}}
", - "{{dataItem.Category?.Description}}", - "
", - "", - "", - "```" - ], - "shortText": [ - "キーと値のペア [行 Id、展開状態] のリストを設定します。", - "```typescript", - "const states = new Map();", - "states.set(1, true);", - "this.grid.expansionStates = states;", - "```" - ] - } - } - }, - "nativeElement": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` のネイティブ要素を返します。", - "```typescript", - "const nativeEl = this.grid.nativeElement.", - "```" - ] - } - } - }, - "defaultRowHeight": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の行高さを返します。", - "```typescript", - "const rowHeigh = this.grid.defaultRowHeight;", - "```" - ] - } - } - }, - "defaultHeaderGroupMinWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridHeaderGroupComponent` の最小許容幅を返します。", - "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", - "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" - ] - } - } - }, - "pinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を返します。", - "```typescript", - "const pinnedWidth = this.grid.getPinnedWidth;", - "```" - ] - } - } - }, - "unpinnedWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定の `IgxColumnComponent` のコンテナーの最大幅を返します。", - "```typescript", - "const unpinnedWidth = this.grid.getUnpinnedWidth;", - "```" - ] - } - } - }, - "columns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const colums = this.grid.columns.", - "```" - ] - } - } - }, - "pinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピン固定される `IgxColumnComponent` の配列を返します。", - "```typescript", - "const pinnedColumns = this.grid.pinnedColumns.", - "```" - ] - } - } - }, - "unpinnedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ピンが解除されている IgxColumnComponent` の配列を返します。", - "```typescript", - "const unpinnedColumns = this.grid.unpinnedColumns.", - "```" - ] - } - } - }, - "visibleColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxChipComponent` の配列を返します。", - "```typescript", - "const visibleColumns = this.grid.visibleColumns.", - "```" - ] - } - } - }, - "totalPages": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計ページ数を返します。", - "```typescript", - "const totalPages = this.grid.totalPages;", - "```" - ] - } - } - }, - "isFirstPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最初のページかどうかを返します。", - "```typescript", - "const firstPage = this.grid.isFirstPage;", - "```" - ] - } - } - }, - "totalRecords": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "合計レコード数を返します。", - "ページングが有効な場合のみ動作します。", - "```typescript", - "const totalRecords = this.grid.totalRecords;", - "```" - ] - } - } - }, - "isLastPage": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のページが最後のページかどうかを返します。", - "```typescript", - "const lastPage = this.grid.isLastPage;", - "```" - ] - } - } - }, - "totalWidth": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` の合計幅を返します。", - "```typescript", - "const gridWidth = this.grid.totalWidth;", - "```" - ] - } - } - }, - "hasSortableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。", - "```typescript", - "const sortableGrid = this.grid.hasSortableColumns;", - "```" - ] - } - } - }, - "hasEditableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に編集可能な列があるかどうかを返します。", - "```typescript", - "const editableGrid = this.grid.hasEditableColumns;", - "```" - ] - } - } - }, - "hasFilterableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。", - "```typescript", - "const filterableGrid = this.grid.hasFilterableColumns;", - "```" - ] - } - } - }, - "hasSummarizedColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に集計可能な列があるかどうかを返します。", - "```typescript", - "const summarizedGrid = this.grid.hasSummarizedColumns;", - "```" - ] - } - } - }, - "hasMovableColumns": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に移動可能な列があるかどうかを返します。", - "```typescript", - "const movableGrid = this.grid.hasMovableColumns;", - "```" - ] - } - } - }, - "hasColumnGroups": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` に列グループがあるかどうかを返します。", - "```typescript", - "const groupGrid = this.grid.hasColumnGroups;", - "```" - ] - } - } - }, - "hasColumnLayouts": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。", - "```typescript", - "const layoutGrid = this.grid.hasColumnLayouts;", - "```" - ] - } - } - }, - "selectedCells": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`IgxGridCellComponent` 選択されているメモの配列を返します。", - "```typescript", - "const selectedCells = this.grid.selectedCells;", - "```" - ] - } - } - }, - "dataView": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。", - "```typescript", - " const dataView = this.grid.dataView;", - "```" - ] - } - } - }, - "filteredSortedData": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxGridBaseDirective", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": [ - "フィルターされて並べ替え済みのデータを含む配列を返します。", - "```typescript", - "const filteredSortedData = this.grid1.filteredSortedData;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/icon/IgxIconComponent.json b/typedoc/ja/lib/icon/IgxIconComponent.json deleted file mode 100644 index db763f0b..00000000 --- a/typedoc/ja/lib/icon/IgxIconComponent.json +++ /dev/null @@ -1,210 +0,0 @@ -{ - "IgxIconComponent": { - "properties": { - "cssClass": { - "comment": { - "shortText": [ - " `class.igx-icon` の値を変更できます。デフォルト値は `igx-icon` です。", - "```typescript", - "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", - "constructor(private cdRef:ChangeDetectorRef) {}", - "ngAfterViewInit() {", - " this.icon.cssClass = \"\";", - " this.cdRef.detectChanges();", - "}", - "```" - ] - } - }, - "ariaHidden": { - "comment": { - "shortText": [ - " `aria-hidden` 属性を無効にできます。デフォルトでクラスが適用されます。", - "```typescript", - "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", - "constructor(private cdRef:ChangeDetectorRef) {}", - "ngAfterViewInit() {", - " this.icon.ariaHidden = false;", - " this.cdRef.detectChanges();", - "}", - "```" - ] - } - }, - "id": { - "comment": { - "shortText": [ - " `id` 属性の値を設定する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "font": { - "comment": { - "shortText": [ - " `fontSet` の値を設定する @Input プロパティ。デフォルトは、\"material\" です。", - "```html", - "", - "```" - ] - } - }, - "active": { - "comment": { - "shortText": [ - " `active` プロパティの無効化を許可する @Input プロパティ。デフォルトでクラスが適用されます。", - "```html", - "", - "```" - ] - } - }, - "iconColor": { - "comment": { - "shortText": [ - " アイコンの `iconColor` の変更を許可する @Input プロパティ。", - "```html", - "", - "```" - ] - } - }, - "iconName": { - "comment": { - "shortText": [ - " アイコンの `iconName` の変更を許可する @Input プロパティ。", - " `name` を使用して `iconName` を設定できます。", - "```html", - "", - "```" - ] - } - }, - "el": { - "comment": { - "shortText": [ - "`igx-icon` コンポーネントの ElementRef プロパティ。" - ] - } - } - }, - "methods": {}, - "accessors": { - "getFontSet": { - "getter": { - "comment": { - "shortText": [ - " font プロパティの値を返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconFont = this.icon.getFontSet;", - "}", - "```" - ] - } - } - }, - "getActive": { - "getter": { - "comment": { - "shortText": [ - " active プロパティの値を返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconActive = this.icon.getActive;", - "}", - "```" - ] - } - } - }, - "getInactive": { - "getter": { - "comment": { - "shortText": [ - " inactive プロパティを返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconActive = this.icon.getInactive;", - "}", - "```" - ] - } - } - }, - "getIconColor": { - "getter": { - "comment": { - "shortText": [ - " `iconColor` プロパティの逆値を返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconColor = this.icon.getIconColor;", - "}", - "```" - ] - } - } - }, - "getIconName": { - "getter": { - "comment": { - "shortText": [ - " iconName プロパティの値を返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconName = this.icon.getIconName;", - "}", - "```" - ] - } - } - }, - "getSvgKey": { - "getter": { - "comment": { - "shortText": [ - " SVG 画像のキーを返すアクセサー。", - " アンダースコアで区切られた fontSet と iconName で構成されるキー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let svgKey = this.icon.getSvgKey;", - "}", - "```" - ] - } - } - }, - "template": { - "getter": { - "comment": { - "shortText": [ - " 明示的、暗黙、またはなしの合字を参照する TemplateRef を返すアクセサー。", - "```typescript", - "@ViewChild(\"MyIcon\")", - "public icon: IgxIconComponent;", - "ngAfterViewInit() {", - " let iconTemplate = this.icon.template;", - "}", - "```" - ] - } - } - } - } - } -} diff --git a/typedoc/ja/lib/list/IgxListComponent.json b/typedoc/ja/lib/list/IgxListComponent.json deleted file mode 100644 index 6f11e038..00000000 --- a/typedoc/ja/lib/list/IgxListComponent.json +++ /dev/null @@ -1,414 +0,0 @@ -{ - "IgxListComponent": { - "properties": { - "children": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストのすべての項目およびヘッダーのコレクションを返します。", - "```typescript", - "let listChildren: QueryList = this.list.children;", - "```" - ] - } - }, - "emptyListTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リスト項目を定義せずに `isLoading` を `true` に設定した場合に IgxList で使用されるテンプレートを返します", - "```typescript", - "let emptyTemplate = this.list.emptyListTemplate;", - "```" - ] - } - }, - "dataLoadingTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リスト項目を定義せずに `isLoading` を `true` に設定した場合に IgxList で使用されるテンプレートを返します。", - "```typescript", - "let loadingTemplate = this.list.dataLoadingTemplate;", - "```" - ] - } - }, - "listItemLeftPanningTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リスト項目の左パンニング時に表示されるテンプレートの base 要素を参照を提供します。", - "デフォルト値は `null` です。", - "```html", - " ", - "```", - "```typescript", - "let itemLeftPanTmpl = this.list.listItemLeftPanningTemplate;", - "```" - ] - } - }, - "listItemRightPanningTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リスト項目の右パンニング時に表示されるテンプレートの base 要素を参照を提供します。", - "デフォルト値は `null` です。", - "```html", - " ", - "```", - "```typescript", - "let itemRightPanTmpl = this.list.listItemRightPanningTemplate;", - "```" - ] - } - }, - "panEndTriggeringThreshold": { - "comment": { - "shortText": [ - "項目のパンニングが自動的に完了した後にしきい値を提供します。", - "このプロパティのデフォルトは0.5 でリスト項目幅の 50% を意味します。", - "```typescript", - "this.list.panEndTriggeringThreshold = 0.8;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストの `id` を取得または設定します。", - "設定しない場合、最初のリスト コンポーネントの `id` は `\"igx-list-0\"` になります。", - "```html", - "", - "```", - "```typescript", - "let listId = this.list.id;", - "```" - ] - } - }, - "allowLeftPanning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "項目の左パンニングが許可されるかどうかを取得または設定します。", - "デフォルト値は `false` です。", - "```html", - " ", - "```", - "```typescript", - "let isLeftPanningAllowed = this.list.allowLeftPanning;", - "```" - ] - } - }, - "allowRightPanning": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "項目の右パンニングが許可されるかどうかを取得または設定します。", - "デフォルト値は `false` です。", - "```html", - " ", - "```", - "```typescript", - "let isRightPanningAllowed = this.list.allowRightPanning;", - "```" - ] - } - }, - "isLoading": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストがデータを読み込んでいるかどうかを取得または設定します。", - "データの取得中に dataLoadingTemplate を表示するために設定します。", - "デフォルト値は `false` です。", - "```html", - " ", - "```", - "```typescript", - "let isLoading = this.list.isLoading;", - "```" - ] - } - }, - "onLeftPan": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "左パンニング ジェスチャがリスト項目に実行されたときに現在のリストでイベントを発生します。", - "イベント引数としてタイプ `IListItemPanningEventArgs` のオブジェクトへの参照を提供します。", - "```html", - "", - "```" - ] - } - }, - "onRightPan": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "右パンニング ジェスチャがリスト項目に実行されたときに現在のリストでイベントを発生します。", - "イベント引数としてタイプ `IListItemPanningEventArgs` のオブジェクトへの参照を提供します。", - "```html", - "", - "```" - ] - } - }, - "onPanStateChange": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "パンニング ジェスチャがリスト項目に実行されたときに現在のリストでイベントを発生します。", - "イベント引数として `IgxListItemComponent` および `IgxListPanState` への参照を提供します。", - "```html", - "", - "```" - ] - } - }, - "onItemClicked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リスト項目がクリックされたときに現在のリストでイベントを発生します。", - "イベント引数として `IgxListItemComponent` および `Event` への参照を提供します。", - " ```html", - "", - "```" - ] - } - } - }, - "methods": {}, - "accessors": { - "role": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`role` 属性を取得します。", - "```typescript", - "let listRole = this.list.role;", - "```" - ] - } - } - }, - "isListEmpty": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストが空かどうかを示すブール値を返します。", - "```typescript", - "let isEmpty = this.list.isListEmpty;", - "```" - ] - } - } - }, - "items": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストのヘッダー以外の `items` を返します。", - "```typescript", - "let listItems: IgxListItemComponent[] = this.list.items;", - "```" - ] - } - } - }, - "headers": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リストのヘッダーを返します。", - "```typescript", - "let listHeaders: IgxListItemComponent[] = this.list.headers;", - "```" - ] - } - } - }, - "context": { - "getter": { - "comment": { - "shortText": [ - "`IgxListComponent` である $implicit 宣言を提供して `list container` への `template context` バインディングを表す `context` オブジェクトを返します。", - "```typescript", - "let listComponent = this.list.context;", - "```" - ] - } - } - }, - "template": { - "getter": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxListComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "空のリストの `template` を返します。", - "```typescript", - "let listTemplate = this.list.template;", - "```" - ] - } - } - }, - "displayDensity": { - "getter": { - "comment": { - "shortText": [ - "コンポーネントのテーマを返します。", - "デフォルト テーマは `comfortable` です。", - "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", - "```typescript", - "let componentTheme = this.component.displayDensity;", - "```" - ] - } - }, - "setter": { - "comment": { - "shortText": "コンポーネントのテーマを設定します。" - } - } - } - } - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/services/OverlayAnimationEventArgs.json b/typedoc/ja/lib/services/OverlayAnimationEventArgs.json deleted file mode 100644 index d7d80a5b..00000000 --- a/typedoc/ja/lib/services/OverlayAnimationEventArgs.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "OverlayAnimationEventArgs": { - "properties": { - "id": { - "comment": { - "shortText": [ - "`Attach()` メソッドで生成されたオーバーレイの id。" - ] - } - }, - "animationPlayer": { - "comment": { - "shortText": [ - "アニメーションを再生するアニメーション プレーヤー。" - ] - } - }, - "animationType": { - "comment": { - "shortText": [ - "再生するアニメーションのタイプ。有効な値は 'open' または 'close' です。" - ] - } - }, - "owner": { - "comment": { - "shortText": "オーナー コンポーネントへの参照を提供します。" - } - } - }, - "methods": {} - } -} diff --git a/typedoc/ja/lib/services/OverlayCancelableEventArgs.json b/typedoc/ja/lib/services/OverlayCancelableEventArgs.json deleted file mode 100644 index 02dab3e5..00000000 --- a/typedoc/ja/lib/services/OverlayCancelableEventArgs.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "OverlayCancelableEventArgs": { - "properties": { - "id": { - "comment": { - "shortText": "`Attach()` メソッドで生成されたオーバーレイの id。" - } - }, - "componentRef": { - "comment": { - "shortText": "`Type` が `attach()` メソッドに提供された場合に利用可能で、作成されたコンポーネント インスタンスへのアクセスを許可します。" - } - }, - "owner": { - "comment": { - "shortText": "オーナー コンポーネントへの参照を提供します。" - } - }, - "cancel": { - "comment": { - "shortText": "イベントをキャンセルする機能を提供します。" - } - } - }, - "methods": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/services/OverlayClosingEventArgs.json b/typedoc/ja/lib/services/OverlayClosingEventArgs.json deleted file mode 100644 index 1d97e20b..00000000 --- a/typedoc/ja/lib/services/OverlayClosingEventArgs.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "OverlayClosingEventArgs": { - "properties": { - "id": { - "comment": { - "shortText": "`Attach()` メソッドで生成されたオーバーレイの id。" - } - }, - "componentRef": { - "comment": { - "shortText": "`Type` が `attach()` メソッドに提供された場合に利用可能で、作成されたコンポーネント インスタンスへのアクセスを許可します。" - } - }, - "owner": { - "comment": { - "shortText": "オーナー コンポーネントへの参照を提供します。" - } - }, - "event": { - "comment": { - "shortText": "ブラウザー イベント。" - } - }, - "cancel": { - "comment": { - "shortText": "イベントをキャンセルする機能を提供します。" - } - } - }, - "methods": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/services/OverlayEventArgs.json b/typedoc/ja/lib/services/OverlayEventArgs.json deleted file mode 100644 index a2effe9d..00000000 --- a/typedoc/ja/lib/services/OverlayEventArgs.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "OverlayEventArgs": { - "properties": { - "id": { - "comment": { - "shortText": [ - "`Attach()` メソッドで生成されたオーバーレイの id。" - ] - } - }, - "componentRef": { - "comment": { - "shortText": [ - "`Type` が `attach()` メソッドに提供された場合に利用可能で、作成されたコンポーネント インスタンスへのアクセスを許可します。" - ] - } - }, - "owner": { - "comment": { - "shortText": "オーナー コンポーネントへの参照を提供します。" - } - } - }, - "methods": {} - } -} diff --git a/typedoc/ja/lib/services/OverlaySettings.json b/typedoc/ja/lib/services/OverlaySettings.json deleted file mode 100644 index f466d34c..00000000 --- a/typedoc/ja/lib/services/OverlaySettings.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "OverlaySettings": { - "properties": { - "positionStrategy": { - "comment": { - "shortText": "この設定で使用する配置ストラテジー。" - } - }, - "scrollStrategy": { - "comment": { - "shortText": "この設定で使用するスクロール ストラテジー。" - } - }, - "modal": { - "comment": { - "shortText": "オーバーレイをモーダル モードにするかどうかを設定します。" - } - }, - "closeOnOutsideClick": { - "comment": { - "shortText": "オーバーレイが外側のクリックで閉じられるかどうかを設定します。" - } - }, - "outlet": { - "comment": { - "shortText": "オーバーレイをアタッチするアウトレット コンテナを設定します。" - } - } - }, - "methods": {} - } -} \ No newline at end of file diff --git a/typedoc/ja/lib/switch/IgxSwitchComponent.json b/typedoc/ja/lib/switch/IgxSwitchComponent.json deleted file mode 100644 index cfe86423..00000000 --- a/typedoc/ja/lib/switch/IgxSwitchComponent.json +++ /dev/null @@ -1,412 +0,0 @@ -{ - "IgxSwitchComponent": { - "comment": { - "text": [ - "Ignite UI Switch はオン/オフまたは true/false 状態の間に切り替えます。", - "例:", - "```html", - "", - " 簡易な switch", - "", - "```" - ], - "shortText": [ - "**Ignite UI for Angular Switch** -", - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/switch.html)" - ] - }, - "properties": { - "nativeCheckbox": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ネイティブ チェックボックス要素への参照を返します。", - "```typescript", - "let checkboxElement = this.switch.nativeCheckbox;", - "```" - ] - } - }, - "nativeLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ネイティブ ラベル要素への参照を返します。", - "```typescript", - "let labelElement = this.switch.nativeLabel;", - "```" - ] - } - }, - "placeholderLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "ラベル プレースホルダー要素への参照を返します。", - "```typescript", - "let labelPlaceholder = this.switch.placeholderLabel;", - "```" - ] - } - }, - "id": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントの `id` を取得または設定します。", - "設定されない場合、最初の switch コンポーネントの `id` は `\"igx-switch-0\"` になります。", - "```html", - "", - "```", - "```typescript", - "let switchId = this.switch.id;", - "```" - ] - } - }, - "labelId": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントで `label` 要素の id を取得または設定します。", - "設定されない場合、最初の switch コンポーネントのラベルの値は `\"igx-switch-0-label\"` になります。", - "```html", - "", - "```", - "```typescript", - "let labelId = this.switch.labelId;", - "```" - ] - } - }, - "value": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントの `value` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let value = this.switch.value;", - "```" - ] - } - }, - "name": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントの `name` 属性を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let name = this.switch.name;", - "```" - ] - } - }, - "tabindex": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`tabindex` 属性の値を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let tabIndex = this.switch.tabindex;", - "```" - ] - } - }, - "labelPosition": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントの `label` の位置を取得または設定します。", - "設定されない場合、`labelPosition` の値は `\"after\"` です。", - "```html", - "", - "```", - "```typescript", - "let labelPosition = this.switch.labelPosition;", - "```" - ] - } - }, - "disableRipple": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "リップル エフェクトを有効または無効にします。", - "設定されない場合、`disableRipple` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRippleDisabled = this.switch.disableRipple;", - "```" - ] - } - }, - "required": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch が必須かどうかを取得または設定します。", - "設定されない場合、`required` の値は `false` です。", - "```html", - "", - "```", - "```typescript", - "let isRequired = this.switch.required;", - "```" - ] - } - }, - "ariaLabelledBy": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`aria-labelledBy` 属性を取得または設定します。", - "設定されない場合、`aria-labelledBy` の値は `labelId` 属性の値と等しくなります。", - "```html", - "", - "```", - "```typescript", - "let ariaLabelledBy = this.switch.ariaLabelledBy;", - "```" - ] - } - }, - "ariaLabel": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`aria-label` 属性の値を取得または設定します。", - "```html", - "", - "```", - "```typescript", - "let ariaLabel = this.switch.ariaLabel;", - "```" - ] - } - }, - "change": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch 状態が変更された後に発生するイベント。", - "イベント引数として `IgxSwitchComponent` および `checked` プロパティへの参照を提供します。" - ] - } - }, - "cssClass": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントのクラスを返します。", - "```typescript", - "let switchClass = this.switch.cssClass;", - "```" - ] - } - }, - "checked": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch がオンまたはオフかどうかを取得または設定します。", - "デフォルトは 'false' です。", - "```html", - " ", - "```", - "```typescript", - "let isChecked = this.switch.checked;", - "```" - ] - } - }, - "disabled": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "`disabled` 属性を取得または設定します。", - "デフォルトは `false` です。", - "```html", - "", - "```", - "```typescript", - "let isDisabled = this.switch.disabled;", - "```" - ] - } - }, - "focused": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "switch コンポーネントがフォーカスされるかどうかを取得または設定します。", - "デフォルトは `false` です。", - "```typescript", - "this.switch.focused = true;", - "```", - "```typescript", - "let isFocused = this.switch.focused;", - "```" - ] - } - } - }, - "methods": { - "toggle": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxSwitchComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "スイッチのチェックされた状態を切り替えます。", - "```typescript", - "this.switch.toggle();", - "```" - ] - } - } - }, - "accessors": {} - } -} diff --git a/typedoc/ja/lib/avatar/IgxAvatarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/avatar/IgxAvatarComponent.json similarity index 100% rename from typedoc/ja/lib/avatar/IgxAvatarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/avatar/IgxAvatarComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json new file mode 100644 index 00000000..d85a00f5 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeComponent.json @@ -0,0 +1,215 @@ +{ + "IgxBadgeComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxBadgeModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-badge-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "badge, icon, notification", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "Ignite UI Badge は、視覚的な通知が必要な場合にアプリケーションでアバター、ナビゲーション メニュー、またはその他のコンポーネントをデコレートするために使用されます。情報、成功、警告、またはエラーを表示するために定義済みのスタイルを持つアイコンとしてデザインされます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "" + ], + "tagName": "例" + } + } + }, + "shortText": "アバターやメニューなどをデコレートするために使用される視覚的な通知を提供します。" + }, + "properties": { + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定しない場合、`id` は `\"igx-badge-0\"` 値を持ちます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "バッジの `id` を設定または取得します。" + } + }, + "type": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "有効な値は `primary`、 `info`、 `success`、`warning` および `error` です。", + "無効な値を設定すると、バッジは表示されません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "バッジのタイプを設定または取得します。" + } + }, + "value": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`icon` プロパティが設定される場合、`icon` が表示されます。", + "`value` および `icon` が設定されない場合、バッジのコンテンツは空になります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "バッジで表示する値を設定または取得します。" + } + }, + "icon": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`value` プロパティより優先されます。", + "`value` および `icon` が設定されない場合、バッジのコンテンツは空になります。", + "無効な値を設定すると、コンテンツは表示されません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "マテリアル アイコン セットからバッジのアイコンを設定または取得します。" + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.role = 'status';", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "role 属性の値を設定または取得します。" + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.cssClass = 'my-badge-class';", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "バッジで使用する CSS クラスを設定または取得します。" + } + }, + "label": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyBadge\", { read: IgxBadgeComponent })", + "public badge: IgxBadgeComponent;", + "badge.label = 'badge';", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "aria-label 属性の値を設定または取得します。" + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json b/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json new file mode 100644 index 00000000..cfff7882 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/badge/IgxBadgeType.json @@ -0,0 +1,8 @@ +{ + "IgxBadgeType": { + "comment": { + "shortText": "igxBadge のタイプを決定します。" + }, + "members": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/banner/BannerCancelEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/banner/BannerCancelEventArgs.json similarity index 100% rename from typedoc/ja/lib/banner/BannerCancelEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/banner/BannerCancelEventArgs.json diff --git a/typedoc/ja/lib/banner/BannerEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/banner/BannerEventArgs.json similarity index 100% rename from typedoc/ja/lib/banner/BannerEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/banner/BannerEventArgs.json diff --git a/typedoc/ja/lib/banner/IgxBannerComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/banner/IgxBannerComponent.json similarity index 100% rename from typedoc/ja/lib/banner/IgxBannerComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/banner/IgxBannerComponent.json diff --git a/typedoc/ja/lib/buttonGroup/IButtonGroupEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/buttonGroup/IButtonGroupEventArgs.json similarity index 100% rename from typedoc/ja/lib/buttonGroup/IButtonGroupEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/buttonGroup/IButtonGroupEventArgs.json diff --git a/typedoc/ja/lib/buttonGroup/IgxButtonGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/buttonGroup/IgxButtonGroupComponent.json similarity index 93% rename from typedoc/ja/lib/buttonGroup/IgxButtonGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/buttonGroup/IgxButtonGroupComponent.json index 4a63545c..6205b61e 100644 --- a/typedoc/ja/lib/buttonGroup/IgxButtonGroupComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/buttonGroup/IgxButtonGroupComponent.json @@ -125,14 +125,14 @@ }, "shortText": [ "インデックスでボタンを選択します。", - "```typescript", - "@ViewChild(\"MyChild\")", - "private buttonG: IgxButtonGroupComponent;", - "ngAfterViewInit(){", - " this.buttonG.selectButton(2);", - " this.cdr.detectChanges();", - "}", - "```" + "```typescript", + "@ViewChild(\"MyChild\")", + "private buttonG: IgxButtonGroupComponent;", + "ngAfterViewInit(){", + " this.buttonG.selectButton(2);", + " this.cdr.detectChanges();", + "}", + "```" ] } }, @@ -148,15 +148,15 @@ }, "shortText": [ "インデックスでボタンを選択解除します。", - "```typescript", - "@ViewChild(\"MyChild\")", - "private buttonG: IgxButtonGroupComponent;", - "ngAfterViewInit(){", - " this.buttonG.deselectButton(2);", - " this.cdr.detectChanges();", - "}", - "```" - ] + "```typescript", + "@ViewChild(\"MyChild\")", + "private buttonG: IgxButtonGroupComponent;", + "ngAfterViewInit(){", + " this.buttonG.deselectButton(2);", + " this.cdr.detectChanges();", + "}", + "```" + ] } } }, diff --git a/typedoc/ja/lib/calendar/Calendar.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/Calendar.json similarity index 96% rename from typedoc/ja/lib/calendar/Calendar.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/Calendar.json index 9370c55c..deb55951 100644 --- a/typedoc/ja/lib/calendar/Calendar.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/Calendar.json @@ -23,6 +23,7 @@ }, "monthdates": { "comment": { + "returns": "\n", "tags": { "memberof": { "comment": { @@ -39,6 +40,7 @@ }, "monthdatescalendar": { "comment": { + "returns": "\n", "tags": { "memberof": { "comment": { diff --git a/typedoc/ja/lib/calendar/CalendarSelection.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/CalendarSelection.json similarity index 100% rename from typedoc/ja/lib/calendar/CalendarSelection.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/CalendarSelection.json diff --git a/typedoc/ja/lib/calendar/CalendarView.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/CalendarView.json similarity index 100% rename from typedoc/ja/lib/calendar/CalendarView.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/CalendarView.json diff --git a/typedoc/ja/lib/calendar/IgxCalendarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json similarity index 97% rename from typedoc/ja/lib/calendar/IgxCalendarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json index b77a28a6..b18741bf 100644 --- a/typedoc/ja/lib/calendar/IgxCalendarComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/IgxCalendarComponent.json @@ -222,16 +222,16 @@ "setter": { "comment": { "tags": { - "example": { - "comment": { - "text": [ - "```html", - "", - "```" - ], - "tagName": "例" - } - }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, "memberof": { "comment": { "text": "IgxCalendarComponent", diff --git a/typedoc/ja/lib/calendar/IgxMonthPickerBaseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/IgxMonthPickerBaseDirective.json similarity index 100% rename from typedoc/ja/lib/calendar/IgxMonthPickerBaseDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/IgxMonthPickerBaseDirective.json diff --git a/typedoc/ja/lib/calendar/IgxDaysViewComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/days-view/IgxDaysViewComponent.json similarity index 100% rename from typedoc/ja/lib/calendar/IgxDaysViewComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/days-view/IgxDaysViewComponent.json diff --git a/typedoc/ja/lib/calendar/IgxMonthPickerComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/month-picker/IgxMonthPickerComponent.json similarity index 100% rename from typedoc/ja/lib/calendar/IgxMonthPickerComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/month-picker/IgxMonthPickerComponent.json diff --git a/typedoc/ja/lib/calendar/IgxMonthsViewComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/months-view/IgxMonthsViewComponent.json similarity index 100% rename from typedoc/ja/lib/calendar/IgxMonthsViewComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/months-view/IgxMonthsViewComponent.json diff --git a/typedoc/ja/lib/calendar/CalendarHammerConfig.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json similarity index 95% rename from typedoc/ja/lib/calendar/CalendarHammerConfig.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json index 2b59a11b..b174fc6d 100644 --- a/typedoc/ja/lib/calendar/CalendarHammerConfig.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/years-view/CalendarHammerConfig.json @@ -24,6 +24,7 @@ "methods": { "buildHammer": { "comment": { + "returns": "HammerJS イベント マネージャー オブジェクト。\n", "parameters": { "element": { "comment": { diff --git a/typedoc/ja/lib/calendar/IgxYearsViewComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/calendar/years-view/IgxYearsViewComponent.json similarity index 100% rename from typedoc/ja/lib/calendar/IgxYearsViewComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/calendar/years-view/IgxYearsViewComponent.json diff --git a/typedoc/ja/lib/card/IgxCardActionsComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json similarity index 72% rename from typedoc/ja/lib/card/IgxCardActionsComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json index b9d59314..e576a4ce 100644 --- a/typedoc/ja/lib/card/IgxCardActionsComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardActionsComponent.json @@ -6,13 +6,22 @@ "properties": { "layout": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, "shortText": [ "アクションのレイアウト スタイルを設定する @Input プロパティ。", "デフォルトでは、通常のボタンと同様にアイコンとアイコン ボタンは 2 つのコンテナに分割され、それらはカード アクション領域の両端に配置されます。", - "これらのグループ内の要素を両端揃えにし、カード アクション軸に沿って使用可能なスペースすべてを占めるように、それらが互いに均等に配置されるようにすることができます。", - "```html", - "", - "```" + "これらのグループ内の要素を両端揃えにし、カード アクション軸に沿って使用可能なスペースすべてを占めるように、それらが互いに均等に配置されるようにすることができます。" ] } }, @@ -26,6 +35,18 @@ }, "reverse": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, "shortText": [ "アクション領域のボタンの順序を設定する @Input プロパティ。", "デフォルトでは、すべてのアイコン/アイコン ボタンはアクション領域の最後に配置されています。通常のボタン (フラット、エンボス加工されたボタン) は、アクション領域に配置されているアイコン/アイコンボタンの前に表示されます。", diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardComponent.json new file mode 100644 index 00000000..efc1e25c --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardComponent.json @@ -0,0 +1,99 @@ +{ + "IgxCardComponent": { + "properties": { + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let cardId = this.card.id;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カードの `id` を取得または設定します。", + "設定しない場合、`id` は値 `\"igx-card-0\"` を持ちます。" + ] + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カードの `role` 属性の値を設定する @Input プロパティ。", + "デフォルトで値が `group` に設定されています。" + ] + } + }, + "type": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カードの `type` 属性の値を設定する @Input プロパティ。", + "デフォルトで値が `default` に設定されています。値を `outlined` に設定してカードでアウトライン スタイルを使用します。" + ] + } + }, + "horizontal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カードの `horizontal` 属性の値を設定する @Input プロパティ。", + "これを `true` に設定すると、異なるカード セクションが水平に並ぶようになり、カードを横に反転します。" + ] + } + } + }, + "methods": {}, + "accessors": { + "isOutlinedCard": { + "getter": { + "comment": { + "shortText": "カード型が `アウトライン` の場合に true を返すゲッター。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/card/IgxCardContentDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardContentDirective.json similarity index 99% rename from typedoc/ja/lib/card/IgxCardContentDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardContentDirective.json index 244f35a6..9d10337f 100644 --- a/typedoc/ja/lib/card/IgxCardContentDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardContentDirective.json @@ -7,4 +7,4 @@ "methods": {}, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json new file mode 100644 index 00000000..ddac313b --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardFooterDirective.json @@ -0,0 +1,31 @@ +{ + "IgxCardFooterDirective": { + "comment": { + "shortText": "IgxCardFooter はカード フッターのコンテナです。" + }, + "properties": { + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カード フッターの `role` 属性の値を設定する @Input プロパティ。", + "デフォルトで値が `footer` に設定されています。" + ] + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json new file mode 100644 index 00000000..e1e9823f --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderComponent.json @@ -0,0 +1,51 @@ +{ + "IgxCardHeaderComponent": { + "comment": { + "shortText": "IgxCardHeader はカード ヘッダーのコンテナです。" + }, + "properties": { + "vertical": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "ヘッダーのレイアウト スタイルを設定する @Input プロパティ。", + "デフォルトでは、ヘッダ要素 (サムネイルとタイトル/サブタイトル) は水平に配置されています。" + ] + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "カード ヘッダーの `role` 属性の値を設定する @Input プロパティ。", + "デフォルトで値が `header` に設定されています。" + ] + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/card/IgxCardHeaderSubtitleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderSubtitleDirective.json similarity index 100% rename from typedoc/ja/lib/card/IgxCardHeaderSubtitleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderSubtitleDirective.json diff --git a/typedoc/ja/lib/card/IgxCardHeaderTitleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderTitleDirective.json similarity index 100% rename from typedoc/ja/lib/card/IgxCardHeaderTitleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardHeaderTitleDirective.json diff --git a/typedoc/ja/lib/card/IgxCardMediaDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json similarity index 55% rename from typedoc/ja/lib/card/IgxCardMediaDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json index 24548bd6..03dd5fa8 100644 --- a/typedoc/ja/lib/card/IgxCardMediaDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardMediaDirective.json @@ -9,22 +9,40 @@ "properties": { "width": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, "shortText": [ - "メディア コンテナの `width` および `min-width` スタイル プロパティを設定する @Input プロパティ。指定しない場合は、 `auto` に設定されます。", - "```html", - "", - "```" + "メディア コンテナの `width` および `min-width` スタイル プロパティを設定する @Input プロパティ。指定しない場合は、 `auto` に設定されます。" ] } }, "height": { "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, "shortText": [ "メディア コンテナの `height` スタイル プロパティを設定する @Input プロパティ。", - "指定しない場合は、`auto` に設定されます。", - "```html", - "", - "```" + "指定しない場合は、`auto` に設定されます。" ] } }, diff --git a/typedoc/ja/lib/card/IgxCardThumbnailDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardThumbnailDirective.json similarity index 100% rename from typedoc/ja/lib/card/IgxCardThumbnailDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardThumbnailDirective.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardType.json b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardType.json new file mode 100644 index 00000000..41fe6a2c --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/card/IgxCardType.json @@ -0,0 +1,62 @@ +{ + "IgxCardType": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxCardModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-card-theme, igx-icon-theme, igx-button-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "card, button, avatar, icon", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Layouts", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "Ignite UI Card は、カスタム コンテンツを配置するコンテナです。コンテンツを配置するため、カードに 5 つのセクションがあります。", + "それらはヘッダー、メディア、コンテンツ、アクションおよびフッターです。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

{{title}}

", + "
{{subtitle}}
", + " ", + " ", + " ", + " ", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カードは、整理されたコンテンツを魅力的な方法で表示する方法を提供します。" + }, + "members": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/carousel/CarouselHammerConfig.json b/typedoc/ja/projects/igniteui-angular/src/lib/carousel/CarouselHammerConfig.json similarity index 100% rename from typedoc/ja/lib/carousel/CarouselHammerConfig.json rename to typedoc/ja/projects/igniteui-angular/src/lib/carousel/CarouselHammerConfig.json diff --git a/typedoc/ja/lib/carousel/ISlideEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/carousel/ISlideEventArgs.json similarity index 100% rename from typedoc/ja/lib/carousel/ISlideEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/carousel/ISlideEventArgs.json diff --git a/typedoc/ja/lib/carousel/IgxCarouselComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/carousel/IgxCarouselComponent.json similarity index 100% rename from typedoc/ja/lib/carousel/IgxCarouselComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/carousel/IgxCarouselComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json new file mode 100644 index 00000000..bd667e80 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/carousel/IgxSlideComponent.json @@ -0,0 +1,201 @@ +{ + "IgxSlideComponent": { + "comment": { + "tags": { + "export": { + "comment": { + "tagName": "export" + } + } + }, + "text": [ + "```", + "", + " ", + "", + "```" + ], + "shortText": [ + "画像またはキャプション テキストを含むスライド コンポーネント。", + "IgxSlideComponent は通常 IgxCarouselComponent の子コンポーネントです。" + ] + }, + "properties": { + "index": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "カルーセル内のスライドの `index` を取得または設定します。", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "direction": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "スライドの対象 `direction` を取得または設定します。", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "スライド コンポーネントのクラスを返します。", + "```typescript", + "let class = this.slide.cssClass;", + "```" + ] + } + } + }, + "methods": {}, + "accessors": { + "tabIndex": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "スライド コンポーネントの `tabIndex` を返します。", + "```typescript", + "let tabIndex = this.carousel.tabIndex;", + "```" + ] + } + } + }, + "ariaSelected": { + "getter": { + "comment": { + "text": [ + "```typescript", + "let slide = this.slide.ariaSelected;", + "```" + ], + "shortText": "スライドの `aria-selected` を返します。" + } + } + }, + "ariaLive": { + "getter": { + "comment": { + "text": [ + "```typescript", + "let slide = this.slide.ariaLive;", + "```" + ], + "shortText": "スライドの `aria-live` を返します。" + } + } + }, + "active": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "text": [ + "双方向データ バインディング。", + "```html", + "", + " ", + "", + "```" + ], + "shortText": [ + "スライドの `active` 状態を取得または設定します。", + "```html", + "", + " ", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "text": [ + "双方向データ バインディング。", + "```html", + "", + " ", + "", + "```" + ], + "shortText": [ + "スライドの `active` 状態を取得または設定します。", + "```html", + "", + " ", + "", + "```" + ] + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxSlideComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "DOM でカルーセル要素への参照を返します。", + "```typescript", + "let nativeElement = this.slide.nativeElement;", + "```" + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/checkbox/IChangeCheckboxEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IChangeCheckboxEventArgs.json similarity index 100% rename from typedoc/ja/lib/checkbox/IChangeCheckboxEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IChangeCheckboxEventArgs.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json new file mode 100644 index 00000000..36d29a91 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxComponent.json @@ -0,0 +1,499 @@ +{ + "IgxCheckboxComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxCheckboxModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-checkbox-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "checkbox, label", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "Data entry and display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "Ignite UI Checkbox は、バイナリの選択を可能にする選択コントロールです。ネイティブ ブラウザーのチェックボックスと同様に動作します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " simple checkbox", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "特定の条件でバイナリの選択を可能にします。" + }, + "properties": { + "nativeCheckbox": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let checkboxElement = this.checkbox.checkboxElement;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ チェックボックス要素への参照を返します。" + } + }, + "nativeLabel": { + "comment": { + "text": [ + "@example", + "let labelElement = this.checkbox.nativeLabel;", + "```" + ], + "shortText": [ + "ネイティブ ラベル要素への参照を返します。", + "```typescript" + ] + } + }, + "placeholderLabel": { + "comment": { + "text": [ + "@example", + "let labelPlaceholder = this.checkbox.placeholderLabel;", + "```" + ], + "shortText": [ + "ラベル プレースホルダー要素への参照を返します。", + "```typescript" + ] + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let checkboxId = this.checkbox.id;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックス コンポーネントの `id` を取得または設定します。", + "設定しない場合、最初のリスト コンポーネントの `id` は `\"igx-checkbox-0\"` になります。" + ] + } + }, + "labelId": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let labelId = this.checkbox.labelId;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`label` 要素の id を取得または設定します。", + "設定されない場合、最初のチェックボックス コンポーネントの `label` の id は `\"igx-checkbox-0-label\"` になります。" + ] + } + }, + "value": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let value = this.checkbox.value;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`value` 属性を取得または設定します。" + } + }, + "name": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let name = this.checkbox.name;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`name` 属性を取得または設定します。" + } + }, + "tabindex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let tabIndex = this.checkbox.tabindex;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`tabindex` 属性の値を取得または設定します。" + } + }, + "labelPosition": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let labelPosition = this.checkbox.labelPosition;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`label` の位置を取得または設定します。", + "設定されない場合、`labelPosition` の値は `\"after\"` です。" + ] + } + }, + "disableRipple": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRippleDisabled = this.checkbox.desableRipple;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "リップル エフェクトを有効または無効にします。", + "設定されない場合、`disableRipple` の値は `false` です。" + ] + } + }, + "required": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRequired = this.checkbox.required;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックスが必須かどうかを取得または設定します。", + "設定されない場合、`required` の値は `false` です。" + ] + } + }, + "ariaLabelledBy": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let ariaLabelledBy = this.checkbox.ariaLabelledBy;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`aria-labelledby` 属性を取得または設定します。", + "設定しない場合、`aria-labelledby` は `labelId` 属性の値と等しくなります。" + ] + } + }, + "ariaLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let ariaLabel = this.checkbox.ariaLabel;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`aria-label` 属性の値を取得または設定します。" + } + }, + "change": { + "comment": { + "shortText": [ + "チェックボックス状態が変更された後に発生するイベント。", + "イベント引数として `IgxCheckboxComponent` および `checked` プロパティへの参照を提供します。" + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let class = this.checkbox.cssClass;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "チェックボックス コンポーネントのクラスを返します。" + } + }, + "focused": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.checkbox.focused = true;", + "```", + "```typescript", + "let isFocused = this.checkbox.focused;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックス コンポーネントがフォーカスされるかどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + }, + "indeterminate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isIndeterminate = this.checkbox.indeterminate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックスの不確定ビジュアル ステートを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + }, + "checked": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isChecked = this.checkbox.checked;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックスがチェックされたかどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isDisabled = this.checkbox.disabled;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックスが無効かどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + }, + "readonly": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let readonly = this.checkbox.readonly;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チェックボックスが ReadOnly かどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + }, + "disableTransitions": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let disableTransitions = this.checkbox.disableTransitions;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Checkbox は すべての css トランジションを無効に設定するかどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + } + }, + "methods": { + "toggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.checkbox.toggle();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`disabled` が `false` の場合、`checked` 状態を切り替えます。" + } + } + }, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/checkbox/IgxCheckboxRequiredDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json similarity index 74% rename from typedoc/ja/lib/checkbox/IgxCheckboxRequiredDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json index 106f7b9a..1bd9c764 100644 --- a/typedoc/ja/lib/checkbox/IgxCheckboxRequiredDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/checkbox/IgxCheckboxRequiredDirective.json @@ -1,19 +1,6 @@ { "IgxCheckboxRequiredDirective": { - "properties": { - "required": { - "comment": { - "tags": { - "description": { - "comment": { - "text": "このディレクティブにバインドされている必須属性への変更を追跡します。", - "tagName": "説明" - } - } - } - } - } - }, + "properties": {}, "methods": { "validate": { "comment": { @@ -50,6 +37,24 @@ } } }, - "accessors": {} + "accessors": { + "required": { + "getter": { + "comment": { + "tags": { + "description": { + "comment": { + "text": "このディレクティブにバインドされている必須属性への変更を追跡します。", + "tagName": "説明" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } } } \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json new file mode 100644 index 00000000..26b54563 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipComponent.json @@ -0,0 +1,535 @@ +{ + "IgxChipComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxChipsModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-chip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "chip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "display", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "Ignite UI Chip をテンプレート化、削除、または選択できます。", + "複数の Chip を順序変更し、視覚的に接続できます。", + "Chip は「チップ領域」と呼ばれるコンテナーに配置され、このコンテナーは Chip の間の操作を管理します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxChip は情報を小さな楕円内に表示する視覚的なコンポーネントです。" + }, + "properties": { + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`id` 属性の値を設定する @Input プロパティ。提供されていない場合は、自動的に生成されます。" + } + }, + "data": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "チップに関連するデータを保存する @Input プロパティ。" + } + }, + "draggable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` の位置を変更するためにドラッグできるかどうかを定義する @Input プロパティ。", + "デフォルトの設定は false です。" + ] + } + }, + "animateOnRelease": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "要素が解放されたときにドラッグ可能な要素のアニメーションを有効/無効にする @Input プロパティ。", + "デフォルトの設定は true です。" + ] + } + }, + "hideBaseOnDrag": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "ドラッグされた基本要素の非表示を有効または無効にする @Input プロパティ。", + "デフォルトの設定は true です。" + ] + } + }, + "removable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` が [削除] ボタンを描画し、削除イベントを発生するかどうかを定義する @Input プロパティ。", + "デフォルトの設定は false です。" + ] + } + }, + "removeIcon": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "delete", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "チップが [削除] ボタンに適用するデフォルト アイコンをオーバーライドする @Input プロパティ。" + } + }, + "selectable": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` がクリックまたはナビゲーションで選択可能かどうかを定義する @Input プロパティ。", + "デフォルトの設定は false です。" + ] + } + }, + "selectIcon": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "done_outline", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "選択時にチップが適用するデフォルト アイコンをオーバーライドする @Input プロパティ。" + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` が無効かどうかを定義する @Input プロパティ。無効な場合、クリックまたはタブでフォーカス、クリックまたはスペースで選択、ドラッグなどのユーザー インタラクションを制限します。", + "デフォルトの設定は false です。" + ] + } + }, + "onMoveStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` の移動が開始するときにイベントを発生します。", + "移動している `IgxChipComponent` を返します。" + ] + } + }, + "onMoveEnd": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` の移動が終了するときにイベントを発生します。", + "移動した `IgxChipComponent` を返します。" + ] + } + }, + "onRemove": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` が削除されたときにイベントを発生します。", + "削除した `IgxChipComponent` を返します。" + ] + } + }, + "onClick": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` がクリックされたときにイベントを発生します。", + "クリックした `IgxChipComponent` およびイベントをキャンセルするかどうかを返します。" + ] + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` が選択/選択解除されたときにイベントを発生します。", + "選択したチップへの参照、イベントをキャンセルするかどうか、次の選択状態を返します。イベントがインタラクションでトリガーされた場合に `originalEvent` が提供されます。それ以外の場合、`originalEvent` は `null` です。" + ] + } + }, + "onSelectionDone": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` が選択/選択解除され、関連するアニメーションとトランジションが終了すると、イベントが発生します。" + } + }, + "onKeyDown": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` のキーボード ナビゲーションが使用されるときにイベントを発生します。", + "フォーカス/選択された `IgxChipComponent`、イベントをキャンセルするかどうか、`alt`、`shift`、または `control` キーが押されたかどうか、押されたキーの名前を返します。" + ] + } + }, + "onDragEnter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` が `IgxChipsAreaComponent` に入ったときにイベントを発生します。", + "ターゲットの IgxChipComponent`、ドラッグしている IgxChipComponent、および元のドロップ イベント引数を返します。" + ] + } + }, + "dragDirective": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "onMoveStart(event: IBaseChipEventArgs){", + " let dragDirective = event.owner.dragDirective;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` がドラッグ動作のために使う `IgxDragDirective` の参照を含むプロパティ。" + } + } + }, + "methods": {}, + "accessors": { + "selected": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "Two-way data binding:", + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の選択状態を設定します。" + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('myChip')", + "public chip: IgxChipComponent;", + "selectedChip(){", + " let selectedChip = this.chip.selected;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` が選択されるかどうかを返します。" + } + } + }, + "color": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipComponent` の背景色を設定する @Input プロパティ。", + "`color` プロパティは文字列、rgb、および16 進数をサポートします。" + ] + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('myChip')", + "public chip: IgxChipComponent;", + "ngAfterViewInit(){", + " let chipColor = this.chip.color;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の背景色を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json new file mode 100644 index 00000000..5b0bd09a --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/chips/IgxChipsAreaComponent.json @@ -0,0 +1,181 @@ +{ + "IgxChipsAreaComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxChipsModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-chip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "chip area, chip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "display", + "tagName": "igxgroup" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " {{chip.text}}", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "チップ領域により、ドラッグ、選択、移動などの操作を必要とするチップを使用して、より複雑なシナリオを実行できます。" + ] + }, + "properties": { + "width": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipsAreaComponent` の幅を設定する @Input プロパティ。" + } + }, + "height": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipsAreaComponent` の高さを設定する @Input プロパティ。" + } + }, + "onReorder": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipsAreaComponent` で `IgxChipComponent` を並べ替えるときにイベントを発生します。", + "`IgxColumnComponent` の配列を返します。" + ] + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`IgxChipsAreaComponent` で `IgxChipComponent` が選択/選択解除されたときにイベントを発生します。", + "初期ときに選択されたチップがある場合もチップ領域が初期化された後に発生されます。", + "選択済み `IgxChipComponent` の配列および `IgxChipAreaComponent` を返します。" + ] + } + }, + "onMoveStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipsAreaComponent` で `IgxChipComponent` が移動されているときにイベントを発生します。" + } + }, + "onMoveEnd": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipsAreaComponent` で `IgxChipComponent` が移動された後にイベントを発生します。" + } + }, + "chipsList": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "ngAfterViewInit(){", + " let chips = this.chipsArea.chipsList;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipsAreaComponent` に `IgxChipComponent` を保持します。" + } + } + }, + "methods": {}, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/combo/IComboItemAdditionEvent.json b/typedoc/ja/projects/igniteui-angular/src/lib/combo/IComboItemAdditionEvent.json similarity index 100% rename from typedoc/ja/lib/combo/IComboItemAdditionEvent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/combo/IComboItemAdditionEvent.json diff --git a/typedoc/ja/lib/combo/IComboSelectionChangeEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/combo/IComboSelectionChangeEventArgs.json similarity index 100% rename from typedoc/ja/lib/combo/IComboSelectionChangeEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/combo/IComboSelectionChangeEventArgs.json diff --git a/typedoc/ja/lib/combo/IgxComboComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json similarity index 95% rename from typedoc/ja/lib/combo/IgxComboComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json index 71ef08d5..799d1651 100644 --- a/typedoc/ja/lib/combo/IgxComboComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/combo/IgxComboComponent.json @@ -549,40 +549,40 @@ "tags": {}, "shortText": "フィルター済みのすべての項目の選択を解除します。" } - }, - "setSelectedItem": { - "comment": { - "parameters": { - "itemID": { - "comment": { - "text": "指定される項目の itemID。" + }, + "setSelectedItem": { + "comment": { + "parameters": { + "itemID": { + "comment": { + "text": "指定される項目の itemID。" + } + }, + "select": { + "comment": { + "text": [ + "項目が選択されるか (true) または選択解除されるか (false)。", + "指定された valueKey なし;", + "```typescript", + "this.combo.valueKey = null;", + "const items: { field: string, region: string}[] = data;", + "this.combo.setSelectedItem(items[0], true);", + "```", + "指定された valueKey を使用;", + "```typescript", + "this.combo.valueKey = 'field';", + "const items: { field: string, region: string}[] = data;", + "this.combo.setSelectedItem('Connecticut', true);", + "```" + ] + } } }, - "select": { - "comment": { - "text": [ - "項目が選択されるか (true) または選択解除されるか (false)。", - "指定された valueKey なし;", - "```typescript", - "this.combo.valueKey = null;", - "const items: { field: string, region: string}[] = data;", - "this.combo.setSelectedItem(items[0], true);", - "```", - "指定された valueKey を使用;", - "```typescript", - "this.combo.valueKey = 'field';", - "const items: { field: string, region: string}[] = data;", - "this.combo.setSelectedItem('Connecticut', true);", - "```" - ] - } - } - }, - "tags": {}, - "shortText": "1 つの項目を選択/選択解除します。" + "tags": {}, + "shortText": "1 つの項目を選択/選択解除します。" + } } - } - }, + }, "accessors": { "itemsMaxHeight": { "getter": { @@ -701,7 +701,7 @@ "```", "```html", "", - "", + "", "```" ], "shortText": "コンボ テキスト データソース プロパティ。" diff --git a/typedoc/ja/lib/combo/IgxComboState.json b/typedoc/ja/projects/igniteui-angular/src/lib/combo/IgxComboState.json similarity index 100% rename from typedoc/ja/lib/combo/IgxComboState.json rename to typedoc/ja/projects/igniteui-angular/src/lib/combo/IgxComboState.json diff --git a/typedoc/ja/lib/core/CancelableBrowserEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/CancelableBrowserEventArgs.json similarity index 100% rename from typedoc/ja/lib/core/CancelableBrowserEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/CancelableBrowserEventArgs.json diff --git a/typedoc/ja/lib/core/CancelableEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/CancelableEventArgs.json similarity index 100% rename from typedoc/ja/lib/core/CancelableEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/CancelableEventArgs.json diff --git a/typedoc/ja/lib/core/DisplayDensity.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/DisplayDensity.json similarity index 100% rename from typedoc/ja/lib/core/DisplayDensity.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/DisplayDensity.json diff --git a/typedoc/ja/lib/core/DisplayDensityBase.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/DisplayDensityBase.json similarity index 100% rename from typedoc/ja/lib/core/DisplayDensityBase.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/DisplayDensityBase.json diff --git a/typedoc/ja/lib/core/IBaseEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/IBaseEventArgs.json similarity index 100% rename from typedoc/ja/lib/core/IBaseEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/IBaseEventArgs.json diff --git a/typedoc/ja/lib/core/IDensityChangedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/IDensityChangedEventArgs.json similarity index 100% rename from typedoc/ja/lib/core/IDensityChangedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/IDensityChangedEventArgs.json diff --git a/typedoc/ja/lib/core/IDisplayDensityOptions.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/IDisplayDensityOptions.json similarity index 100% rename from typedoc/ja/lib/core/IDisplayDensityOptions.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/IDisplayDensityOptions.json diff --git a/typedoc/ja/lib/core/InteractionMode.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/InteractionMode.json similarity index 100% rename from typedoc/ja/lib/core/InteractionMode.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/InteractionMode.json diff --git a/typedoc/ja/lib/core/IToggleView.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IToggleView.json similarity index 100% rename from typedoc/ja/lib/core/IToggleView.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IToggleView.json diff --git a/typedoc/ja/lib/core/IgxNavigationCloseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationCloseDirective.json similarity index 100% rename from typedoc/ja/lib/core/IgxNavigationCloseDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationCloseDirective.json diff --git a/typedoc/ja/lib/core/IgxNavigationService.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationService.json similarity index 100% rename from typedoc/ja/lib/core/IgxNavigationService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationService.json diff --git a/typedoc/ja/lib/core/IgxNavigationToggleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationToggleDirective.json similarity index 100% rename from typedoc/ja/lib/core/IgxNavigationToggleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/core/navigation/IgxNavigationToggleDirective.json diff --git a/typedoc/ja/lib/data-operations/FilteringExpressionsTree.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/FilteringExpressionsTree.json similarity index 99% rename from typedoc/ja/lib/data-operations/FilteringExpressionsTree.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/FilteringExpressionsTree.json index ec488ffa..47979191 100644 --- a/typedoc/ja/lib/data-operations/FilteringExpressionsTree.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/FilteringExpressionsTree.json @@ -148,4 +148,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IDateParts.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IDateParts.json similarity index 99% rename from typedoc/ja/lib/data-operations/IDateParts.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IDateParts.json index a46be275..d1a3edfd 100644 --- a/typedoc/ja/lib/data-operations/IDateParts.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IDateParts.json @@ -13,4 +13,4 @@ "properties": {}, "methods": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IFilteringExpression.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringExpression.json similarity index 98% rename from typedoc/ja/lib/data-operations/IFilteringExpression.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringExpression.json index 16ee3a9e..91e47ef1 100644 --- a/typedoc/ja/lib/data-operations/IFilteringExpression.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringExpression.json @@ -6,4 +6,4 @@ "properties": {}, "methods": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IFilteringExpressionsTree.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringExpressionsTree.json similarity index 100% rename from typedoc/ja/lib/data-operations/IFilteringExpressionsTree.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringExpressionsTree.json diff --git a/typedoc/ja/lib/data-operations/IFilteringOperation.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringOperation.json similarity index 99% rename from typedoc/ja/lib/data-operations/IFilteringOperation.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringOperation.json index 868020f3..cf4f4e24 100644 --- a/typedoc/ja/lib/data-operations/IFilteringOperation.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IFilteringOperation.json @@ -13,4 +13,4 @@ "properties": {}, "methods": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IGroupingExpression.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IGroupingExpression.json similarity index 100% rename from typedoc/ja/lib/data-operations/IGroupingExpression.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IGroupingExpression.json diff --git a/typedoc/ja/lib/data-operations/ISortingExpression.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/ISortingExpression.json similarity index 100% rename from typedoc/ja/lib/data-operations/ISortingExpression.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/ISortingExpression.json diff --git a/typedoc/ja/lib/data-operations/IgxBooleanFilteringOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxBooleanFilteringOperand.json similarity index 99% rename from typedoc/ja/lib/data-operations/IgxBooleanFilteringOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxBooleanFilteringOperand.json index 151b2444..fc981505 100644 --- a/typedoc/ja/lib/data-operations/IgxBooleanFilteringOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxBooleanFilteringOperand.json @@ -46,4 +46,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IgxDateFilteringOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxDateFilteringOperand.json similarity index 99% rename from typedoc/ja/lib/data-operations/IgxDateFilteringOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxDateFilteringOperand.json index 35b134f1..100ec56b 100644 --- a/typedoc/ja/lib/data-operations/IgxDateFilteringOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxDateFilteringOperand.json @@ -59,4 +59,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IgxFilteringOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxFilteringOperand.json similarity index 99% rename from typedoc/ja/lib/data-operations/IgxFilteringOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxFilteringOperand.json index b03674ec..6028c6ff 100644 --- a/typedoc/ja/lib/data-operations/IgxFilteringOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxFilteringOperand.json @@ -49,4 +49,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IgxNumberFilteringOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxNumberFilteringOperand.json similarity index 99% rename from typedoc/ja/lib/data-operations/IgxNumberFilteringOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxNumberFilteringOperand.json index 19bed36e..d2ece497 100644 --- a/typedoc/ja/lib/data-operations/IgxNumberFilteringOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxNumberFilteringOperand.json @@ -46,4 +46,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/data-operations/IgxStringFilteringOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxStringFilteringOperand.json similarity index 99% rename from typedoc/ja/lib/data-operations/IgxStringFilteringOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxStringFilteringOperand.json index 99d1b3a2..6738091f 100644 --- a/typedoc/ja/lib/data-operations/IgxStringFilteringOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/IgxStringFilteringOperand.json @@ -59,4 +59,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/SortingDirection.json b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/SortingDirection.json new file mode 100644 index 00000000..b2a11792 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/data-operations/SortingDirection.json @@ -0,0 +1,8 @@ +{ + "SortingDirection": { + "comment": { + "shortText": "並べ替え式を表します。" + }, + "members": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/date-picker/IDatePickerDisabledDateEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IDatePickerDisabledDateEventArgs.json similarity index 100% rename from typedoc/ja/lib/date-picker/IDatePickerDisabledDateEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IDatePickerDisabledDateEventArgs.json diff --git a/typedoc/ja/lib/date-picker/IDatePickerValidationFailedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IDatePickerValidationFailedEventArgs.json similarity index 100% rename from typedoc/ja/lib/date-picker/IDatePickerValidationFailedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IDatePickerValidationFailedEventArgs.json diff --git a/typedoc/ja/lib/date-picker/IFormatOptions.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IFormatOptions.json similarity index 100% rename from typedoc/ja/lib/date-picker/IFormatOptions.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IFormatOptions.json diff --git a/typedoc/ja/lib/date-picker/IFormatViews.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IFormatViews.json similarity index 100% rename from typedoc/ja/lib/date-picker/IFormatViews.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IFormatViews.json diff --git a/typedoc/ja/lib/date-picker/IgxDatePickerActionsDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerActionsDirective.json similarity index 100% rename from typedoc/ja/lib/date-picker/IgxDatePickerActionsDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerActionsDirective.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json new file mode 100644 index 00000000..38ddd0c1 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/IgxDatePickerComponent.json @@ -0,0 +1,873 @@ +{ + "IgxDatePickerComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxDatePickerModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-calendar-theme, igx-icon-theme", + "tagName": "igxtheme" + } + }, + "igxgroup": { + "comment": { + "text": "Scheduling", + "tagName": "igxgroup" + } + }, + "igxkeywords": { + "comment": { + "text": "datepicker, calendar, schedule, date", + "tagName": "igxkeywords" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Date Picker は、日付の単一選択が可能なポップアップ カレンダーを表示します。" + }, + "properties": { + "label": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト ラベルは 'Date' です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` ラベルを設定または取得します。" + } + }, + "labelVisibility": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで表示状態は true に設定されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": "", + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` ラベルの表示状態を設定または取得します。" + } + }, + "locale": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト ロケールは en です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "weekStart": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "週の最初の曜日を設定または取得します。" + } + }, + "hideOutsideDays": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "現在の月以外の日付に適用します。", + "デフォルト値は `false` です。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let hideOutsideDays = this.datePicker.hideOutsideDays;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "非アクティブな日付を非表示にするかどうかを設定または取得します。" + } + }, + "monthsViewNumber": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は `1` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let monthViewsDisplayed = this.datePicker.monthsViewNumber;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "表示される月ビューの数を設定または取得します。" + } + }, + "mask": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let mask = this.datePicker.mask;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "編集可能なドロップダウン モードで `IgxDatePickerComponent` の日付マスクを設定します。" + } + }, + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "提供されていない場合は、自動的に生成されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`id` 属性の値を取得または設定します。" + } + }, + "formatter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "選択した日付または渡した日付にカスタム書式関数を設定または取得します。" + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` を有効/無効にします。" + } + }, + "vertical": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` ヘッダーの方向を取得または設定します。" + } + }, + "todayButtonLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "[今日] ボタンのラベルを取得または設定します。" + } + }, + "cancelButtonLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "*[キャンセル] ボタンのラベルを取得または設定します。" + } + }, + "mode": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "操作モード (ダイアログまたはドロップダウン) を取得または設定します。" + } + }, + "isSpinLoop": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Min/max を達した場合に、日付が継続してスピンまたは停止するかどうかを取得または設定します。" + } + }, + "outlet": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`Outlet` は `IgxOverlayOutletDirective` または `ElementRef` のインスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "
", + "//..", + "", + "//..", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ポップアップ要素に使用されるコンテナを取得または設定します。" + } + }, + "onOpened": { + "comment": { + "shortText": "`IgxDatePickerComponent` カレンダーが開いたときに発生されます。" + } + }, + "onClosed": { + "comment": { + "shortText": "`IgxDatePickerComponent` が閉じたときに発生されます。" + } + }, + "onClosing": { + "comment": { + "shortText": "`IgxDatePickerComponent` が閉じたときに発生されます。" + } + }, + "onSelection": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カレンダーで選択が実行されるときに発生されます。" + } + }, + "valueChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Date Picker の値が変更されたときに発生されます。" + } + }, + "onDisabledDate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "日付ピッカー エディターでユーザーが無効な日付を入力またはスピンした場合に発生されます。" + } + }, + "onValidationFailed": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "日付ピッカー エディターでユーザーが無効な日付を入力またはスピンした場合に発生されます。" + } + } + }, + "methods": { + "writeValue": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "選択する日付。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.writeValue(this.date);", + "```" + ], + "tagName": "例" + } + }, + "memberof": { + "comment": { + "text": "{@link IgxDatePickerComponent}", + "tagName": "次のメンバー:" + } + } + }, + "shortText": "選択した日付を設定します。" + } + }, + "triggerTodaySelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "入力フィールドの値、@calendar.viewDate、および @calendar.value を変更します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.triggerTodaySelection();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "今日の日付をカレンダーで選択します。" + } + }, + "selectDate": { + "comment": { + "parameters": { + "date": { + "comment": { + "text": "カレンダー に設定する必要な渡した日付。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "このメソッドの呼び出しは @calendar.onSelection イベントを発生し、@handleSelection メソッドを発生します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.selectDate(this.date);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カレンダー選択の変更します。" + } + }, + "deselectDate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.deselectDate();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カレンダー日付を選択解除します。" + } + }, + "openDialog": { + "comment": { + "parameters": { + "target": { + "comment": { + "text": "HTMLElement - 次に従ってドロップダウンコンテナを配置するために使用するターゲット要素。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.openDialog(target);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "日付ピッカーのドロップダウンまたはダイアログを開きます。" + } + } + }, + "accessors": { + "formatOptions": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let formatOptions = this.datePicker.formatOptions;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` の書式設定オプションを設定します。" + } + }, + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.datePicker.formatOptions = { day: \"numeric\", month: \"long\", weekday: \"long\", year: \"numeric\"};", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` の書式設定オプションを設定します。" + } + } + }, + "format": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let format = this.datePicker.format;", + "this.datePicker.format = 'yyyy-M-d';", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "編集可能なモード `IgxDatePickerComponent` の日付表示書式を設定または取得します。" + } + }, + "setter": { + "comment": { + "shortText": "編集可能なモード `IgxDatePickerComponent` の日付表示書式を設定または取得します。" + } + } + }, + "formatViews": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let formatViews = this.datePicker.formatViews;", + " this.datePicker.formatViews = {day:false, month: false, year:false};", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` の書式設定ビューを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxDatePickerComponent` の書式設定ビューを設定します。" + } + } + }, + "disabledDates": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let disabledDates = this.datepicker.disabledDates;", + "this.datePicker.disabledDates = [ {type: DateRangeType.Weekends}, ...];", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "無効な日付記述子を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "無効な日付記述子を取得または設定します。" + } + } + }, + "specialDates": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let specialDates = this.datepicker.specialDates;", + "this.datePicker.specialDates = [ {type: DateRangeType.Weekends}, ... ];", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "特別な日付記述子を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "特別な日付記述子を取得または設定します。" + } + } + }, + "modalOverlaySettings": { + "getter": { + "comment": { + "shortText": "モーダル オーバーレイ設定を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "モーダル オーバーレイ設定を取得または設定します。" + } + } + }, + "dropDownOverlaySettings": { + "getter": { + "comment": { + "shortText": "ドロップダウンのオーバーレイ設定を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ドロップダウンのオーバーレイ設定を取得または設定します。" + } + } + }, + "displayData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let selectedDate = this.datePicker.displayData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxDatePickerComponent` はダイアログ モードで、書式設定された日付を取得します。" + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let template = this.template();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "入力グループのテンプレートを取得します。" + } + } + }, + "context": { + "getter": { + "comment": { + "shortText": "入力グループのテンプレートに渡されたコンテキストを取得します。" + } + } + }, + "value": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "選択した日付を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "選択した日付を取得または設定します。" + } + } + }, + "onOpen": { + "getter": { + "comment": { + "tags": { + "deprecated": { + "comment": { + "text": [ + "代わりに `onOpened` を使用してください。", + "`IgxDatePickerComponent` カレンダーが開いたときに発生されるイベント。" + ], + "tagName": "非推奨" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public open(event){", + " alert(\"The date-picker calendar has been opened!\");", + "}", + "```", + "```html", + "", + "```" + ], + "tagName": "例" + } + } + } + } + }, + "setter": { + "comment": {} + } + }, + "onClose": { + "getter": { + "comment": { + "tags": { + "deprecated": { + "comment": { + "text": [ + "代わりに `onClosed` を使用してください。", + "\"`IgxDatePickerComponent` が閉じたときに発生されるイベント。" + ], + "tagName": "非推奨" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public close(event){", + " alert(\"The date-picker has been closed!\");", + "}", + "```", + "```html", + "", + "```" + ], + "tagName": "例" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/date-picker/PredefinedFormatOptions.json b/typedoc/ja/projects/igniteui-angular/src/lib/date-picker/PredefinedFormatOptions.json similarity index 100% rename from typedoc/ja/lib/date-picker/PredefinedFormatOptions.json rename to typedoc/ja/projects/igniteui-angular/src/lib/date-picker/PredefinedFormatOptions.json diff --git a/typedoc/ja/lib/dialog/IDialogEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/dialog/IDialogEventArgs.json similarity index 100% rename from typedoc/ja/lib/dialog/IDialogEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/dialog/IDialogEventArgs.json diff --git a/typedoc/ja/lib/dialog/IgxDialogComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/dialog/IgxDialogComponent.json similarity index 100% rename from typedoc/ja/lib/dialog/IgxDialogComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/dialog/IgxDialogComponent.json diff --git a/typedoc/ja/lib/directives/AutocompleteItemSelectionEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteItemSelectionEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/AutocompleteItemSelectionEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteItemSelectionEventArgs.json diff --git a/typedoc/ja/lib/directives/AutocompleteOverlaySettings.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteOverlaySettings.json similarity index 100% rename from typedoc/ja/lib/directives/AutocompleteOverlaySettings.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/AutocompleteOverlaySettings.json diff --git a/typedoc/ja/lib/directives/IgxAutocompleteDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/IgxAutocompleteDirective.json similarity index 100% rename from typedoc/ja/lib/directives/IgxAutocompleteDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/autocomplete/IgxAutocompleteDirective.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json new file mode 100644 index 00000000..c6831b1c --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/button/IgxButtonDirective.json @@ -0,0 +1,218 @@ +{ + "IgxButtonDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxButtonModule", + "tagName": "igxmodule" + } + }, + "igxparent": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxparent" + } + }, + "igxtheme": { + "comment": { + "text": "igx-button-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "button, span, div, click", + "tagName": "igxkeywords" + } + }, + "remarks": { + "comment": { + "text": "Ignite UI Button ディレクティブは、いずれかのボタン、スパン、または div で使用され、これらを完全に機能するボタンに変更することが意図されています。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Button ディレクティブは、ボタンとして使用を意図されているすべてのコンポーネントに Ignite UI ボタン機能を提供します。" + }, + "properties": { + "buttonClick": { + "comment": { + "shortText": "ボタンがクリックされたときに呼び出されます。" + } + }, + "role": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.button.role = 'navbutton';", + "let buttonRole = this.button.role;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`role` 属性を取得または設定します。" + } + }, + "selected": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "ボタンが選択されるかどうかを取得または設定します。", + "IgxButtonGroup コンポーネントで使用されます。別に設定される場合に影響しません。" + ] + } + } + }, + "methods": {}, + "accessors": { + "nativeElement": { + "getter": { + "comment": { + "shortText": "基本の DOM 要素を返します。" + } + } + }, + "type": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ボタンの種類を設定します。" + } + } + }, + "color": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ボタンのテキスト色を設定します。" + } + } + }, + "background": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ボタンの背景色を設定します。" + } + } + }, + "label": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`aria-label` 属性を設定します。" + } + } + }, + "disabled": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ボタンを有効/無効にします。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxDividerDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/divider/IgxDividerDirective.json similarity index 100% rename from typedoc/ja/lib/directives/IgxDividerDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/divider/IgxDividerDirective.json diff --git a/typedoc/ja/lib/directives/IDragBaseEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragBaseEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDragBaseEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragBaseEventArgs.json diff --git a/typedoc/ja/lib/directives/IDragGhostBaseEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragGhostBaseEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDragGhostBaseEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragGhostBaseEventArgs.json diff --git a/typedoc/ja/lib/directives/IDragMoveEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragMoveEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDragMoveEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragMoveEventArgs.json diff --git a/typedoc/ja/lib/directives/IDragStartEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragStartEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDragStartEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDragStartEventArgs.json diff --git a/typedoc/ja/lib/directives/IDropBaseEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDropBaseEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDropBaseEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDropBaseEventArgs.json diff --git a/typedoc/ja/lib/directives/IDropDroppedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDropDroppedEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IDropDroppedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IDropDroppedEventArgs.json diff --git a/typedoc/ja/lib/directives/IgxDragDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDragDirective.json similarity index 90% rename from typedoc/ja/lib/directives/IgxDragDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDragDirective.json index d667456d..6add9bbe 100644 --- a/typedoc/ja/lib/directives/IgxDragDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDragDirective.json @@ -121,7 +121,7 @@ "", "```" ], - "tagName": "deprecated" + "tagName": "非推奨" } }, "memberof": { @@ -141,49 +141,48 @@ "text": [ "今後提供されたトランジション関数を使用してください。", "要素が解放されたときにドラッグ可能な要素のアニメーションを有効/無効にする @Input プロパティ。", - "", - "デフォルトで false に設定されます。", - "```html", - "
", - " Drag Me!", - "
", - "```" - ], - "tagName": "deprecated" - } - }, - "memberof": { - "comment": { - "text": "IgxDragDirective", - "tagName": "次のメンバー:" - } + "デフォルトで false に設定されます。", + "```html", + "
", + " Drag Me!", + "
", + "```" + ], + "tagName": "非推奨" + } + }, + "memberof": { + "comment": { + "text": "IgxDragDirective", + "tagName": "次のメンバー:" } } } - }, - "ghostTemplate": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxDragDirective", - "tagName": "次のメンバー:" - } + } + }, + "ghostTemplate": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxDragDirective", + "tagName": "次のメンバー:" } - }, - "shortText": [ - "ドラッグが開始され、 `ghost` が true のときに作成されるゴースト要素のテンプレートを指定する @Input プロパティ。", - "デフォルトでは、igxDrag がインスタンス化されるベース要素のクローンが作成されます。", - "```html", - "
", - " Drag Me!", - "
", - "", - "
", - " I am being dragged!", - "
", - "", - "```" + } + }, + "shortText": [ + "ドラッグが開始され、 `ghost` が true のときに作成されるゴースト要素のテンプレートを指定する @Input プロパティ。", + "デフォルトでは、igxDrag がインスタンス化されるベース要素のクローンが作成されます。", + "```html", + "
", + " Drag Me!", + "
", + "", + "
", + " I am being dragged!", + "
", + "", + "```" ] } }, @@ -534,19 +533,19 @@ "comment": { "text": [ "将来のバージョンでは、ベース要素に合わせたカスタム スタイルを使用し、ネイティブ Angular 方法で非表示にしてください。", - "ドラッグ可能な要素の表示状態を設定します。", - "```typescript", - "@ViewChild(\"myDrag\" ,{read: IgxDragDirective})", - "public myDrag: IgxDragDirective;", - "ngAfterViewInit(){", - " this.myDrag.visible = false;", - "}", - "```" - ], - "tagName": "deprecated" - } - } - }, + "ドラッグ可能な要素の表示状態を設定します。", + "```typescript", + "@ViewChild(\"myDrag\" ,{read: IgxDragDirective})", + "public myDrag: IgxDragDirective;", + "ngAfterViewInit(){", + " this.myDrag.visible = false;", + "}", + "```" + ], + "tagName": "非推奨" + } + } + }, "shortText": [ "ドラッグ可能な要素の表示状態を返します。", "```typescript", @@ -590,4 +589,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxDropDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDropDirective.json similarity index 97% rename from typedoc/ja/lib/directives/IgxDropDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDropDirective.json index 06e0f5f2..d023555e 100644 --- a/typedoc/ja/lib/directives/IgxDropDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/drag-drop/IgxDropDirective.json @@ -95,12 +95,12 @@ "comment": { "tags": { "memberof": { - "comment": { - "text": "IgxDropDirective", - "tagName": "次のメンバー:" - } - } - }, + "comment": { + "text": "IgxDropDirective", + "tagName": "次のメンバー:" + } + } + }, "shortText": [ "ドラッグされた要素が要素の領域から出るときにトリガーされるイベント。", "```html", diff --git a/typedoc/ja/lib/directives/IgxFocusDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/focus/IgxFocusDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxFocusDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/focus/IgxFocusDirective.json index 1df02308..2abf710a 100644 --- a/typedoc/ja/lib/directives/IgxFocusDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/focus/IgxFocusDirective.json @@ -90,4 +90,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IForOfDataChangingEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IForOfDataChangingEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/IForOfDataChangingEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IForOfDataChangingEventArgs.json diff --git a/typedoc/ja/lib/directives/IForOfState.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IForOfState.json similarity index 100% rename from typedoc/ja/lib/directives/IForOfState.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IForOfState.json diff --git a/typedoc/ja/lib/directives/IgxForOfContext.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json similarity index 84% rename from typedoc/ja/lib/directives/IgxForOfContext.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json index 7a006c74..8abfb704 100644 --- a/typedoc/ja/lib/directives/IgxForOfContext.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfContext.json @@ -1,7 +1,13 @@ { "IgxForOfContext": { "comment": { - "shortText": " @publicApi" + "tags": { + "publicapi": { + "comment": { + "tagName": "publicapi" + } + } + } }, "properties": {}, "methods": {}, diff --git a/typedoc/ja/lib/directives/IgxForOfDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxForOfDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfDirective.json index 1bc54e77..70e3dc69 100644 --- a/typedoc/ja/lib/directives/IgxForOfDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxForOfDirective.json @@ -336,4 +336,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxGridForOfDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxGridForOfDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxGridForOfDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxGridForOfDirective.json index 522d720d..03a928b5 100644 --- a/typedoc/ja/lib/directives/IgxGridForOfDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/for-of/IgxGridForOfDirective.json @@ -336,4 +336,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxHintDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/hint/IgxHintDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxHintDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/hint/IgxHintDirective.json index 6835682d..1bc7f50b 100644 --- a/typedoc/ja/lib/directives/IgxHintDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/hint/IgxHintDirective.json @@ -97,4 +97,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json new file mode 100644 index 00000000..717952b5 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/input/IgxInputDirective.json @@ -0,0 +1,364 @@ +{ + "IgxInputDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxInputGroupModule", + "tagName": "igxmodule" + } + }, + "igxparent": { + "comment": { + "text": "Data Entry & Display", + "tagName": "igxparent" + } + }, + "igxtheme": { + "comment": { + "text": "igx-input-group-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "input, input group, form, field, validation", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "presentation", + "tagName": "igxgroup" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`igxInput` ディレクティブは、単一または複数行のテキスト要素を作成し、フォーム入力を扱うときの一般的なシナリオに対処します。" + }, + "properties": { + "isInput": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isCLassAdded = this.igxInput.isInput;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "\"igx-input-group__input\"` クラスがホスト要素に追加されるかどうかを取得または設定します。", + "デフォルトは `false` です。" + ] + } + }, + "isTextArea": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isCLassAdded = this.igxInput.isTextArea;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`\"class.igx-input-group__textarea\"` クラスがホスト要素に追加されるかどうかを取得または設定します。", + "デフォルトは `false` です。" + ] + } + } + }, + "methods": { + "focus": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.igxInput.focus();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput にフォーカスを設定します。" + } + } + }, + "accessors": { + "value": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`value` プロパティを設定します。" + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('igxInput', {read: IgxInputDirective})", + " public igxInput: IgxInputDirective;", + "let inputValue = this.igxInput.value;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`value` プロパティを取得します。" + } + } + }, + "disabled": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`disabled` プロパティを設定します。" + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild('igxInput', {read: IgxInputDirective})", + " public igxInput: IgxInputDirective;", + "let isDisabled = this.igxInput.disabled;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`disabled` プロパティを取得します。" + } + } + }, + "required": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`required` プロパティを設定します。" + } + }, + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isRequired = this.igxInput.required;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput が必須かどうかを取得します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputNativeElement = this.igxInput.nativeElement;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput の `nativeElement` を取得します。" + } + } + }, + "hasPlaceholder": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let hasPlaceholder = this.igxInput.hasPlaceholder;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput にプレースホルダーがあるかどうかを取得します。" + } + } + }, + "placeholder": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputPlaceholder = this.igxInput.placeholder;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput のプレースホルダー要素を取得します。" + } + } + }, + "focused": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isFocused = this.igxInput.focused;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput がフォーカスされるかどうかを取得します。" + } + } + }, + "valid": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let igxInputState = this.igxInput.valid;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput の状態を取得します。" + } + }, + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.igxInput.valid = IgxInputState.INVALID;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput の状態を設定します。" + } + } + }, + "isValid": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let valid = this.igxInput.isValid;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "igxInput が有効かどうかを取得します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxFlexDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxFlexDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxFlexDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxFlexDirective.json index 40e123cc..cb79c23c 100644 --- a/typedoc/ja/lib/directives/IgxFlexDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxFlexDirective.json @@ -73,4 +73,4 @@ "methods": {}, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxLayoutDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxLayoutDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxLayoutDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxLayoutDirective.json index 175c6211..44eb9e21 100644 --- a/typedoc/ja/lib/directives/IgxLayoutDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/layout/IgxLayoutDirective.json @@ -96,4 +96,4 @@ "methods": {}, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IMaskEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IMaskEventArgs.json similarity index 99% rename from typedoc/ja/lib/directives/IMaskEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IMaskEventArgs.json index bbc41489..d1700873 100644 --- a/typedoc/ja/lib/directives/IMaskEventArgs.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IMaskEventArgs.json @@ -12,4 +12,4 @@ }, "methods": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxMaskDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IgxMaskDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxMaskDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IgxMaskDirective.json index ff46b723..f655a510 100644 --- a/typedoc/ja/lib/directives/IgxMaskDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/mask/IgxMaskDirective.json @@ -138,4 +138,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json new file mode 100644 index 00000000..02f0db36 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/radio/IgxRadioGroupDirective.json @@ -0,0 +1,282 @@ +{ + "IgxRadioGroupDirective": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxRadioModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-radio-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "radiogroup, radio, button, input", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "データ入力と表示", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": "Ignite UI Radio Group を使用すると、隣に表示されるオプションのセットから単一のオプションを選択する機能を提供します。", + "tagName": "備考" + } + }, + "example:": { + "comment": { + "text": [ + "```html", + "", + " ", + " {{item}}", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ グループ ディレクティブは、ラジオ ボタンのセットを描画します。" + }, + "properties": { + "radioButtons": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let radioButtons = this.radioGroup.radioButtons;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "子ラジオ ボタンへの参照を返します。" + } + }, + "change": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "イベント引数として選択した `IgxRadioComponent` および `value` プロパティへの参照を提供します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ グループの `value` が変更された後に発生するイベント。" + } + } + }, + "methods": { + "writeValue": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "指定した値が現在のラジオ ボタンと整合性があるかどうかを確認します。", + "そうである場合、checked 属性の値は `true`になり、選択したプロパティに選択した `IgxRadioComponent` が含まれます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.radioGroup.writeValue('radioButtonValue');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ input 要素の \"checked\" property 値を設定します。" + } + } + }, + "accessors": { + "value": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`value` 属性を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`value` 属性を取得または設定します。" + } + } + }, + "name": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + " ```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ グループ コンポーネントの `name` 属性を取得または設定します。 すべての子ラジオ ボタンはこの名前を継承します。" + } + }, + "setter": { + "comment": { + "shortText": "ラジオ グループ コンポーネントの `name` 属性を取得または設定します。 すべての子ラジオ ボタンはこの名前を継承します。" + } + } + }, + "required": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されない場合、`required` の値は `false` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ グループが必須かどうかを設定または取得します。" + } + }, + "setter": { + "comment": { + "shortText": "ラジオ グループが必須かどうかを設定または取得します。" + } + } + }, + "disabled": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + " ```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラジオ グループの無効化を許可する @Input プロパティ。 デフォルトで false です。" + } + }, + "setter": { + "comment": { + "shortText": "ラジオ グループの無効化を許可する @Input プロパティ。 デフォルトで false です。" + } + } + }, + "labelPosition": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されない場合、`labelPosition` の値は `\"after\"` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "子ラジオ ボタンの `label` の位置を設定または取得します。" + } + }, + "setter": { + "comment": { + "shortText": "子ラジオ ボタンの `label` の位置を設定または取得します。" + } + } + }, + "selected": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let selectedButton = this.radioGroup.selected;", + "this.radioGroup.selected = selectedButton;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "選択した子ラジオ ボタンを設定または取得します。" + } + }, + "setter": { + "comment": { + "shortText": "選択した子ラジオ ボタンを設定または取得します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxRippleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/ripple/IgxRippleDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxRippleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/ripple/IgxRippleDirective.json index cb872d35..dc16e864 100644 --- a/typedoc/ja/lib/directives/IgxRippleDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/ripple/IgxRippleDirective.json @@ -126,4 +126,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IActiveHighlightInfo.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/text-highlight/IActiveHighlightInfo.json similarity index 100% rename from typedoc/ja/lib/directives/IActiveHighlightInfo.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/text-highlight/IActiveHighlightInfo.json diff --git a/typedoc/ja/lib/directives/IgxTextHighlightDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/text-highlight/IgxTextHighlightDirective.json similarity index 98% rename from typedoc/ja/lib/directives/IgxTextHighlightDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/text-highlight/IgxTextHighlightDirective.json index c7c2a7de..8a5518ad 100644 --- a/typedoc/ja/lib/directives/IgxTextHighlightDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/text-highlight/IgxTextHighlightDirective.json @@ -81,7 +81,7 @@ "comment": { "shortText": [ "指定したインデックスにある強調表示をアクティブ化します。", - "(if such index exists)" + "(このようなインデックスが存在する場合)" ] } }, @@ -158,4 +158,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxTextSelectionDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/text-selection/IgxTextSelectionDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxTextSelectionDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/text-selection/IgxTextSelectionDirective.json index 5c4e2f2b..9e8c78ce 100644 --- a/typedoc/ja/lib/directives/IgxTextSelectionDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/text-selection/IgxTextSelectionDirective.json @@ -91,4 +91,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxOverlayOutletDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxOverlayOutletDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxOverlayOutletDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxOverlayOutletDirective.json index 948760e1..c8f85b5a 100644 --- a/typedoc/ja/lib/directives/IgxOverlayOutletDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxOverlayOutletDirective.json @@ -13,4 +13,4 @@ "methods": {}, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxToggleActionDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleActionDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxToggleActionDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleActionDirective.json index 2745707b..fb14e257 100644 --- a/typedoc/ja/lib/directives/IgxToggleActionDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleActionDirective.json @@ -35,4 +35,4 @@ "methods": {}, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxToggleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleDirective.json similarity index 95% rename from typedoc/ja/lib/directives/IgxToggleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleDirective.json index 5c7a76c4..280888f1 100644 --- a/typedoc/ja/lib/directives/IgxToggleDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/toggle/IgxToggleDirective.json @@ -101,7 +101,7 @@ "shortText": "トグル要素がオーバーレイ コンテナに追加された後にイベントを発生します。" } } - }, + }, "methods": { "open": { "comment": { @@ -142,13 +142,13 @@ "```" ] } + }, + "setOffset": { + "comment": { + "shortText": "対応する軸に沿って指定した量のみコンテンツをオフセットします。" + } } }, - "setOffset": { - "comment": { - "shortText": "対応する軸に沿って指定した量のみコンテンツをオフセットします。" - } - }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/ITooltipHideEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipHideEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/ITooltipHideEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipHideEventArgs.json diff --git a/typedoc/ja/lib/directives/ITooltipShowEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipShowEventArgs.json similarity index 100% rename from typedoc/ja/lib/directives/ITooltipShowEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/ITooltipShowEventArgs.json diff --git a/typedoc/ja/lib/directives/IgxTooltipDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipDirective.json similarity index 86% rename from typedoc/ja/lib/directives/IgxTooltipDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipDirective.json index bab8b897..7c4dd1fd 100644 --- a/typedoc/ja/lib/directives/IgxTooltipDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipDirective.json @@ -1,16 +1,16 @@ { "IgxTooltipDirective": { "comment": { - "text": [ - "Ignite UI for Angular Tooltip ディレクティブは、ツールチップとして動作する要素としてマークアップで HTML 要素をマークするために使用されます。", - "ツールチップは、エクスポートしたツールチップを個別のターゲット セレクター プロパティに割り当てて Ignite UI for Angular Tooltip Target と組み合わせて使用します。", - "", - "例:", - "```html", - "", - "Hello there, I am a tooltip!", - "```" - ], + "text": [ + "Ignite UI for Angular Tooltip ディレクティブは、ツールチップとして動作する要素としてマークアップで HTML 要素をマークするために使用されます。", + "ツールチップは、エクスポートしたツールチップを個別のターゲット セレクター プロパティに割り当てて Ignite UI for Angular Tooltip Target と組み合わせて使用します。", + "", + "例:", + "```html", + "", + "Hello there, I am a tooltip!", + "```" + ], "shortText": [ "**Ignite UI for Angular Tooltip** -", "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/tooltip.html)" @@ -29,11 +29,10 @@ "this.tooltip.context = \"Tooltip's context\";", "```" ], - "shortText": [ - "ツールチップに関連するデータを取得または設定します。", - "'context' は、ツールチップで作業する際のアクセスに必要な情報の保管に使用されます。", - "" - ] + "shortText": [ + "ツールチップに関連するデータを取得または設定します。", + "'context' は、ツールチップで作業する際のアクセスに必要な情報の保管に使用されます。" + ] } }, "id": { @@ -202,4 +201,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/directives/IgxTooltipTargetDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipTargetDirective.json similarity index 99% rename from typedoc/ja/lib/directives/IgxTooltipTargetDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipTargetDirective.json index 05a8e3b5..7a2d3062 100644 --- a/typedoc/ja/lib/directives/IgxTooltipTargetDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/directives/tooltip/IgxTooltipTargetDirective.json @@ -189,4 +189,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/drop-down/DropDownActionKey.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/DropDownActionKey.json similarity index 100% rename from typedoc/ja/lib/drop-down/DropDownActionKey.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/DropDownActionKey.json diff --git a/typedoc/ja/lib/drop-down/IDropDownNavigationDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IDropDownNavigationDirective.json similarity index 100% rename from typedoc/ja/lib/drop-down/IDropDownNavigationDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IDropDownNavigationDirective.json diff --git a/typedoc/ja/lib/drop-down/ISelectionEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/ISelectionEventArgs.json similarity index 100% rename from typedoc/ja/lib/drop-down/ISelectionEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/ISelectionEventArgs.json diff --git a/typedoc/ja/lib/drop-down/IgxDropDownBaseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownBaseDirective.json similarity index 100% rename from typedoc/ja/lib/drop-down/IgxDropDownBaseDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownBaseDirective.json diff --git a/typedoc/ja/lib/drop-down/IgxDropDownComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownComponent.json similarity index 95% rename from typedoc/ja/lib/drop-down/IgxDropDownComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownComponent.json index c4d477c0..e6a768a3 100644 --- a/typedoc/ja/lib/drop-down/IgxDropDownComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownComponent.json @@ -26,9 +26,7 @@ "", "```" ], - "shortText": [ - "ドロップダウンが開かれる前に発生されます。" - ] + "shortText": "ドロップダウンが開かれる前に発生されます。" } }, "onOpened": { @@ -38,9 +36,7 @@ "", "```" ], - "shortText": [ - "ドロップダウンが開かれた後に発生されます。" - ] + "shortText": "ドロップダウンが開かれた後に発生されます。" } }, "onClosing": { @@ -50,9 +46,7 @@ "", "```" ], - "shortText": [ - "ドロップダウンが閉じられる前に発生されます。" - ] + "shortText": "ドロップダウンが閉じられる前に発生されます。" } }, "onClosed": { @@ -62,9 +56,7 @@ "", "```" ], - "shortText": [ - "ドロップダウンが閉じられた後に発生されます。" - ] + "shortText": "ドロップダウンが閉じられた後に発生されます。" } }, "allowItemsFocus": { @@ -300,4 +292,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/drop-down/IgxDropDownGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownGroupComponent.json similarity index 100% rename from typedoc/ja/lib/drop-down/IgxDropDownGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownGroupComponent.json diff --git a/typedoc/ja/lib/drop-down/IgxDropDownItemBaseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemBaseDirective.json similarity index 98% rename from typedoc/ja/lib/drop-down/IgxDropDownItemBaseDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemBaseDirective.json index 79c3e8c8..35d31626 100644 --- a/typedoc/ja/lib/drop-down/IgxDropDownItemBaseDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemBaseDirective.json @@ -46,9 +46,7 @@ "let myComboItemValue = this.combo.items[0].value;", "```" ], - "shortText": [ - "項目がデータにバインドされる場合、項目の値を取得または設定します。" - ] + "shortText": "項目がデータにバインドされる場合、項目の値を取得または設定します。" } }, "isHeader": { @@ -212,4 +210,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/drop-down/IgxDropDownItemComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemComponent.json similarity index 97% rename from typedoc/ja/lib/drop-down/IgxDropDownItemComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemComponent.json index bd35921c..4e56b7ad 100644 --- a/typedoc/ja/lib/drop-down/IgxDropDownItemComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemComponent.json @@ -42,9 +42,7 @@ "let myComboItemValue = this.combo.items[0].value;", "```" ], - "shortText": [ - "項目がデータにバインドされる場合、項目の値を取得または設定します。" - ] + "shortText": "項目がデータにバインドされる場合、項目の値を取得または設定します。" } }, "isHeader": { @@ -210,4 +208,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/drop-down/IgxDropDownItemNavigationDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemNavigationDirective.json similarity index 100% rename from typedoc/ja/lib/drop-down/IgxDropDownItemNavigationDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/drop-down/IgxDropDownItemNavigationDirective.json diff --git a/typedoc/ja/lib/expansion-panel/IExpansionPanelEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IExpansionPanelEventArgs.json similarity index 100% rename from typedoc/ja/lib/expansion-panel/IExpansionPanelEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IExpansionPanelEventArgs.json diff --git a/typedoc/ja/lib/expansion-panel/IgxExpansionPanelBodyComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelBodyComponent.json similarity index 100% rename from typedoc/ja/lib/expansion-panel/IgxExpansionPanelBodyComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelBodyComponent.json diff --git a/typedoc/ja/lib/expansion-panel/IgxExpansionPanelComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelComponent.json similarity index 100% rename from typedoc/ja/lib/expansion-panel/IgxExpansionPanelComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelComponent.json diff --git a/typedoc/ja/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json similarity index 100% rename from typedoc/ja/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/expansion-panel/IgxExpansionPanelHeaderComponent.json diff --git a/typedoc/ja/lib/grids/IValueChangedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IValueChangedEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IValueChangedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/IValueChangedEventArgs.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json new file mode 100644 index 00000000..574a8370 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridBaseDirective.json @@ -0,0 +1,3817 @@ +{ + "IgxGridBaseDirective": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を展開します。" + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を縮小します。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅/高さのサイズを再計算します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", + "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" + ], + "tagName": "備考" + } + } + }, + "shortText": "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridCellComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridCellComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxGridCellComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridCellComponent.json index 8e4c71d6..fcd77dae 100644 --- a/typedoc/ja/lib/grids/IgxGridCellComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridCellComponent.json @@ -265,7 +265,7 @@ "let isCellSelected = thid.cell.isCellSelected();", "```" ], - "tagName": "deprecated" + "tagName": "非推奨" } }, "memberof": { @@ -540,7 +540,7 @@ "deprecated": { "comment": { "text": [ - "ゲッターとして `cell.editMode` を使用し、編集モードを開始または終了するために ` cell.setEditMode（true | false）` を使用してください。", + "ゲッターとして `cell.editMode` を使用し、編集モードを開始または終了するために `cell.setEditMode(true | false)` を使用してください。", "セルが編集モードにあるかどうかを取得またはします。", "```typescript", "let isCellInEditMode = this.cell.inEditMode;", @@ -638,7 +638,7 @@ "```" ] } - } + } }, "editValue": { "setter": { @@ -689,4 +689,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridStateDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json similarity index 77% rename from typedoc/ja/lib/grids/IgxGridStateDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json index c5c250cd..ec4d9eb1 100644 --- a/typedoc/ja/lib/grids/IgxGridStateDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxGridStateDirective.json @@ -4,12 +4,14 @@ "methods": { "getState": { "comment": { + "returns": "JSON 文字列にシリアル化されたの IGridState オブジェクト、またはシリアル化されていない IGridState オブジェクトを返します。 \n```html\n\n```\n```typescript\n@ViewChild(IgxGridStateDirective, { static: true }) public state;\nlet state = this.state.getState();\n```\n", "tags": {}, "shortText": "特定の機能が `options` プロパティによって無効にされていない場合、機能の状態またはすべてのグリッド機能の状態を取得します。" } }, "setState": { "comment": { + "returns": "\n```html\n\n```\n```typescript\n@ViewChild(IgxGridStateDirective, { static: true }) public state;\nthis.state.setState(gridState);\n```\n", "tags": {}, "shortText": "引数として渡された IGridState オブジェクトに基づいてグリッド機能の状態を復元します。" } diff --git a/typedoc/ja/lib/grids/IgxRowDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxRowDirective.json similarity index 99% rename from typedoc/ja/lib/grids/IgxRowDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxRowDirective.json index 81af137c..b387129e 100644 --- a/typedoc/ja/lib/grids/IgxRowDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/IgxRowDirective.json @@ -133,4 +133,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxColumnComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxColumnComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnComponent.json index 56a5694a..095e1f15 100644 --- a/typedoc/ja/lib/grids/IgxColumnComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnComponent.json @@ -1607,4 +1607,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxColumnGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnGroupComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxColumnGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnGroupComponent.json index 4cc39274..a1e4225d 100644 --- a/typedoc/ja/lib/grids/IgxColumnGroupComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnGroupComponent.json @@ -1549,4 +1549,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxColumnLayoutComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnLayoutComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxColumnLayoutComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/columns/IgxColumnLayoutComponent.json diff --git a/typedoc/ja/lib/grids/GridType.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/GridType.json similarity index 100% rename from typedoc/ja/lib/grids/GridType.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/GridType.json diff --git a/typedoc/ja/lib/grids/IColumnMovingEndEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEndEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IColumnMovingEndEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEndEventArgs.json diff --git a/typedoc/ja/lib/grids/IColumnMovingEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IColumnMovingEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingEventArgs.json diff --git a/typedoc/ja/lib/grids/IColumnMovingStartEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingStartEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IColumnMovingStartEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnMovingStartEventArgs.json diff --git a/typedoc/ja/lib/grids/IColumnResizeEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnResizeEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IColumnResizeEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IColumnResizeEventArgs.json diff --git a/typedoc/ja/lib/grids/IGridCellEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridCellEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IGridCellEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridCellEventArgs.json diff --git a/typedoc/ja/lib/grids/IGridEditEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridEditEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IGridEditEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridEditEventArgs.json diff --git a/typedoc/ja/lib/grids/IGridKeydownEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridKeydownEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IGridKeydownEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridKeydownEventArgs.json diff --git a/typedoc/ja/lib/grids/IGridToolbarExportEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridToolbarExportEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IGridToolbarExportEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IGridToolbarExportEventArgs.json diff --git a/typedoc/ja/lib/grids/IPageEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IPageEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IPageEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IPageEventArgs.json diff --git a/typedoc/ja/lib/grids/IPinColumnEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IPinColumnEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IPinColumnEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IPinColumnEventArgs.json diff --git a/typedoc/ja/lib/grids/IRowDataEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDataEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IRowDataEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDataEventArgs.json diff --git a/typedoc/ja/lib/grids/IRowDragEndEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDragEndEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IRowDragEndEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDragEndEventArgs.json diff --git a/typedoc/ja/lib/grids/IRowDragStartEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDragStartEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IRowDragStartEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowDragStartEventArgs.json diff --git a/typedoc/ja/lib/grids/IRowSelectionEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowSelectionEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IRowSelectionEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowSelectionEventArgs.json diff --git a/typedoc/ja/lib/grids/IRowToggleEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowToggleEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IRowToggleEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/common/IRowToggleEventArgs.json diff --git a/typedoc/ja/lib/grids/IgxAdvancedFilteringDialogComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/filtering/advanced-filtering/IgxAdvancedFilteringDialogComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxAdvancedFilteringDialogComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/filtering/advanced-filtering/IgxAdvancedFilteringDialogComponent.json diff --git a/typedoc/ja/lib/grids/IgxGridExcelStyleFilteringComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/filtering/excel-style/IgxGridExcelStyleFilteringComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxGridExcelStyleFilteringComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/filtering/excel-style/IgxGridExcelStyleFilteringComponent.json diff --git a/typedoc/ja/lib/grids/IGroupingDoneEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IGroupingDoneEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IGroupingDoneEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IGroupingDoneEventArgs.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json new file mode 100644 index 00000000..e9b092fb --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridComponent.json @@ -0,0 +1,4463 @@ +{ + "IgxGridComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxGridModule", + "tagName": "igxmodule" + } + }, + "igxgroup": { + "comment": { + "text": "Grids & Lists", + "tagName": "igxgroup" + } + }, + "igxkeywords": { + "comment": { + "text": "grid, table", + "tagName": "igxkeywords" + } + }, + "igxtheme": { + "comment": { + "text": "igx-grid-theme", + "tagName": "igxtheme" + } + }, + "remarks": { + "comment": { + "text": [ + "The Ignite UI Grid is used for presenting and manipulating tabular data in the simplest way possible. Once data", + "has been bound, it can be manipulated through filtering, sorting & editing operations." + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " ", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Grid provides a way to present and manipulate tabular data." + }, + "properties": { + "groupsExpanded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default rendered state is expanded.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets whether created groups are rendered expanded or collapsed." + } + }, + "groupsRecords": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let groupRecords = this.grid.groupsRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets the hierarchical representation of the group by records." + } + }, + "dropAreaTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "", + " Custom drop area! ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the template that will be rendered as a GroupBy drop area." + } + }, + "onGroupingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "The `onGroupingDone` event would be raised only once if several columns get grouped at once by calling", + "the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument.", + "The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain", + "the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation.", + "Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last**", + "grouping/ungrouping operation), not all columns which are currently grouped/ungrouped.", + "columns." + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when columns are grouped/ungrouped." + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "groupBy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.", + "The onGroupingDone event would get raised only **once** if this method gets called multiple times with the same arguments." + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "this.grid.groupBy([", + "{ fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },", + "{ fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },", + "{ fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }", + "]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one." + } + }, + "clearGrouping": { + "comment": { + "parameters": { + "name": { + "comment": { + "text": "Name of column or array of column names to be ungrouped." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "Clears all grouping in the grid, if no parameter is passed.", + "If a parameter is provided, clears grouping for a particular column or an array of columns." + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearGrouping(); //clears all grouping", + "this.grid.clearGrouping(\"ID\"); //ungroups a single column", + "this.grid.clearGrouping([\"ID\", \"Column1\", \"Column2\"]); //ungroups multiple columns", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Clears grouping for particular column, array of columns or all columns." + } + }, + "isExpandedGroup": { + "comment": { + "parameters": { + "group": { + "comment": { + "text": "The group record." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "const expandedGroup = this.grid.isExpandedGroup(this.groupRow);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Returns if a group is expanded or not." + } + }, + "toggleGroup": { + "comment": { + "parameters": { + "groupRow": { + "comment": { + "text": "The group record to toggle." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "const toggleExpGroup = this.grid.toggleGroup(this.groupRow);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Toggles the expansion state of a group." + } + }, + "fullyExpandGroup": { + "comment": { + "parameters": { + "groupRow": { + "comment": { + "text": "The group record to fully expand." + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public groupRow: IGroupByRecord;", + "this.grid.fullyExpandGroup(this.groupRow);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Expands the specified group and all of its parent groups." + } + }, + "toggleAllGroupRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleAllGroupRows;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Toggles the expansion state of all group rows recursively." + } + }, + "getSelectedData": { + "comment": { + "tags": { + "inheritdoc": { + "comment": { + "tagName": "inheritdoc" + } + } + } + } + }, + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を展開します。" + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を縮小します。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅/高さのサイズを再計算します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "If not provided it will be automatically generated.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the value of the `id` attribute." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the value of the `id` attribute." + } + } + }, + "data": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the array of data that populates the `IgxGridComponent`." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the array of data that populates the `IgxGridComponent`." + } + } + }, + "filteredData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let filteredData = this.grid.filteredData;", + "this.grid.filteredData = [...];", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets an array of objects containing the filtered data." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets an array of objects containing the filtered data." + } + } + }, + "totalItemCount": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "This property is required for remote grid virtualization to function when it is bound to remote data.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const itemCount = this.grid1.totalItemCount;", + "this.grid1.totalItemCount = 55;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the total number of records in the data source." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the total number of records in the data source." + } + } + }, + "groupingExpressions": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + } + }, + "shortText": "Gets/Sets the group by state." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the group by state." + } + } + }, + "groupingExpansionState": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "Includes only states that differ from the default one (controlled through groupsExpanded and states that the user has changed.", + "Contains the expansion state (expanded: boolean) and the unique identifier for the group row (Array).", + "Supports two-way data binding." + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets a list of expansion states for group rows." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets a list of expansion states for group rows." + } + } + }, + "hideGroupedColumns": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The default value is \"false\"", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets whether the grouped columns should be hidden." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets whether the grouped columns should be hidden." + } + } + }, + "dropAreaMessage": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "The grid needs to have at least one groupable column in order the GroupBy area to be displayed.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on." + } + }, + "getter": { + "comment": { + "shortText": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on." + } + } + }, + "groupsRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupList = this.grid.groupsRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets the list of group rows." + } + } + }, + "groupRowTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const groupRowTemplate = this.grid.groupRowTemplate;", + "this.grid.groupRowTemplate = myRowTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the template reference for the group row." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the template reference for the group row." + } + } + }, + "groupAreaTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupAreaTemplate = this.grid.groupAreaTemplate;", + "this.grid.groupAreaTemplate = myAreaTemplate.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets/Sets the template reference of the `IgxGridComponent`'s group area." + } + }, + "setter": { + "comment": { + "shortText": "Gets/Sets the template reference of the `IgxGridComponent`'s group area." + } + } + }, + "hasGroupableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupableGrid = this.grid.hasGroupableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Returns if the `IgxGridComponent` has groupable columns." + } + } + }, + "dropAreaVisible": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dropVisible = this.grid.dropAreaVisible;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Gets if the grid's group by drop area is visible." + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridExpandableCellComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridExpandableCellComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxGridExpandableCellComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridExpandableCellComponent.json index 614073b0..08f9a4d2 100644 --- a/typedoc/ja/lib/grids/IgxGridExpandableCellComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridExpandableCellComponent.json @@ -250,7 +250,7 @@ "let isCellSelected = thid.cell.isCellSelected();", "```" ], - "tagName": "deprecated" + "tagName": "非推奨" } }, "memberof": { @@ -531,7 +531,7 @@ "let isCellInEditMode = this.cell.inEditMode;", "```" ], - "tagName": "deprecated" + "tagName": "非推奨" } }, "memberof": { diff --git a/typedoc/ja/lib/grids/IgxGridGroupByRowComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridGroupByRowComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxGridGroupByRowComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridGroupByRowComponent.json index dfae1a89..5ceb6077 100644 --- a/typedoc/ja/lib/grids/IgxGridGroupByRowComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridGroupByRowComponent.json @@ -117,4 +117,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridRowComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridRowComponent.json similarity index 96% rename from typedoc/ja/lib/grids/IgxGridRowComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridRowComponent.json index 50cc15a3..56c57ac6 100644 --- a/typedoc/ja/lib/grids/IgxGridRowComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/grid/IgxGridRowComponent.json @@ -86,9 +86,7 @@ " ", "```" ], - "shortText": [ - "選択した行を含むグリッドへの参照を取得します。" - ] + "shortText": "選択した行を含むグリッドへの参照を取得します。" } } }, @@ -124,4 +122,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IColumnVisibilityChangedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hiding/IColumnVisibilityChangedEventArgs.json similarity index 100% rename from typedoc/ja/lib/grids/IColumnVisibilityChangedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/hiding/IColumnVisibilityChangedEventArgs.json diff --git a/typedoc/ja/lib/grids/IgxColumnHidingComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hiding/IgxColumnHidingComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxColumnHidingComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/hiding/IgxColumnHidingComponent.json index 414fe3a0..842eea0c 100644 --- a/typedoc/ja/lib/grids/IgxColumnHidingComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hiding/IgxColumnHidingComponent.json @@ -335,4 +335,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxChildGridRowComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxChildGridRowComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxChildGridRowComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxChildGridRowComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json new file mode 100644 index 00000000..9c44e53b --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridBaseDirective.json @@ -0,0 +1,3817 @@ +{ + "IgxHierarchicalGridBaseDirective": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を展開します。" + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を縮小します。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅/高さのサイズを再計算します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", + "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" + ], + "tagName": "備考" + } + } + }, + "shortText": "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxHierarchicalGridCellComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridCellComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxHierarchicalGridCellComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridCellComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json new file mode 100644 index 00000000..2a204896 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalGridComponent.json @@ -0,0 +1,3977 @@ +{ + "IgxHierarchicalGridComponent": { + "properties": { + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を展開します。" + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を縮小します。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅/高さのサイズを再計算します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", + "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" + ], + "tagName": "備考" + } + } + }, + "shortText": "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + } + }, + "data": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that lets you fill the `IgxHierarchicalGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns an array of data set to the `IgxHierarchicalGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + } + }, + "filteredData": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", + "```typescript", + "this.grid.filteredData = [{", + " ID: 1,", + " Name: \"A\"", + "}];", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns an array of objects containing the filtered data in the `IgxHierarchicalGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + } + }, + "expandChildren": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.", + "Defult value is false.", + "```html", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Gets if all immediate children of the `IgxHierarchicalGridComponent` previously have been set to be expanded/collapsed.", + "If previously set and some rows have been manually expanded/collapsed it will still return the last set value.", + "```typescript", + "const expanded = this.grid.expandChildren;", + "```" + ] + } + } + }, + "foreignKey": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxHierarchicalGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the", + "parent grid is set or an object reference of the parent record otherwise.", + "```typescript", + "const foreignKey = this.grid.foreignKey;", + "```" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxHierarchicalRowComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalRowComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxHierarchicalRowComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxHierarchicalRowComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json new file mode 100644 index 00000000..aec85fe2 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/hierarchical-grid/IgxRowIslandComponent.json @@ -0,0 +1,3880 @@ +{ + "IgxRowIslandComponent": { + "properties": { + "key": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets the key of the row island by which child data would be taken from the row data if such is provided.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "onGridCreated": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Event emmited when a grid is being created based on this row island.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を展開します。" + } + }, + "collapseAll": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseAll();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を縮小します。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "addRow": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.addRow(record);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しい `IgxGridRowComponent` を作成し、データ レコードをデータ ソースの終了に追加します。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "getSelectedData": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`formatters` が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。", + "`headers` が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。" + ], + "tagName": "備考" + } + } + }, + "shortText": "現在のセル選択の配列を `[{ column.field: cell.value }, ...]` の形式で返します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "expandChildren": { + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ] + } + }, + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxRowIslandComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Gets if all immediate children of the grids for this `IgxRowIslandComponent` have been set to be expanded/collapsed.", + "```typescript", + "const expanded = this.rowIsland.expandChildren;", + "```" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "transactions": { + "getter": { + "comment": { + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxColumnMovingDropDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/moving/IgxColumnMovingDropDirective.json similarity index 100% rename from typedoc/ja/lib/grids/IgxColumnMovingDropDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/moving/IgxColumnMovingDropDirective.json diff --git a/typedoc/ja/lib/grids/IgxColumnPinningComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningComponent.json similarity index 99% rename from typedoc/ja/lib/grids/IgxColumnPinningComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningComponent.json index 49959a65..989c0869 100644 --- a/typedoc/ja/lib/grids/IgxColumnPinningComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningComponent.json @@ -166,4 +166,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxColumnPinningItemDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningItemDirective.json similarity index 99% rename from typedoc/ja/lib/grids/IgxColumnPinningItemDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningItemDirective.json index d4ea91dc..7f46f5fc 100644 --- a/typedoc/ja/lib/grids/IgxColumnPinningItemDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/pinning/IgxColumnPinningItemDirective.json @@ -19,4 +19,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridSelectionService.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/selection/IgxGridSelectionService.json similarity index 94% rename from typedoc/ja/lib/grids/IgxGridSelectionService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/selection/IgxGridSelectionService.json index 39676892..0c980317 100644 --- a/typedoc/ja/lib/grids/IgxGridSelectionService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/selection/IgxGridSelectionService.json @@ -81,14 +81,14 @@ "selectMultipleRows": { "comment": { "shortText": "最後に選択した行から現在の指定行までの範囲を選択します。" + } + }, + "clearAllSelectedRows": { + "comment": { + "shortText": "rowSelection をクリアしてチェックボックス状態を更新します。" + } } - }, - "clearAllSelectedRows": { - "comment": { - "shortText": "rowSelection をクリアしてチェックボックス状態を更新します。" - } - } - }, + }, "accessors": { "ranges": { "getter": { diff --git a/typedoc/ja/lib/grids/IgxDateSummaryOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxDateSummaryOperand.json similarity index 99% rename from typedoc/ja/lib/grids/IgxDateSummaryOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxDateSummaryOperand.json index 532d7e00..d017d2e2 100644 --- a/typedoc/ja/lib/grids/IgxDateSummaryOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxDateSummaryOperand.json @@ -102,4 +102,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxNumberSummaryOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxNumberSummaryOperand.json similarity index 99% rename from typedoc/ja/lib/grids/IgxNumberSummaryOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxNumberSummaryOperand.json index 995c309b..1026d661 100644 --- a/typedoc/ja/lib/grids/IgxNumberSummaryOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxNumberSummaryOperand.json @@ -145,4 +145,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxSummaryOperand.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxSummaryOperand.json similarity index 99% rename from typedoc/ja/lib/grids/IgxSummaryOperand.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxSummaryOperand.json index 531c3df3..7da898c1 100644 --- a/typedoc/ja/lib/grids/IgxSummaryOperand.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/summaries/IgxSummaryOperand.json @@ -64,4 +64,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxGridToolbarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxGridToolbarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarComponent.json diff --git a/typedoc/ja/lib/grids/IgxGridToolbarCustomContentDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarCustomContentDirective.json similarity index 100% rename from typedoc/ja/lib/grids/IgxGridToolbarCustomContentDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/toolbar/IgxGridToolbarCustomContentDirective.json diff --git a/typedoc/ja/lib/grids/IgxTreeGridCellComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridCellComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxTreeGridCellComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridCellComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json new file mode 100644 index 00000000..44a43b70 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridComponent.json @@ -0,0 +1,4205 @@ +{ + "IgxTreeGridComponent": { + "comment": { + "text": [ + "The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and", + "provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding.", + "Example:", + "```html", + "", + " ", + " ", + " ", + "", + "```" + ], + "shortText": [ + "**Ignite UI for Angular Tree Grid** -", + "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid.html)" + ] + }, + "properties": { + "rootRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns an array of the root level `ITreeGridRecord`s.", + "```typescript", + "// gets the root record with index=2", + "const states = this.grid.rootRecords[2];", + "```" + ] + } + }, + "records": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns a map of all `ITreeGridRecord`s.", + "```typescript", + "// gets the record with primaryKey=2", + "const states = this.grid.records.get(2);", + "```" + ] + } + }, + "processedRootRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s.", + "```typescript", + "// gets the processed root record with index=2", + "const states = this.grid.processedRootRecords[2];", + "```" + ] + } + }, + "processedRecords": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns a map of all processed (filtered and sorted) `ITreeGridRecord`s.", + "```typescript", + "// gets the processed record with primaryKey=2", + "const states = this.grid.processedRecords.get(2);", + "```" + ] + } + }, + "childDataKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that sets the child data key of the `IgxTreeGridComponent`.", + "```html", + "", + "```" + ] + } + }, + "foreignKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that sets the foreign key of the `IgxTreeGridComponent`.", + "```html", + "", + "", + "```" + ] + } + }, + "hasChildrenKey": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that sets the key indicating whether a row has children.", + "This property is only used for load on demand scenarios.", + "```html", + "", + "", + "```" + ] + } + }, + "cascadeOnDelete": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property indicating whether child records should be deleted when their parent gets deleted.", + "By default it is set to true and deletes all children along with the parent.", + "```html", + "", + "", + "```" + ] + } + }, + "loadChildrenOnDemand": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that provides a callback for loading child rows on demand.", + "```html", + "", + "", + "```", + "```typescript", + "public loadChildren = (parentID: any, done: (children: any[]) => void) => {", + " this.dataService.getData(parentID, children => done(children));", + "}", + "```" + ] + } + }, + "autoGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は False です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を自動生成するかどうかを取得または設定します。" + } + }, + "emptyGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空の場合のカスタムテンプレートを取得または設定します。" + } + }, + "loadingGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "読み込み時のカスタムテンプレートを取得または設定します。" + } + }, + "filteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行された後に発生されます。" + } + }, + "advancedFilteringExpressionsTreeChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "高度フィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度フィルタリングが UI で実行された後に発生されます。" + } + }, + "paginationTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッド ページング UI のカスタム `ng-template` を取得または設定します。" + } + }, + "evenRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての偶数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "oddRowCSS": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドですべての奇数の `IgxGridRowComponent` に適用されるスタイル クラスを取得または設定します。" + } + }, + "primaryKey": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーを取得または設定します。" + } + }, + "shouldGenerate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "これにより、グリッドのリモート データへのバインドと列の自動生成を同ときに行うことができます。", + "新しいデータが割り当てらるときに列が再生成されないため、列が生成される後このプロパティは無効にされることに注意してください。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.shouldGenerate = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。" + } + }, + "columnHidingTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列非表示 UI に表示されるタイトルを取得または設定します。" + } + }, + "columnPinningTitle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列ピン固定 UI に表示されるタイトルを取得または設定します。" + } + }, + "uniqueColumnValuesStrategy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "要求に応じて一意の列値をロードするためのコールバックを提供します。", + "このプロパティが提供された場合、生成される一意の値は Excel スタイルフィルタリングによって使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Excel スタイルフィルタリングによって使用される一意の値戦略を取得または設定します。" + } + }, + "onCellClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` がクリックされたときに発生します。" + } + }, + "onSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " `IgxGridCellComponent` を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` が選択されたときに発生します。" + } + }, + "onRowSelectionChange": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `IgxGridRowComponent` が選択されたときに発生します。" + } + }, + "onColumnPinning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列に挿入するインデックスは `insertAtIndex` プロパティによって変更できます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "public columnPinning(event) {", + " if (event.column.field === \"Name\") {", + " event.insertAtIndex = 0;", + " }", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` がピン固定されたときに発生します。" + } + }, + "onCellEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "(`Esc` キーが押された時など)", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "送信せずに値を編集するときに生成されます。" + } + }, + "onCellEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集モードに入るときに生成されます。" + } + }, + "onCellEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "編集を完了してセルの編集モードを終了するときにイベントが発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルが編集された後に生成されます。" + } + }, + "onRowEditEnter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" のときに発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集モードに入るときに生成されます。" + } + }, + "onRowEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(true)` が呼び出されるときに発生されます。", + "編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の編集モードを終了するときに発生されます。" + } + }, + "onRowEditCancel": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "[rowEditable]=\"true\" & `endEdit(false)` が呼び出されるときに発生されます。", + "セル編集のときに `Esc` キーを押して、行編集オーバーレイにキャンセル ボタンを押すと発生されます。", + "このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行編集がキャンセルされるときに発生されます。" + } + }, + "onColumnInit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "列オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列が初期化されるときに発生します。" + } + }, + "onSortingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行されたときに発生されます。" + } + }, + "onFilteringDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "フィルターされた列のフィルタリング式ツリーを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが UI で実行されたときに発生されます。" + } + }, + "onPagingDone": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Returns an object consisting of the previous and next pages.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページングが実行されたときに発生されます。" + } + }, + "onRowAdded": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "新しい `IgxGridRowComponent` オブジェクトのデータを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が API によって追加されたときに発生されます。" + } + }, + "onRowDeleted": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IRowDataEventArgs` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Emitted when a row is deleted through API." + } + }, + "onDataPreLoad": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "新しいデータ チャンクが仮想化から読み込まれたときに発生されます。" + } + }, + "onColumnResized": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` オブジェクトの古い幅および新しい幅を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列がサイズ変更されたときに発生されます。" + } + }, + "onContextMenu": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`IgxGridCellComponent` オブジェクトを返します。", + "```html", + "", + "```" + ], + "tagName": "備考" + } + } + }, + "shortText": "セルが右クリックされたときに発生されます。" + } + }, + "onDoubleClick": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridCellComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルがダブルクリックされたときに発生されます。" + } + }, + "onColumnVisibilityChanged": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "引数: { column: any, newValue: boolean }", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列の表示状態を変更するときに発生されます。" + } + }, + "onColumnMovingStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "移動した `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動を開始したときに発生されます。" + } + }, + "onColumnMoving": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。 このイベントはキャンセルできます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動操作のときに発生されます。" + } + }, + "onColumnMovingEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ソースとターゲットの `IgxColumnComponent` オブジェクトを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列移動が終了したときに発生されます。" + } + }, + "onGridKeydown": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。", + "ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。 このイベントはキャンセルできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。" + } + }, + "onRowDragStart": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ドラッグされた行を返します。", + "tagName": "備考" + } + } + }, + "shortText": "行をドラッグし始めたときに発生します。" + } + }, + "onRowDragEnd": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Return the dropped row.", + "tagName": "備考" + } + } + }, + "shortText": "行をドロップしたときに発行されます。" + } + }, + "onGridCopy": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "[`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。", + "tagName": "備考" + } + } + }, + "shortText": "コピー操作が実行されたときに発生します。" + } + }, + "onRowToggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の展開状態が変更されているときに呼び出されます。" + } + }, + "emptyFilteredGridTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "emptyGridDefaultTemplate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```", + "const emptyTempalte = this.grid.emptyGridTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが空の場合に表示されるテンプレートのテンプレート参照。" + } + }, + "rowExpandedIndicatorTemplate": { + "comment": { + "shortText": "行展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "rowCollapsedIndicatorTemplate": { + "comment": { + "shortText": "行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerExpandIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "headerCollapseIndicatorTemplate": { + "comment": { + "shortText": "ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。" + } + }, + "sortingExpressionsChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "並べ替え式を返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えが UI で実行された前に発生されます。" + } + }, + "toolbar": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridToolbar = this.grid.toolbar;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxToolbarComponent` へのアクセスを提供します。" + } + }, + "onToolbarExporting": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "toolbarExporting(event: IGridToolbarExportEventArgs){", + " const toolbarExporting = event;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ユーザーがエクスポート処理が開始すると発生されます。" + } + }, + "onRangeSelection": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "範囲選択がドラッグ選択またはキーボード選択による行います。", + "tagName": "備考" + } + } + }, + "shortText": "範囲選択を行ったときに発生します。" + } + } + }, + "methods": { + "expandAll": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "すべての行を展開します。", + "```typescript", + "this.grid.expandAll();", + "```" + ] + } + }, + "collapseAll": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "すべての行を縮小します。", + "```typescript", + "this.grid.collapseAll();", + "```" + ] + } + }, + "addRow": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created", + "row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches", + "the specified parentRowID. If the parentRowID does not exist, an error would be thrown.", + "```typescript", + "const record = {", + " ID: this.grid.data[this.grid1.data.length - 1].ID + 1,", + " Name: this.newRecord", + "};", + "this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1.", + "```" + ] + } + }, + "getSelectedData": { + "comment": { + "tags": { + "inheritdoc": { + "comment": { + "tagName": "inheritdoc" + } + } + } + } + }, + "toggleColumnVisibility": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.toggleColumnVisibility({", + " column: this.grid1.columns[0],", + " newValue: true", + "});", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列の表示状態を切り替えます。" + } + }, + "expandRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.expandRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を展開します。" + } + }, + "collapseRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.collapseRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を縮小します。" + } + }, + "toggleRow": { + "comment": { + "parameters": { + "rowID": { + "comment": { + "text": "行 ID - primaryKey 値またはデータ レコード インスタンスです。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "ID は、primaryKey 値またはデータ レコード インスタンスです。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.toggleRow(rowID);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ID によって行を切り替えます。" + } + }, + "getHeaderGroupWidth": { + "comment": { + "shortText": "`IgxGridHeaderGroupComponent` に設定される `width` を取得します。" + } + }, + "getColumnByName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCol = this.grid1.getColumnByName(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィールド名によって `IgxColumnComponent` を返します。" + } + }, + "getRowByIndex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByIndex(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "インデックスによって `IgxRowDirective` を返します。" + } + }, + "getRowByKey": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const myRow = this.grid1.getRowByKey(\"cell5\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリキーによって `IgxGridRowComponent` オブジェクトを返します。" + } + }, + "getCellByColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const myCell = this.grid1.getCellByColumn(2,\"UnitPrice\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "条件と一致する `IgxGridCellComponent` を返します。" + } + }, + "getCellByKey": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "いずれかの rowID に一致します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "primaryKey プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.getCellByKey(1, 'index');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定されたプライマリ キーおよび列フィールドによって `IgxGridCellComponent` オブジェクトを返します。" + } + }, + "nextPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.nextPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最後のページにない場合、次のページに移動します。" + } + }, + "previousPage": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.previousPage();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドが最初のページにない場合、前のページに移動します。" + } + }, + "moveColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.moveColumn(compName, persDetails);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列を指定したドロップ ターゲットに移動します。" + } + }, + "paginate": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.paginate(1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定したページ インデックスに移動します。" + } + }, + "markForCheck": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.markForCheck();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` を変更検出で手動的にマークします。" + } + }, + "deleteRow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`primaryKey` プロパティの設定が必要です。", + "メソッドは、rowID である rowSelector をパラメーターとして受け取ります。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid1.deleteRow(0);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリ キーによって `IgxGridRowComponent` および対応するデータ レコードを削除します。" + } + }, + "updateCell": { + "comment": { + "parameters": { + "value": { + "comment": { + "text": "設定する新しい値。" + } + }, + "rowSelector": { + "comment": { + "text": "rowID に対応します。" + } + }, + "column": { + "comment": { + "text": "列フィールドに対応します。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "`primaryKey` プロパティの設定が必要です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.gridWithPK.updateCell('Updated', 1, 'ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "プライマリキーによって `IgxGridRowComponent` および対応するデータ レコードを更新します。" + } + }, + "updateRow": { + "comment": { + "parameters": { + "rowSelector": { + "comment": { + "text": "correspond to rowID" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": [ + "行が rowSelector パラメーターおよび渡された値を持つデータ ソース レコードによって指定されます。", + "このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.updateRow({", + " ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')", + " }, 1);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` を更新します。" + } + }, + "sort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxGridComponent` の `IgxColumnComponent` を提供した並べ替え式の配列に基づいて並べ替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` を並べ替えます。" + } + }, + "filter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "public filter(term) {", + " this.grid.filter(\"ProductName\", term, IgxStringFilteringOperand.instance().condition(\"contains\"));", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "単一の `IgxColumnComponent` をフィルターします。" + } + }, + "filterGlobal": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "同じ条件で `IgxGridComponent` のすべての `IgxColumnComponent` をフィルターします。" + } + }, + "enableSummaries": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "customSummary を設定しない場合、列のデータ型のデフォルト集計が適用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "grid.enableSummaries('ProductName');", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した列で集計を有効にし、customSummary を適用します。" + } + }, + "disableSummaries": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "grid.disableSummaries([{ fieldName: 'ProductName' }]);", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "配列の列で集計を無効にします。", + "tagName": "備考" + } + } + }, + "shortText": "指定した列で集計を無効にします。" + } + }, + "clearFilter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` のフィルター状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearFilter();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` のフィルター状態をクリアします。" + } + }, + "clearSort": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "それ以外の場合、すべての `IgxColumnComponent` の並べ替え状態をクリアします。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSort();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "名前が提供された場合、対応する `IgxColumnComponent` の並べ替え状態をクリアします。" + } + }, + "pinColumn": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "操作が成功したかどうかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定します。" + } + }, + "unpinColumn": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.pinColumn(\"ID\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列をフィールド名によってピン固定解除します。 操作が成功したかどうかを返します。" + } + }, + "reflow": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドのサイズに影響する DOM 要素を手動的にサイズ変更するときに実行します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.reflow();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅/高さのサイズを再計算します。" + } + }, + "findNext": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "オプションで、テキストは値全体に一致するかどうか (デフォルトは false)。" + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findNext(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "findPrev": { + "comment": { + "parameters": { + "text": { + "comment": { + "text": "検索する文字列。" + } + }, + "caseSensitive": { + "comment": { + "text": "オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルトは false)。" + } + }, + "exactMatch": { + "comment": { + "text": "optionally, if the text should match the entire value (defaults to false)." + } + } + }, + "tags": { + "remarks": { + "comment": { + "text": "グリッドに文字列が何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.findPrev(\"financial\");", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。" + } + }, + "refreshSearch": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "グリッドに前回の検索テキストが何回含まれるかを返します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.refreshSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "既存の検索を再適用します。" + } + }, + "clearSearch": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.clearSearch();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "セルのすべての強調表示を削除します。" + } + }, + "getPinnedWidth": { + "comment": { + "parameters": { + "takeHidden": { + "comment": { + "text": "ピン固定の領域の非表示の列を考慮に入れるかどうか。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定領域の計算幅を取得します。" + } + }, + "selectedRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "選択済み行の ID (primaryKey または rowData) を持つ配列を返します。", + "```typescript", + "const selectedRows = this.grid.selectedRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の選択状態を取得します。" + } + }, + "selectRows": { + "comment": { + "parameters": { + "clearCurrentSelection": { + "comment": { + "text": "True の場合、現在の選択をクリアします。" + } + } + }, + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectRows([1,2,5], true);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択します。" + } + }, + "deselectRows": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectRows([1,2,5]);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "指定した行を ID によって選択解除します。" + } + }, + "selectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.selectAllRows();", + "this.grid.selectAllRows(false);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択します。" + } + }, + "deselectAllRows": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。", + "onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "this.grid.deselectAllRows();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての行を選択解除します。" + } + }, + "navigateTo": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "{ targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上でカスタム ロジックを実行することもできます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`rowindex` と `visibleColumnIndex` に基づいてグリッド内の位置に移動します。" + } + }, + "getNextCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って次のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "getPreviousCell": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "`getPreviousCell` メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。", + "コールバック関数は、引数として IgxColumnComponent を受け入れます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + " const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "特定の基準に一致する、現在位置に従って前のセルを定義する `ICellPosition` を返します。" + ] + } + }, + "endEdit": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`commit === true`の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在の行の行トランザクションを完成します。" + } + }, + "openAdvancedFilteringDialog": { + "comment": { + "shortText": "高度なフィルタリング ダイアログを開きます。" + } + }, + "closeAdvancedFilteringDialog": { + "comment": { + "parameters": { + "applyChanges": { + "comment": { + "text": "変更を適用する必要があるかどうかを示します。" + } + } + }, + "tags": {}, + "shortText": "高度なフィルタリング ダイアログを閉じます。" + } + } + }, + "accessors": { + "id": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.", + "```html", + "", + "```" + ] + } + } + }, + "data": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that lets you fill the `IgxTreeGridComponent` with an array of data.", + "```html", + "", + "```" + ] + } + } + }, + "filteredData": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Returns an array of objects containing the filtered data in the `IgxGridComponent`.", + "```typescript", + "let filteredData = this.grid.filteredData;", + "```" + ] + } + }, + "setter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "Sets an array of objects containing the filtered data in the `IgxGridComponent`.", + "```typescript", + "this.grid.filteredData = [{", + " ID: 1,", + " Name: \"A\"", + "}];", + "```" + ] + } + } + }, + "transactions": { + "getter": { + "comment": { + "tags": { + "experimental": { + "comment": { + "text": "@hidden", + "tagName": "experimental" + } + } + }, + "shortText": "グリッドのためのトランザクション サービスを取得します。" + } + } + }, + "expansionDepth": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", + "set to `Infinity` which means all levels would be expanded.", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "An @Input property that sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is", + "set to `Infinity` which means all levels would be expanded.", + "```html", + "", + "```" + ] + } + } + }, + "rowLoadingIndicatorTemplate": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTreeGridComponent", + "tagName": "次のメンバー:" + } + } + }, + "text": [ + "", + "", + "```" + ], + "shortText": [ + "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", + "```html", + "", + " loop", + "" + ] + } + }, + "setter": { + "comment": { + "text": [ + "", + "", + "```" + ], + "shortText": [ + "An @Input property that provides a template for the row loading indicator when load on demand is enabled.", + "```html", + "", + " loop", + "" + ] + } + } + }, + "resourceStrings": { + "setter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで EN リソースを使用します。", + "tagName": "備考" + } + } + }, + "shortText": "リソース文字列を取得/設定します。" + } + }, + "getter": { + "comment": { + "shortText": "リソース文字列を取得/設定します。" + } + } + }, + "filteringLogic": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は AND です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + }, + "setter": { + "comment": { + "shortText": "`IgxGridComponent` のフィルター ロジックを設定します。" + } + } + }, + "filteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "フィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリング状態を取得または設定します。" + } + } + }, + "advancedFilteringExpressionsTree": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;", + "this.grid.advancedFilteringExpressionsTree = logic;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリング状態を取得または設定します。" + } + } + }, + "locale": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定されていない場合、ブラウザーの言語設定を返します。", + "tagName": "備考" + } + } + }, + "shortText": "ロケールを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ロケールを取得または設定します。" + } + } + }, + "paging": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト状態は無効 (false) です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページング機能が有効かどうかを取得または設定します。" + } + } + }, + "page": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "双方向バインディングをサポートします。", + "tagName": "備考" + } + } + }, + "shortText": "現在のページ インデックスを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "現在のページ インデックスを取得または設定します。" + } + } + }, + "perPage": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトは 15 です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ページごとに表示される項目数を取得または設定します。" + } + } + }, + "columnHiding": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列非表示 UI が有効かどうかを取得または設定します。" + } + } + }, + "hideRowSelectors": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": " デフォルトでは、行セレクターが表示されます。", + "tagName": "備考" + } + } + }, + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行セレクターが非表示されているかどうかを取得または設定します。" + } + } + }, + "rowDraggable": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が移動可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が移動可能かどうかを取得または設定します。" + } + } + }, + "rowEditable": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトの設定は false です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行が編集可能かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行が編集可能かどうかを取得または設定します。" + } + } + }, + "height": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高さを取得または設定します。" + } + } + }, + "width": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let gridWidth = this.grid.width;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの幅を取得または設定します。" + } + } + }, + "headerWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "let gridHeaderWidth = this.grid.headerWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダーの幅を取得または設定します。" + } + } + }, + "rowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "行の高さを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行の高さを取得または設定します。" + } + } + }, + "columnWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "列のデフォルトの幅を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "列のデフォルトの幅を取得または設定します。" + } + } + }, + "emptyGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "isLoading": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドは読み込みインジケータを表すかどうかを取得または設定します。" + } + } + }, + "emptyFilteredGridMessage": { + "setter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + }, + "getter": { + "comment": { + "shortText": "グリッドがフィルターされ、レコードがない場合に表示されるメッセージを取得または設定します。" + } + } + }, + "pinning": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "列のピン固定を開始または終了に適用できます。", + "一度に両側にピン固定することはできません。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "初期のピン固定構成を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "初期のピン固定構成を取得または設定します。" + } + } + }, + "columnPinning": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "定義済みの列固定 UI をツールバーに表示するかどうかを取得または設定します。" + } + } + }, + "allowFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルタリングが有効かどうかを取得または設定します。" + } + } + }, + "allowAdvancedFiltering": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "高度なフィルタリングが有効かどうかを示す値を取得または設定します。" + } + } + }, + "filterMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで FilterMode.quickFilter に設定されます。", + "tagName": "備考" + } + } + }, + "shortText": "フィルター モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルター モードを取得または設定します。" + } + } + }, + "summaryPosition": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで bottom です。", + "tagName": "備考" + } + } + }, + "shortText": "集計位置を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計位置を取得または設定します。" + } + } + }, + "summaryCalculationMode": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + }, + "remarks": { + "comment": { + "text": "デフォルトで rootAndChildLevels で、集計はルート レベルと各子レベルのために計算されます。", + "tagName": "備考" + } + } + }, + "shortText": "集計計算モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "集計計算モードを取得または設定します。" + } + } + }, + "filterStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドのフィルタリング ストラテジを取得または設定します。" + } + } + }, + "sortStrategy": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "グリッドの並べ替えストラテジを取得または設定します。" + } + } + }, + "headerGroupsList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headerGroupsList = this.grid.headerGroupsList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderGroupComponent` のリスト。" + } + } + }, + "headerCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const headers = this.grid.headerCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridHeaderComponent` のリスト。" + } + } + }, + "filterCellList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterCells = this.grid.filterCellList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "すべての `IgxGridFilteringCellComponent` のリスト。" + } + } + }, + "rowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowList = this.grid.rowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridRowComponent` のリスト。" + } + } + }, + "dataRowList": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const dataList = this.grid.dataRowList;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在描画されている `IgxGridRowComponent` のリスト。" + } + } + }, + "toolbarCustomContentTemplate": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let customContentTemplate = this.grid.toolbarCustomContentTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "カスタム コンテンツを表示するためにツールバーで使用されるテンプレートを返します。" + } + } + }, + "dragIndicatorIconTemplate": { + "getter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + }, + "setter": { + "comment": { + "shortText": "カスタム テンプレートがある場合、行ドラッグのインジケーター アイコンを描画するために使用されます。" + } + } + }, + "sortingExpressions": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "Supports two-way data binding.", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "並べ替えの状態を取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "並べ替えの状態を取得または設定します。" + } + } + }, + "hiddenColumnsCount": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const hiddenCol = this.grid.hiddenColumnsCount;", + "``" + ], + "tagName": "例" + } + } + }, + "shortText": "非表示列の数を取得します。" + } + } + }, + "hiddenColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列非表示 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "pinnedColumnsText": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "`IgxColumnComponent` の定義済みの列ピン固定 UI に使用します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "切り替え ボタンに表示されるテキストを取得または設定します。" + } + } + }, + "showToolbar": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーが表示されるかどうかを取得または設定します。" + } + } + }, + "toolbarTitle": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ツールバーのタイトルを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "ツールバーのタイトルを取得または設定します。" + } + } + }, + "exportExcel": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "MS Excel へのエクスポート オプションが有効かどうかを取得または設定します。" + } + } + }, + "exportCsv": { + "getter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "CSV へのエクスポート オプションが有効かどうかを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "exportExcelText": { + "getter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": [ + "MS Excel エクスポート ボタンのテキスト コンテンツを取得または設定します。", + "```html", + "", + "```" + ] + } + } + }, + "exportCsvText": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "CSV エクスポート ボタンのテキスト コンテンツを取得または設定します。" + } + } + }, + "cellSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、セル選択モードは multiple です。", + "tagName": "備考" + } + } + }, + "shortText": "セル選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "セル選択モードを取得または設定します。" + } + } + }, + "rowSelection": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルトでは、行選択モードは none です。", + "tagName": "備考" + } + } + }, + "shortText": "行選択モードを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "行選択モードを取得または設定します。" + } + } + }, + "expansionStates": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "デフォルト状態に異なる状態のみ含まれます。", + "双方向バインディングをサポートします。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + }, + "setter": { + "comment": { + "shortText": "キーと値のペア [行 Id、展開状態] のリストを取得または設定します。" + } + } + }, + "nativeElement": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const nativeEl = this.grid.nativeElement.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ要素を取得します。" + } + } + }, + "defaultRowHeight": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const rowHeigh = this.grid.defaultRowHeight;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "デフォルトの行の高さを取得します。" + } + } + }, + "defaultHeaderGroupMinWidth": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。", + "以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。" + ], + "tagName": "備考" + } + } + }, + "shortText": "`IgxGridHeaderGroupComponent` の最小許容幅を返します。" + } + } + }, + "pinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedWidth = this.grid.getPinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "unpinnedWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedWidth = this.grid.getUnpinnedWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` のコンテナーの現在幅を取得します。" + } + } + }, + "columns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const colums = this.grid.columns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxColumnComponent` の配列を取得します。" + } + } + }, + "pinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const pinnedColumns = this.grid.pinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン固定の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "unpinnedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const unpinnedColumns = this.grid.unpinnedColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ピン解除の `IgxColumnComponent` の配列を取得します。" + } + } + }, + "visibleColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const visibleColumns = this.grid.visibleColumns.", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxChipComponent` の配列を返します。" + } + } + }, + "totalPages": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const totalPages = this.grid.totalPages;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ページの合計数を取得します。" + } + } + }, + "isFirstPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const firstPage = this.grid.isFirstPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが先頭かどうかを取得します。" + } + } + }, + "totalRecords": { + "getter": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "ページングが有効な場合のみ動作します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "const totalRecords = this.grid.totalRecords;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "合計レコード数を返します。" + } + } + }, + "isLastPage": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const lastPage = this.grid.isLastPage;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在のページが最後のページかどうかを返します。" + } + } + }, + "totalWidth": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const gridWidth = this.grid.totalWidth;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` の合計幅を返します。" + } + } + }, + "hasSortableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const sortableGrid = this.grid.hasSortableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に並べ替え可能な列があるかどうかを返します。" + } + } + }, + "hasEditableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const editableGrid = this.grid.hasEditableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に編集可能な列があるかどうかを返します。" + } + } + }, + "hasFilterableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filterableGrid = this.grid.hasFilterableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` にフィルター可能な列があるかどうかを返します。" + } + } + }, + "hasSummarizedColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const summarizedGrid = this.grid.hasSummarizedColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に集計可能な列があるかどうかを返します。" + } + } + }, + "hasMovableColumns": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const movableGrid = this.grid.hasMovableColumns;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に移動可能な列があるかどうかを返します。" + } + } + }, + "hasColumnGroups": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const groupGrid = this.grid.hasColumnGroups;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` に列グループがあるかどうかを返します。" + } + } + }, + "hasColumnLayouts": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const layoutGrid = this.grid.hasColumnLayouts;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridComponent` が複数行レイアウト定義用の列レイアウトを持っているかどうかを返します。" + } + } + }, + "selectedCells": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const selectedCells = this.grid.selectedCells;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`IgxGridCellComponent` 選択されているメモの配列を返します。" + } + } + }, + "dataView": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + " const dataView = this.grid.dataView;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "グリッドに表示される、現在変換されているページングされた/フィルターされた/並べ替えされた/グループ化された データを返します。" + } + } + }, + "filteredSortedData": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "const filteredSortedData = this.grid1.filteredSortedData;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + }, + "setter": { + "comment": { + "shortText": "フィルターされて並べ替え済みのデータを含む配列を返します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/grids/IgxTreeGridRowComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridRowComponent.json similarity index 100% rename from typedoc/ja/lib/grids/IgxTreeGridRowComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/grids/tree-grid/IgxTreeGridRowComponent.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json new file mode 100644 index 00000000..cef34f2e --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/icon/IgxIconComponent.json @@ -0,0 +1,285 @@ +{ + "IgxIconComponent": { + "properties": { + "ariaHidden": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\") public icon: IgxIconComponent;", + "constructor(private cdRef:ChangeDetectorRef) {}", + "ngAfterViewInit() {", + " this.icon.ariaHidden = false;", + " this.cdRef.detectChanges();", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `aria-hidden` 属性を無効にできます。デフォルトでクラスが適用されます。" + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`id` 属性の値を設定する @Input プロパティ。" + } + }, + "font": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `fontSet` の値を設定する @Input プロパティ。デフォルトは、\"material\" です。" + } + }, + "active": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `active` プロパティの無効化を許可する @Input プロパティ。デフォルトでクラスが適用されます。" + } + }, + "iconColor": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "settings", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " アイコンの `iconColor` の変更を許可する @Input プロパティ。" + } + }, + "iconName": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " アイコンの `iconName` の変更を許可する @Input プロパティ。" + } + }, + "el": { + "comment": { + "shortText": "`igx-icon` コンポーネントの ElementRef プロパティ。" + } + } + }, + "methods": {}, + "accessors": { + "getFontSet": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconFont = this.icon.getFontSet;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " font プロパティの値を返すアクセサー。" + } + } + }, + "getActive": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconActive = this.icon.getActive;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " active プロパティの値を返すアクセサー。" + } + } + }, + "getInactive": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconActive = this.icon.getInactive;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " inactive プロパティを返すアクセサー。" + } + } + }, + "getIconColor": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconColor = this.icon.getIconColor;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " `iconColor` プロパティの逆値を返すアクセサー。" + } + } + }, + "getIconName": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconName = this.icon.getIconName;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " iconName プロパティの値を返すアクセサー。" + } + } + }, + "getSvgKey": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let svgKey = this.icon.getSvgKey;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + " SVG 画像のキーを返すアクセサー。", + " アンダースコアで区切られた fontSet と iconName で構成されるキー。" + ] + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "@ViewChild(\"MyIcon\")", + "public icon: IgxIconComponent;", + "ngAfterViewInit() {", + " let iconTemplate = this.icon.template;", + "}", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": " 明示的、暗黙、またはなしの合字を参照する TemplateRef を返すアクセサー。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/icon/IgxIconService.json b/typedoc/ja/projects/igniteui-angular/src/lib/icon/IgxIconService.json similarity index 100% rename from typedoc/ja/lib/icon/IgxIconService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/icon/IgxIconService.json diff --git a/typedoc/ja/lib/input-group/IgxInputGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/input-group/IgxInputGroupComponent.json similarity index 98% rename from typedoc/ja/lib/input-group/IgxInputGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/input-group/IgxInputGroupComponent.json index 5d4381cf..65c0c877 100644 --- a/typedoc/ja/lib/input-group/IgxInputGroupComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/input-group/IgxInputGroupComponent.json @@ -3,9 +3,7 @@ "properties": { "element": { "comment": { - "shortText": [ - "`IgxInputGroupComponent` の ElementRef プロパティ。" - ] + "shortText": "`IgxInputGroupComponent` の ElementRef プロパティ。" } }, "id": { @@ -261,4 +259,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/list/IListItemClickEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json similarity index 68% rename from typedoc/ja/lib/list/IListItemClickEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json index c87d4ce4..b63917f0 100644 --- a/typedoc/ja/lib/list/IListItemClickEventArgs.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemClickEventArgs.json @@ -1,5 +1,8 @@ { "IListItemClickEventArgs": { + "comment": { + "shortText": "listItemClick igxList イベント引数のインターフェイス。" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/ja/lib/list/IListItemPanningEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json similarity index 68% rename from typedoc/ja/lib/list/IListItemPanningEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json index 785dac83..ad1b16d4 100644 --- a/typedoc/ja/lib/list/IListItemPanningEventArgs.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/list/IListItemPanningEventArgs.json @@ -1,5 +1,8 @@ { "IListItemPanningEventArgs": { + "comment": { + "shortText": "listItemPanning igxList イベント引数のインターフェイス。" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/ja/lib/list/IPanStateChangeEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json similarity index 68% rename from typedoc/ja/lib/list/IPanStateChangeEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json index 14055820..9fe5c66d 100644 --- a/typedoc/ja/lib/list/IPanStateChangeEventArgs.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/list/IPanStateChangeEventArgs.json @@ -1,5 +1,8 @@ { "IPanStateChangeEventArgs": { + "comment": { + "shortText": "panStateChange igxList イベント引数のインターフェイス。" + }, "properties": { "owner": { "comment": { diff --git a/typedoc/ja/lib/list/IgxListActionDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListActionDirective.json similarity index 100% rename from typedoc/ja/lib/list/IgxListActionDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListActionDirective.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListComponent.json new file mode 100644 index 00000000..b261150d --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListComponent.json @@ -0,0 +1,564 @@ +{ + "IgxListComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxListModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-list-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "list, data", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "グリッド & リスト", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": [ + "Ignite UI List は項目の行を表示し、ヘッダー項目を 1 つ以上、さらにリスト項目の検索およびフィルタリングをサポートします。 各リスト項目はすべての有効な HTML または Angular コンポーネントをサポートするテンプレートに設定できます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " Contacts", + " ", + " {{ contact.name }}", + " {{ contact.phone }}", + " ", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "テンプレート化可能なリスト書式設定でデータ項目のコレクションを表示します。" + }, + "properties": { + "children": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listChildren: QueryList = this.list.children;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストのすべての項目およびヘッダーのコレクションを返します。" + } + }, + "emptyListTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "このテンプレートはリスト項目を定義せずに `isLoading` を `false` に設定した場合に IgxList で使用されます。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

No contacts! :(

", + " ", + "", + "```", + "```typescript", + "let emptyTemplate = this.list.emptyListTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "空のリスト テンプレートを設定または取得します。" + } + }, + "dataLoadingTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このテンプレートはリスト項目を定義せずに `isLoading` を `true` に設定した場合に IgxList で使用されます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + "

Patience, we are currently loading your data...

", + " ", + "", + "```", + "```typescript", + "let loadingTemplate = this.list.dataLoadingTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストの読み込みテンプレートを設定または取得します。" + } + }, + "listItemLeftPanningTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は `null` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " deleteDelete", + " ", + "", + "```", + "```typescript", + "let itemLeftPanTmpl = this.list.listItemLeftPanningTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リスト項目を左パンニングするテンプレートを設定または取得します。" + } + }, + "listItemRightPanningTemplate": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は `null` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " ", + " callDial", + " ", + "", + "```", + "```typescript", + "let itemRightPanTmpl = this.list.listItemRightPanningTemplate;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リスト項目を右パンニングするテンプレートを設定または取得します。" + } + }, + "panEndTriggeringThreshold": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "このプロパティのデフォルトは0.5 でリスト項目幅の 50% を意味します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "項目のパンニングが自動的に完了した後にしきい値を提供します。" + } + }, + "id": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "設定しない場合、最初のリスト コンポーネントの `id` は `\"igx-list-0\"` になります。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let listId = this.list.id;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストの `id` を取得または設定します。" + } + }, + "allowLeftPanning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は `false` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isLeftPanningAllowed = this.list.allowLeftPanning;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "項目の左パンニングが許可されるかどうかを取得または設定します。" + } + }, + "allowRightPanning": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "デフォルト値は `false` です。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```", + "```typescript", + "let isRightPanningAllowed = this.list.allowRightPanning;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "項目の右パンニングが許可されるかどうかを取得または設定します。" + } + }, + "isLoading": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": [ + "データの取得中に dataLoadingTemplate を表示するために設定します。", + "デフォルト値は `false` です。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + " ", + "```", + "```typescript", + "let isLoading = this.list.isLoading;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストがデータを読み込んでいるかどうかを取得または設定します。" + } + }, + "onLeftPan": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "イベント引数としてタイプ `IListItemPanningEventArgs` のオブジェクトへの参照を提供します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "左パンニング ジェスチャがリスト項目に実行されたときに発生するイベント。" + } + }, + "onRightPan": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "イベント引数としてタイプ `IListItemPanningEventArgs` のオブジェクトへの参照を提供します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "右パンニング ジェスチャがリスト項目に実行されたときに発生するイベント。" + } + }, + "onPanStateChange": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "イベント引数として `IgxListItemComponent` および `IgxListPanState` への参照を提供します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "パンニング ジェスチャがリスト項目に実行されたときに発生するイベント。" + } + }, + "onItemClicked": { + "comment": { + "tags": { + "remarks": { + "comment": { + "text": "イベント引数として `IgxListItemComponent` および `Event` への参照を提供します。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リスト項目がクリックされたときに発生するイベント。" + } + } + }, + "methods": {}, + "accessors": { + "role": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listRole = this.list.role;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`role` 属性の値を取得します。" + } + } + }, + "isListEmpty": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let isEmpty = this.list.isListEmpty;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストが空かどうかを示すブール値を取得します。" + } + } + }, + "items": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listItems: IgxListItemComponent[] = this.list.items;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "リストのヘッダー以外の `items` を取得します。" + } + } + }, + "headers": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listHeaders: IgxListItemComponent[] = this.list.headers;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ヘッダー リストの `items` を取得します。" + } + } + }, + "context": { + "getter": { + "comment": { + "tags": { + "remark": { + "comment": { + "text": [ + "`IgxListComponent` である $implicit 宣言を提供して `list container` への `template context` バインディングを表す `context` オブジェクトを取得します。" + ], + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```typescript", + "let listComponent = this.list.context;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "テンプレート バインドの `context` オブジェクトを取得します。" + } + } + }, + "template": { + "getter": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let listTemplate = this.list.template;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "現在使用されているテンプレートの `TemplateRef` を取得します。" + } + } + }, + "displayDensity": { + "getter": { + "comment": { + "shortText": [ + "コンポーネントのテーマを返します。", + "デフォルト テーマは `comfortable` です。", + "利用可能なオプションは `comfortable`、`cosy`、および `compact` です。", + "```typescript", + "let componentTheme = this.component.displayDensity;", + "```" + ] + } + }, + "setter": { + "comment": { + "shortText": "コンポーネントのテーマを設定します。" + } + } + } + } + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/list/IgxListItemComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListItemComponent.json similarity index 99% rename from typedoc/ja/lib/list/IgxListItemComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListItemComponent.json index 1ec791f9..6ac379f1 100644 --- a/typedoc/ja/lib/list/IgxListItemComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListItemComponent.json @@ -366,4 +366,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/list/IgxListLineDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineDirective.json similarity index 100% rename from typedoc/ja/lib/list/IgxListLineDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineDirective.json diff --git a/typedoc/ja/lib/list/IgxListLineSubTitleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineSubTitleDirective.json similarity index 100% rename from typedoc/ja/lib/list/IgxListLineSubTitleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineSubTitleDirective.json diff --git a/typedoc/ja/lib/list/IgxListLineTitleDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineTitleDirective.json similarity index 100% rename from typedoc/ja/lib/list/IgxListLineTitleDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListLineTitleDirective.json diff --git a/typedoc/ja/lib/list/IgxListThumbnailDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListThumbnailDirective.json similarity index 100% rename from typedoc/ja/lib/list/IgxListThumbnailDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/list/IgxListThumbnailDirective.json diff --git a/typedoc/ja/lib/navbar/IgxActionIconDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/navbar/IgxActionIconDirective.json similarity index 100% rename from typedoc/ja/lib/navbar/IgxActionIconDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/navbar/IgxActionIconDirective.json diff --git a/typedoc/ja/lib/navbar/IgxNavbarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/navbar/IgxNavbarComponent.json similarity index 99% rename from typedoc/ja/lib/navbar/IgxNavbarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/navbar/IgxNavbarComponent.json index b8bf3316..d6213975 100644 --- a/typedoc/ja/lib/navbar/IgxNavbarComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/navbar/IgxNavbarComponent.json @@ -106,4 +106,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/navigation-drawer/IgxNavigationDrawerComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/navigation-drawer/IgxNavigationDrawerComponent.json similarity index 82% rename from typedoc/ja/lib/navigation-drawer/IgxNavigationDrawerComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/navigation-drawer/IgxNavigationDrawerComponent.json index 51b67752..938ffa0a 100644 --- a/typedoc/ja/lib/navigation-drawer/IgxNavigationDrawerComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/navigation-drawer/IgxNavigationDrawerComponent.json @@ -35,9 +35,7 @@ " ", "```" ], - "shortText": [ - "コンポーネントの ID" - ] + "shortText": "コンポーネントの ID" } }, "position": { @@ -52,9 +50,7 @@ "", "```" ], - "shortText": [ - "Navigation Drawer の位置。\"left\" (デフォルト値) または \"right\" です。" - ] + "shortText": "Navigation Drawer の位置。\"left\" (デフォルト値) または \"right\" です。" } }, "enableGestures": { @@ -102,7 +98,8 @@ "```html", "", "", - "```" ], + "```" + ], "shortText": [ "自動ピン固定を切り替えるためのデバイスの最小幅。", "デフォルト値は 1024 です。この動作を無効にするには falsy 値に設定します。" @@ -121,9 +118,7 @@ "", "```" ], - "shortText": [ - "開いたドロアーの幅。デフォルト値は \"280px\" です。" - ] + "shortText": "開いたドロアーの幅。デフォルト値は \"280px\" です。" } }, "miniWidth": { @@ -138,9 +133,7 @@ "", "```" ], - "shortText": [ - "mini 状態でドロアーの幅。デフォルト値は 60px です。" - ] + "shortText": "mini 状態でドロアーの幅。デフォルト値は 60px です。" } }, "pinChange": { @@ -150,9 +143,7 @@ "", "```" ], - "shortText": [ - "TwoWay バインディングのためのピン固定状態変更の出力。" - ] + "shortText": "TwoWay バインディングのためのピン固定状態変更の出力。" } }, "opening": { @@ -162,9 +153,7 @@ " ", "```" ], - "shortText": [ - "Navigation Drawer が開くときに発生するイベント。" - ] + "shortText": "Navigation Drawer が開くときに発生するイベント。" } }, "opened": { @@ -174,9 +163,7 @@ "", "```" ], - "shortText": [ - "Navigation Drawer が開いたときに発生するイベント。" - ] + "shortText": "Navigation Drawer が開いたときに発生するイベント。" } }, "closing": { @@ -186,9 +173,7 @@ "", "```" ], - "shortText": [ - "Navigation Drawer が閉じるときに発生するイベント。" - ] + "shortText": "Navigation Drawer が閉じるときに発生するイベント。" } }, "closed": { @@ -198,9 +183,7 @@ "", "```" ], - "shortText": [ - "Navigation Drawer が閉じたときに発生するイベント。" - ] + "shortText": "Navigation Drawer が閉じたときに発生するイベント。" } } }, @@ -210,10 +193,9 @@ "text": [ "```typescript", "this.navdrawer.toggle();", - "```" ], - "shortText": [ - "Navigation Drawer の開く状態を切り替えます。" - ] + "```" + ], + "shortText": "Navigation Drawer の開く状態を切り替えます。" } }, "open": { @@ -223,9 +205,7 @@ "this.navdrawer.open();", "```" ], - "shortText": [ - "Navigation Drawer を開きます。すでに開いている場合は効果がありません。" - ] + "shortText": "Navigation Drawer を開きます。すでに開いている場合は効果がありません。" } }, "close": { @@ -235,9 +215,7 @@ "this.navdrawer.close();", "```" ], - "shortText": [ - "Navigation Drawer を閉じます。すでに閉じている場合は効果がありません。" - ] + "shortText": "Navigation Drawer を閉じます。すでに閉じている場合は効果がありません。" } } }, @@ -247,7 +225,7 @@ "comment": { "text": [ "```typescript", - "// get", + "// 取得", "let navDrawerIsOpen = this.navdrawer.isOpen;", "```", "```html", @@ -267,7 +245,7 @@ "comment": { "text": [ "```typescript", - "// get", + "// 取得", "let navDrawerIsOpen = this.navdrawer.isOpen;", "```", "```html", diff --git a/typedoc/ja/lib/paginator/IgxPaginatorComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/paginator/IgxPaginatorComponent.json similarity index 100% rename from typedoc/ja/lib/paginator/IgxPaginatorComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/paginator/IgxPaginatorComponent.json diff --git a/typedoc/ja/lib/progressbar/BaseProgress.json b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/BaseProgress.json similarity index 99% rename from typedoc/ja/lib/progressbar/BaseProgress.json rename to typedoc/ja/projects/igniteui-angular/src/lib/progressbar/BaseProgress.json index aa363821..fec896c2 100644 --- a/typedoc/ja/lib/progressbar/BaseProgress.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/BaseProgress.json @@ -40,4 +40,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/progressbar/IChangeProgressEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IChangeProgressEventArgs.json similarity index 100% rename from typedoc/ja/lib/progressbar/IChangeProgressEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IChangeProgressEventArgs.json diff --git a/typedoc/ja/lib/progressbar/IgxCircularProgressBarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxCircularProgressBarComponent.json similarity index 99% rename from typedoc/ja/lib/progressbar/IgxCircularProgressBarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxCircularProgressBarComponent.json index 2f884683..8fcc84dd 100644 --- a/typedoc/ja/lib/progressbar/IgxCircularProgressBarComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxCircularProgressBarComponent.json @@ -214,4 +214,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/progressbar/IgxLinearProgressBarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxLinearProgressBarComponent.json similarity index 99% rename from typedoc/ja/lib/progressbar/IgxLinearProgressBarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxLinearProgressBarComponent.json index 8430d1d2..1505e934 100644 --- a/typedoc/ja/lib/progressbar/IgxLinearProgressBarComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/progressbar/IgxLinearProgressBarComponent.json @@ -11,32 +11,32 @@ ] } }, - "id": { + "indeterminate": { "comment": { "shortText": [ - "`id` 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。", + "`IgxLinearProgressBarComponent` に indeterminate を設定します。デフォルトの設定は false です。", "```html", - "", + "", "```" ] } }, - "indeterminate": { + "role": { "comment": { "shortText": [ - "`IgxLinearProgressBarComponent` に indeterminate を設定します。デフォルトの設定は false です。", + "`role` 属性の値を設定する @Input プロパティ。指定しない場合は、自動的に `progressbar` に設定されます。", "```html", - "", + "", "```" ] } }, - "role": { + "id": { "comment": { "shortText": [ - "`role` 属性の値を設定する @Input プロパティ。指定しない場合は、自動的に `progressbar` に設定されます。", + "`id` 属性の値を設定する @Input プロパティ。提供されていない場合は、自動的に生成されます。", "```html", - "", + "", "```" ] } @@ -263,4 +263,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/radio/IChangeRadioEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/radio/IChangeRadioEventArgs.json similarity index 100% rename from typedoc/ja/lib/radio/IChangeRadioEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/radio/IChangeRadioEventArgs.json diff --git a/typedoc/ja/lib/radio/IgxRadioComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/radio/IgxRadioComponent.json similarity index 99% rename from typedoc/ja/lib/radio/IgxRadioComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/radio/IgxRadioComponent.json index 1ca428e4..d9b05a4a 100644 --- a/typedoc/ja/lib/radio/IgxRadioComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/radio/IgxRadioComponent.json @@ -420,4 +420,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/select/IgxSelectComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectComponent.json similarity index 99% rename from typedoc/ja/lib/select/IgxSelectComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectComponent.json index 2a6815ae..28256679 100644 --- a/typedoc/ja/lib/select/IgxSelectComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectComponent.json @@ -80,7 +80,7 @@ "comment": { "text": [ "```typescript", - "// Set in typescript", + "// Typescript に設定", "const myCustomTemplate: TemplateRef = myComponent.customTemplate;", "myComponent.select.headerTemplate = myCustomTemplate;", "```", @@ -103,7 +103,7 @@ "comment": { "text": [ "```typescript", - "// Set in typescript", + "// Typescript に設定", "const myCustomTemplate: TemplateRef = myComponent.customTemplate;", "myComponent.select.footerTemplate = myCustomTemplate;", "```", diff --git a/typedoc/ja/lib/select/IgxSelectGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectGroupComponent.json similarity index 100% rename from typedoc/ja/lib/select/IgxSelectGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectGroupComponent.json diff --git a/typedoc/ja/lib/select/IgxSelectItemComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectItemComponent.json similarity index 100% rename from typedoc/ja/lib/select/IgxSelectItemComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/select/IgxSelectItemComponent.json diff --git a/typedoc/ja/lib/services/CsvFileTypes.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/csv/CsvFileTypes.json similarity index 100% rename from typedoc/ja/lib/services/CsvFileTypes.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/csv/CsvFileTypes.json diff --git a/typedoc/ja/lib/services/ICsvExportEndedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/csv/ICsvExportEndedEventArgs.json similarity index 100% rename from typedoc/ja/lib/services/ICsvExportEndedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/csv/ICsvExportEndedEventArgs.json diff --git a/typedoc/ja/lib/services/IgxCsvExporterOptions.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterOptions.json similarity index 100% rename from typedoc/ja/lib/services/IgxCsvExporterOptions.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterOptions.json diff --git a/typedoc/ja/lib/services/IgxCsvExporterService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterService.json similarity index 100% rename from typedoc/ja/lib/services/IgxCsvExporterService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/csv/IgxCsvExporterService.json diff --git a/typedoc/ja/lib/services/IExcelExportEndedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IExcelExportEndedEventArgs.json similarity index 100% rename from typedoc/ja/lib/services/IExcelExportEndedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IExcelExportEndedEventArgs.json diff --git a/typedoc/ja/lib/services/IgxExcelExporterOptions.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterOptions.json similarity index 100% rename from typedoc/ja/lib/services/IgxExcelExporterOptions.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterOptions.json diff --git a/typedoc/ja/lib/services/IgxExcelExporterService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterService.json similarity index 100% rename from typedoc/ja/lib/services/IgxExcelExporterService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/excel/IgxExcelExporterService.json diff --git a/typedoc/ja/lib/services/IColumnExportingEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IColumnExportingEventArgs.json similarity index 100% rename from typedoc/ja/lib/services/IColumnExportingEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IColumnExportingEventArgs.json diff --git a/typedoc/ja/lib/services/IRowExportingEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IRowExportingEventArgs.json similarity index 100% rename from typedoc/ja/lib/services/IRowExportingEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IRowExportingEventArgs.json diff --git a/typedoc/ja/lib/services/IgxBaseExporter.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IgxBaseExporter.json similarity index 100% rename from typedoc/ja/lib/services/IgxBaseExporter.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IgxBaseExporter.json diff --git a/typedoc/ja/lib/services/IgxExporterOptionsBase.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IgxExporterOptionsBase.json similarity index 100% rename from typedoc/ja/lib/services/IgxExporterOptionsBase.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/exporter-common/IgxExporterOptionsBase.json diff --git a/typedoc/ja/lib/services/IgxOverlayService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json similarity index 64% rename from typedoc/ja/lib/services/IgxOverlayService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json index 164c9722..b6e97867 100644 --- a/typedoc/ja/lib/services/IgxOverlayService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/IgxOverlayService.json @@ -2,15 +2,15 @@ "IgxOverlayService": { "comment": { "shortText": [ - "[ヘルプ](https://jp.infragistics.com/products/ignite-ui-angular/angular/components/overlay_main.html)", - "オーバーレイ サービスは、ページのその他すべての要素のオーバーレイ div にコンポーネントを表示できます。" + "[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay_main.html)", + "The overlay service allows users to show components on overlay div above all other elements in the page." ] }, "properties": { "onOpening": { "comment": { "shortText": [ - "コンポーネントが開かれる前に発生されます。", + "Emitted before the component is opened.", "```typescript", "onOpening(event: OverlayCancelableEventArgs){", " const onOpening = event;", @@ -22,7 +22,7 @@ "onAppended": { "comment": { "shortText": [ - "コンポーネントがオーバーレイに追加された後、アニメーションが開始される前に生成されます。", + "Emitted after the component is appended to the overlay, and before animations are started.", "```typescript", "onAppended(event: OverlayEventArgs){", " const onAppended = event;", @@ -34,7 +34,7 @@ "onOpened": { "comment": { "shortText": [ - "コンポーネントが開いて、すべてのアニメーションが完了した後に発生します。", + "Emitted after the component is opened and all animations are finished.", "```typescript", "onOpened(event: OverlayEventArgs){", " const onOpened = event;", @@ -46,7 +46,7 @@ "onClosing": { "comment": { "shortText": [ - "コンポーネントが閉じられる前に発生されます。", + "Emitted before the component is closed.", "```typescript", "onClosing(event: OverlayCancelableEventArgs){", " const onClosing = event;", @@ -58,7 +58,7 @@ "onClosed": { "comment": { "shortText": [ - "コンポーネントが閉じて、すべてのアニメーションが完了した後に発生します。", + "Emitted after the component is closed and all animations are finished.", "```typescript", "onClosed(event: OverlayEventArgs){", " const onClosed = event;", @@ -70,7 +70,7 @@ "onAnimation": { "comment": { "shortText": [ - "アニメーションを開始する前に発生されます。", + "Emitted before animation is started", "```typescript", "onAnimation(event: OverlayAnimationEventArgs){", " const onAnimation = event;", @@ -83,58 +83,61 @@ "methods": { "attach": { "comment": { + "returns": "Id of the created overlay. Valid until `onClosed` is emitted.\n", "parameters": { "component": { "comment": { - "text": "オーバーレイに 表示されるコンポーネント タイプ。" + "text": "Component Type to show in overlay" } }, "settings": { "comment": { - "text": "位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。" + "text": "Display settings for the overlay, such as positioning and scroll/close behavior." } }, "moduleRef": { "comment": { "text": [ - "コンポーネントのファクトリを解決できる Injector および ComponentFactoryResolver を含むオブジェクトへのオプションの参照。" + "Optional reference to an object containing Injector and ComponentFactoryResolver", + "that can resolve the component's factory" ] } } }, "tags": {}, - "shortText": "Id を生成します。`show(id, settings?)` メソッドを呼び出して、id を提供します。" + "shortText": "Generates Id. Provide this Id when call `show(id, settings?)` method" } }, "show": { "comment": { + "returns": "Id of the created overlay. Valid until `onClosed` is emitted.\n```typescript\nthis.overlay.show(element, settings);\n```", "parameters": { "component": { "comment": { - "text": "オーバーレイに ElementRef またはコンポーネントのタイプを表示します。" + "text": "ElementRef or Component Type to show in overlay" } }, "settings": { "comment": { - "text": "位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。" + "text": "Display settings for the overlay, such as positioning and scroll/close behavior." } } }, "tags": { "deprecated": { "comment": { - "text": "Id の取得に `attach(component)` を使用します。提供された id で `show(id, settings?)` を使用します。", - "tagName": "非推奨。" + "text": "Use `attach(component)` to obtain an Id. Then `show(id, settings?)` with provided Id.", + "tagName": "非推奨" } } }, - "shortText": "提供されたコンポーネントを表示します。" + "shortText": "Shows the provided component." } }, "hide": { "comment": { "shortText": [ - "パラメーターとして提供された ID を持つコンポーネントを非表示します。", + "Hides the component with the ID provided as a parameter.", "```typescript", "this.overlay.hide(id);", "```" @@ -144,7 +147,7 @@ "hideAll": { "comment": { "shortText": [ - "すべてのコンポーネントおよびオーバーレイを非表示します。", + "Hides all the components and the overlay.", "```typescript", "this.overlay.hideAll();", "```" @@ -154,7 +157,7 @@ "reposition": { "comment": { "shortText": [ - "パラメーターとして提供された ID を持つコンポーネントを位置変更します。", + "Repositions the component with ID provided as a parameter.", "```typescript", "this.overlay.reposition(id);", "```" @@ -164,7 +167,7 @@ "setOffset": { "comment": { "shortText": [ - "対応する軸に沿って指定した量のみコンテンツをオフセットします。", + "Offsets the content along the corresponding axis by the provided amount", "```typescript", "this.overlay.setOffset(id, deltaX, deltaY);", "```" @@ -174,4 +177,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayAnimationEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayAnimationEventArgs.json new file mode 100644 index 00000000..cc3f1515 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayAnimationEventArgs.json @@ -0,0 +1,27 @@ +{ + "OverlayAnimationEventArgs": { + "properties": { + "id": { + "comment": { + "shortText": "Id of the overlay generated with `attach()` method" + } + }, + "animationPlayer": { + "comment": { + "shortText": "Animation player that will play the animation" + } + }, + "animationType": { + "comment": { + "shortText": "Type of animation to be played. It should be either 'open' or 'close'" + } + }, + "owner": { + "comment": { + "shortText": "Provides reference to the owner component." + } + } + }, + "methods": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayCancelableEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayCancelableEventArgs.json new file mode 100644 index 00000000..f78d301b --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayCancelableEventArgs.json @@ -0,0 +1,27 @@ +{ + "OverlayCancelableEventArgs": { + "properties": { + "id": { + "comment": { + "shortText": "Id of the overlay generated with `attach()` method" + } + }, + "componentRef": { + "comment": { + "shortText": "Available when `Type` is provided to the `attach()` method and allows access to the created Component instance" + } + }, + "owner": { + "comment": { + "shortText": "Provides reference to the owner component." + } + }, + "cancel": { + "comment": { + "shortText": "Provides the ability to cancel the event." + } + } + }, + "methods": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayClosingEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayClosingEventArgs.json new file mode 100644 index 00000000..1075fe0f --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayClosingEventArgs.json @@ -0,0 +1,32 @@ +{ + "OverlayClosingEventArgs": { + "properties": { + "id": { + "comment": { + "shortText": "Id of the overlay generated with `attach()` method" + } + }, + "componentRef": { + "comment": { + "shortText": "Available when `Type` is provided to the `attach()` method and allows access to the created Component instance" + } + }, + "owner": { + "comment": { + "shortText": "Provides reference to the owner component." + } + }, + "event": { + "comment": { + "shortText": "Browser event" + } + }, + "cancel": { + "comment": { + "shortText": "Provides the ability to cancel the event." + } + } + }, + "methods": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayEventArgs.json new file mode 100644 index 00000000..3b26a9d1 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlayEventArgs.json @@ -0,0 +1,22 @@ +{ + "OverlayEventArgs": { + "properties": { + "id": { + "comment": { + "shortText": "Id of the overlay generated with `attach()` method" + } + }, + "componentRef": { + "comment": { + "shortText": "Available when `Type` is provided to the `attach()` method and allows access to the created Component instance" + } + }, + "owner": { + "comment": { + "shortText": "Provides reference to the owner component." + } + } + }, + "methods": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlaySettings.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlaySettings.json new file mode 100644 index 00000000..d1c509e8 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/OverlaySettings.json @@ -0,0 +1,32 @@ +{ + "OverlaySettings": { + "properties": { + "positionStrategy": { + "comment": { + "shortText": "Position strategy to use with this settings" + } + }, + "scrollStrategy": { + "comment": { + "shortText": "Scroll strategy to use with this settings" + } + }, + "modal": { + "comment": { + "shortText": "Set if the overlay should be in modal mode" + } + }, + "closeOnOutsideClick": { + "comment": { + "shortText": "Set if the overlay should closed on outside click" + } + }, + "outlet": { + "comment": { + "shortText": "Set the outlet container to attach the overlay to" + } + } + }, + "methods": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/services/PositionSettings.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/PositionSettings.json similarity index 50% rename from typedoc/ja/lib/services/PositionSettings.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/PositionSettings.json index ba795344..0097fa6e 100644 --- a/typedoc/ja/lib/services/PositionSettings.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/PositionSettings.json @@ -1,44 +1,44 @@ -{ +{ "PositionSettings": { "properties": { "target": { "comment": { - "shortText": "コンポーネントを表示するアタッチ ターゲット。" + "shortText": "Attaching target for the component to show" } }, "horizontalDirection": { "comment": { - "shortText": "コンポーネントを表示する方向。" + "shortText": "Direction in which the component should show" } }, "verticalDirection": { "comment": { - "shortText": "コンポーネントを表示する方向。" + "shortText": "Direction in which the component should show" } }, "horizontalStartPoint": { "comment": { - "shortText": "コンポーネントを表示する方向。" + "shortText": "Target's starting point" } }, "verticalStartPoint": { "comment": { - "shortText": "コンポーネントを表示する方向。" + "shortText": "Target's starting point" } }, "openAnimation": { "comment": { - "shortText": "オーバーレイが閉じているときに適用されるアニメーション。" + "shortText": "Animation applied while overlay opens" } }, "closeAnimation": { "comment": { - "shortText": "オーバーレイが閉じているときに適用されるアニメーション。" + "shortText": "Animation applied while overlay closes" } }, "minSize": { "comment": { - "shortText": "エラスティック ポジション ストラテジに表示されるときの要素の縮小可能なサイズ。" + "shortText": "The size up to which element may shrink when shown in elastic position strategy" } } }, diff --git a/typedoc/ja/lib/services/Size.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/Size.json similarity index 53% rename from typedoc/ja/lib/services/Size.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/Size.json index 23fe974d..7848623e 100644 --- a/typedoc/ja/lib/services/Size.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/Size.json @@ -3,12 +3,12 @@ "properties": { "width": { "comment": { - "shortText": "Size の水平コンポーネントを取得または設定します。e" + "shortText": "Gets or sets the horizontal component of Size" } }, "height": { "comment": { - "shortText": "Size の垂直コンポーネントを取得または設定します。e" + "shortText": "Gets or sets the vertical component of Size" } } }, diff --git a/typedoc/ja/lib/services/AutoPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/AutoPositionStrategy.json similarity index 100% rename from typedoc/ja/lib/services/AutoPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/AutoPositionStrategy.json diff --git a/typedoc/ja/lib/services/BaseFitPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/BaseFitPositionStrategy.json similarity index 100% rename from typedoc/ja/lib/services/BaseFitPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/BaseFitPositionStrategy.json diff --git a/typedoc/ja/lib/services/ConnectedPositioningStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ConnectedPositioningStrategy.json similarity index 100% rename from typedoc/ja/lib/services/ConnectedPositioningStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ConnectedPositioningStrategy.json diff --git a/typedoc/ja/lib/services/ContainerPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ContainerPositionStrategy.json similarity index 100% rename from typedoc/ja/lib/services/ContainerPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ContainerPositionStrategy.json diff --git a/typedoc/ja/lib/services/ElasticPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ElasticPositionStrategy.json similarity index 100% rename from typedoc/ja/lib/services/ElasticPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/ElasticPositionStrategy.json diff --git a/typedoc/ja/lib/services/GlobalPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/GlobalPositionStrategy.json similarity index 100% rename from typedoc/ja/lib/services/GlobalPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/GlobalPositionStrategy.json diff --git a/typedoc/ja/lib/services/IPositionStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/IPositionStrategy.json similarity index 99% rename from typedoc/ja/lib/services/IPositionStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/IPositionStrategy.json index ff084705..3c568c1b 100644 --- a/typedoc/ja/lib/services/IPositionStrategy.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/position/IPositionStrategy.json @@ -59,4 +59,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/services/AbsoluteScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/AbsoluteScrollStrategy.json similarity index 100% rename from typedoc/ja/lib/services/AbsoluteScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/AbsoluteScrollStrategy.json diff --git a/typedoc/ja/lib/services/BlockScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/BlockScrollStrategy.json similarity index 100% rename from typedoc/ja/lib/services/BlockScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/BlockScrollStrategy.json diff --git a/typedoc/ja/lib/services/CloseScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/CloseScrollStrategy.json similarity index 100% rename from typedoc/ja/lib/services/CloseScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/CloseScrollStrategy.json diff --git a/typedoc/ja/lib/services/IScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/IScrollStrategy.json similarity index 100% rename from typedoc/ja/lib/services/IScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/IScrollStrategy.json diff --git a/typedoc/ja/lib/services/NoOpScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/NoOpScrollStrategy.json similarity index 100% rename from typedoc/ja/lib/services/NoOpScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/NoOpScrollStrategy.json diff --git a/typedoc/ja/lib/services/ScrollStrategy.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/ScrollStrategy.json similarity index 76% rename from typedoc/ja/lib/services/ScrollStrategy.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/ScrollStrategy.json index 4c347105..e86dbd2d 100644 --- a/typedoc/ja/lib/services/ScrollStrategy.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/overlay/scroll/ScrollStrategy.json @@ -5,13 +5,13 @@ "initialize": { "comment": { "tags": {}, - "shortText": "ストラテジを初期化します。呼び出しは一度のみにします。" + "shortText": "Initializes the strategy. Should be called once" } }, "attach": { "comment": { "shortText": [ - "ストラテジを追加します。", + "Attaches the strategy", "```typescript", "settings.scrollStrategy.attach();", "```" @@ -21,7 +21,7 @@ "detach": { "comment": { "shortText": [ - "ストラテジを切り離します。", + "Detaches the strategy", "```typescript", "settings.scrollStrategy.detach();", "```" diff --git a/typedoc/ja/lib/services/IgxBaseTransactionService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json similarity index 89% rename from typedoc/ja/lib/services/IgxBaseTransactionService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json index 9db41d53..edea7a12 100644 --- a/typedoc/ja/lib/services/IgxBaseTransactionService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxBaseTransactionService.json @@ -32,13 +32,9 @@ }, "getAggregatedChanges": { "comment": { - "tags": { - "inheritdoc": { - "comment": { - "tagName": "inheritdoc" - } - } - } + "returns": "変更済みの各レコードの集計トランザクションのコレクション。\n", + "tags": {}, + "shortText": "すべてのトランザクションの集計された変更を返します。" } }, "getState": { @@ -54,6 +50,7 @@ }, "getAggregatedValue": { "comment": { + "returns": "変更のある値または **null**。\n", "tags": {}, "shortText": "すべてのコミットされていない変更を含む必要となった ID を返します。" } @@ -90,6 +87,7 @@ "canRedo": { "getter": { "comment": { + "returns": "Redo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { @@ -103,6 +101,7 @@ "canUndo": { "getter": { "comment": { + "returns": "Undo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/ja/lib/services/IgxHierarchicalTransactionService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json similarity index 92% rename from typedoc/ja/lib/services/IgxHierarchicalTransactionService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json index 495cf257..edfa7be4 100644 --- a/typedoc/ja/lib/services/IgxHierarchicalTransactionService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxHierarchicalTransactionService.json @@ -59,18 +59,21 @@ }, "getTransactionLog": { "comment": { + "returns": "サービスのすべてのトランザクションまたは指定したレコード。\n", "tags": {}, "shortText": "登録されたすべてのレコードを時系列順に返します。" } }, "getState": { "comment": { + "returns": "レコードがある場合のその状態。\n", "tags": {}, "shortText": "指定された ID のレコードの状態を返します。" } }, "getAggregatedValue": { "comment": { + "returns": "変更のある値または **null**。\n", "tags": {}, "shortText": "すべてのコミットされていない変更を含む必要となった ID を返します。" } @@ -111,6 +114,7 @@ "canUndo": { "getter": { "comment": { + "returns": "Undo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { @@ -124,6 +128,7 @@ "canRedo": { "getter": { "comment": { + "returns": "Redo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/ja/lib/services/IgxTransactionService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json similarity index 88% rename from typedoc/ja/lib/services/IgxTransactionService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json index e30822cd..c1e1dadf 100644 --- a/typedoc/ja/lib/services/IgxTransactionService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/IgxTransactionService.json @@ -16,24 +16,28 @@ }, "getTransactionLog": { "comment": { + "returns": "サービスのすべてのトランザクションまたは指定したレコード。\n", "tags": {}, "shortText": "登録されたすべてのレコードを時系列順に返します。" } }, "getAggregatedChanges": { "comment": { + "returns": "変更済みの各レコードの集計トランザクションのコレクション。\n", "tags": {}, "shortText": "すべてのトランザクションの集計された変更を返します。" } }, "getState": { "comment": { + "returns": "レコードがある場合のその状態。\n", "tags": {}, "shortText": "指定された ID のレコードの状態を返します。" } }, "getAggregatedValue": { "comment": { + "returns": "変更のある値または **null**。\n", "tags": {}, "shortText": "すべてのコミットされていない変更を含む必要となった ID を返します。" } @@ -80,6 +84,7 @@ "canUndo": { "getter": { "comment": { + "returns": "Undo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { @@ -93,6 +98,7 @@ "canRedo": { "getter": { "comment": { + "returns": "Redo スタックにトランザクションがあるかどうか。\n", "tags": { "inheritdoc": { "comment": { diff --git a/typedoc/ja/lib/services/TransactionService.json b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json similarity index 95% rename from typedoc/ja/lib/services/TransactionService.json rename to typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json index 6b53c42d..ec3d1a17 100644 --- a/typedoc/ja/lib/services/TransactionService.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/services/transaction/TransactionService.json @@ -57,6 +57,7 @@ }, "getTransactionLog": { "comment": { + "returns": "サービスのすべてのトランザクションまたは指定したレコード。\n", "parameters": { "id": { "comment": { @@ -80,6 +81,7 @@ }, "getAggregatedChanges": { "comment": { + "returns": "変更済みの各レコードの集計トランザクションのコレクション。\n", "parameters": { "mergeChanges": { "comment": { @@ -95,6 +97,7 @@ }, "getState": { "comment": { + "returns": "レコードがある場合のその状態。\n", "parameters": { "id": { "comment": { @@ -113,6 +116,7 @@ }, "getAggregatedValue": { "comment": { + "returns": "変更のある値または **null**。\n", "parameters": { "id": { "comment": { diff --git a/typedoc/ja/lib/slider/IgxSliderComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderComponent.json similarity index 99% rename from typedoc/ja/lib/slider/IgxSliderComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderComponent.json index 7810bb00..4ac62654 100644 --- a/typedoc/ja/lib/slider/IgxSliderComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderComponent.json @@ -588,4 +588,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/slider/IgxSliderType.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderType.json similarity index 99% rename from typedoc/ja/lib/slider/IgxSliderType.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderType.json index 2957327f..4fd60852 100644 --- a/typedoc/ja/lib/slider/IgxSliderType.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxSliderType.json @@ -13,4 +13,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/slider/IgxThumbFromTemplateDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxThumbFromTemplateDirective.json similarity index 100% rename from typedoc/ja/lib/slider/IgxThumbFromTemplateDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxThumbFromTemplateDirective.json diff --git a/typedoc/ja/lib/slider/IgxThumbToTemplateDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxThumbToTemplateDirective.json similarity index 100% rename from typedoc/ja/lib/slider/IgxThumbToTemplateDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxThumbToTemplateDirective.json diff --git a/typedoc/ja/lib/slider/IgxTickLabelTemplateDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxTickLabelTemplateDirective.json similarity index 100% rename from typedoc/ja/lib/slider/IgxTickLabelTemplateDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/IgxTickLabelTemplateDirective.json diff --git a/typedoc/ja/lib/slider/TickLabelsOrientation.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/TickLabelsOrientation.json similarity index 100% rename from typedoc/ja/lib/slider/TickLabelsOrientation.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/TickLabelsOrientation.json diff --git a/typedoc/ja/lib/slider/TicksOrientation.json b/typedoc/ja/projects/igniteui-angular/src/lib/slider/TicksOrientation.json similarity index 100% rename from typedoc/ja/lib/slider/TicksOrientation.json rename to typedoc/ja/projects/igniteui-angular/src/lib/slider/TicksOrientation.json diff --git a/typedoc/ja/lib/snackbar/IgxSnackbarComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/snackbar/IgxSnackbarComponent.json similarity index 99% rename from typedoc/ja/lib/snackbar/IgxSnackbarComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/snackbar/IgxSnackbarComponent.json index e4b23492..9bfdf5e7 100644 --- a/typedoc/ja/lib/snackbar/IgxSnackbarComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/snackbar/IgxSnackbarComponent.json @@ -3,7 +3,6 @@ "comment": { "text": [ "Ignite UI Snack Bar コンポーネントは一行のメッセージで操作のフィードバックを提供します。元に戻すなどの操作へのリンクを追加できます。", - "", "例:", "```html", "", @@ -164,4 +163,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/switch/IChangeSwitchEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/switch/IChangeSwitchEventArgs.json similarity index 100% rename from typedoc/ja/lib/switch/IChangeSwitchEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/switch/IChangeSwitchEventArgs.json diff --git a/typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json new file mode 100644 index 00000000..50b10c43 --- /dev/null +++ b/typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchComponent.json @@ -0,0 +1,397 @@ +{ + "IgxSwitchComponent": { + "comment": { + "tags": { + "igxmodule": { + "comment": { + "text": "IgxSwitchModule", + "tagName": "igxmodule" + } + }, + "igxtheme": { + "comment": { + "text": "igx-switch-theme, igx-tooltip-theme", + "tagName": "igxtheme" + } + }, + "igxkeywords": { + "comment": { + "text": "switch, states, tooltip", + "tagName": "igxkeywords" + } + }, + "igxgroup": { + "comment": { + "text": "データ入力と表示", + "tagName": "igxgroup" + } + }, + "remarks": { + "comment": { + "text": "Ignite UI Switch はオン/オフまたは true/false 状態の間に切り替えます。", + "tagName": "備考" + } + }, + "example": { + "comment": { + "text": [ + "```html", + "", + " Simple switch", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Switch コンポーネントは、バイナリ選択の選択コンポーネントです。" + }, + "properties": { + "nativeCheckbox": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let checkboxElement = this.switch.nativeCheckbox;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ チェックボックス要素への参照を返します。" + } + }, + "nativeLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let labelElement = this.switch.nativeLabel;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ネイティブ ラベル要素への参照を返します。" + } + }, + "placeholderLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let labelPlaceholder = this.switch.placeholderLabel;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "ラベル プレースホルダー要素への参照を返します。" + } + }, + "id": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Switch コンポーネントの `id` を設定または取得します。", + "設定されない場合、最初の switch コンポーネントの `id` は `\"igx-switch-0\"` になります。" + ] + } + }, + "labelId": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Switch コンポーネントで `label` 要素の id を設定または取得します。", + "設定されない場合、最初の switch コンポーネントのラベルの値は `\"igx-switch-0-label\"` になります。" + ] + } + }, + "value": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Switch コンポーネントの `value` 属性を設定または取得します。" + } + }, + "name": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Switch コンポーネントの `name` 属性を設定または取得します。" + } + }, + "tabindex": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`tabindex` 属性の値を取得または設定します。" + } + }, + "labelPosition": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Switch コンポーネントで `label` の位置を設定または取得します。", + "設定されない場合、`labelPosition` の値は `\"after\"` です。" + ] + } + }, + "disableRipple": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "リップル エフェクトを有効または無効にします。", + "設定されない場合、`disableRipple` の値は `false` です。" + ] + } + }, + "required": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "switch が必須かどうかを設定または取得します。", + "設定されない場合、`required` の値は `false` です。" + ] + } + }, + "ariaLabelledBy": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`aria-labelledby` 属性を設定または取得します。", + "設定されない場合、`aria-labelledBy` の値は `labelId` 属性の値と等しくなります。" + ] + } + }, + "ariaLabel": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "`aria-label` 属性の値を取得または設定します。" + } + }, + "change": { + "comment": { + "shortText": [ + "Switch 状態が変更された後に発生するイベント。", + "イベント引数として `IgxSwitchComponent` および `checked` プロパティへの参照を提供します。" + ] + } + }, + "cssClass": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "let switchClass = this.switch.cssClass;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "Switch コンポーネントのクラスを返します。" + } + }, + "checked": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + " ", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Switch がオンまたはオフかどうかを取得または設定します。", + "デフォルトは 'false' です。" + ] + } + }, + "disabled": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```html", + "", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "`disabled` 属性を設定または取得します。", + "デフォルトは 'false' です。" + ] + } + }, + "focused": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.switch.focused = true;", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": [ + "Switch コンポーネントがフォーカスされるかどうかを取得または設定します。", + "デフォルト値は `false` です。" + ] + } + } + }, + "methods": { + "toggle": { + "comment": { + "tags": { + "example": { + "comment": { + "text": [ + "```typescript", + "this.switch.toggle();", + "```" + ], + "tagName": "例" + } + } + }, + "shortText": "スイッチのチェックされた状態を切り替えます。" + } + } + }, + "accessors": {} + } +} \ No newline at end of file diff --git a/typedoc/ja/lib/switch/IgxSwitchRequiredDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json similarity index 74% rename from typedoc/ja/lib/switch/IgxSwitchRequiredDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json index bf12ca19..89495f26 100644 --- a/typedoc/ja/lib/switch/IgxSwitchRequiredDirective.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/switch/IgxSwitchRequiredDirective.json @@ -1,19 +1,6 @@ { "IgxSwitchRequiredDirective": { - "properties": { - "required": { - "comment": { - "tags": { - "description": { - "comment": { - "text": "このディレクティブにバインドされている必須属性への変更を追跡します。", - "tagName": "説明" - } - } - } - } - } - }, + "properties": {}, "methods": { "validate": { "comment": { @@ -50,6 +37,24 @@ } } }, - "accessors": {} + "accessors": { + "required": { + "getter": { + "comment": { + "tags": { + "description": { + "comment": { + "text": "このディレクティブにバインドされている必須属性への変更を追跡します。", + "tagName": "説明" + } + } + } + } + }, + "setter": { + "comment": {} + } + } + } } } \ No newline at end of file diff --git a/typedoc/ja/lib/tabbar/ISelectTabEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/ISelectTabEventArgs.json similarity index 100% rename from typedoc/ja/lib/tabbar/ISelectTabEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabbar/ISelectTabEventArgs.json diff --git a/typedoc/ja/lib/tabbar/IgxBottomNavComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxBottomNavComponent.json similarity index 99% rename from typedoc/ja/lib/tabbar/IgxBottomNavComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxBottomNavComponent.json index 599ead27..241a9804 100644 --- a/typedoc/ja/lib/tabbar/IgxBottomNavComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxBottomNavComponent.json @@ -216,4 +216,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/tabbar/IgxTabComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabComponent.json similarity index 99% rename from typedoc/ja/lib/tabbar/IgxTabComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabComponent.json index 70671601..8c4b516a 100644 --- a/typedoc/ja/lib/tabbar/IgxTabComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabComponent.json @@ -262,4 +262,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/tabbar/IgxTabPanelComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabPanelComponent.json similarity index 95% rename from typedoc/ja/lib/tabbar/IgxTabPanelComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabPanelComponent.json index 258e72a6..9519a345 100644 --- a/typedoc/ja/lib/tabbar/IgxTabPanelComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabbar/IgxTabPanelComponent.json @@ -82,30 +82,9 @@ ] } } - }, - "methods": { - "select": { - "comment": { - "tags": { - "memberof": { - "comment": { - "text": "IgxTabPanelComponent", - "tagName": "次のメンバー:" - } - } - }, - "shortText": [ - "現在のタブおよびタブ パネルを選択します。", - "```typescript", - "this.tabPanel.select();", - "```" - ] - } - } - }, - "accessors": { - "styleClass": { - "getter": { + }, + "methods": { + "select": { "comment": { "tags": { "memberof": { @@ -116,15 +95,36 @@ } }, "shortText": [ - "タブ パネルに `igx-bottom-nav__panel` クラスがあるかどうかを取得します。", + "現在のタブおよびタブ パネルを選択します。", "```typescript", - "let styleClass = this.tabPanel.styleClass;", + "this.tabPanel.select();", "```" ] } } }, - "isSelected": { + "accessors": { + "styleClass": { + "getter": { + "comment": { + "tags": { + "memberof": { + "comment": { + "text": "IgxTabPanelComponent", + "tagName": "次のメンバー:" + } + } + }, + "shortText": [ + "タブ パネルに `igx-bottom-nav__panel` クラスがあるかどうかを取得します。", + "```typescript", + "let styleClass = this.tabPanel.styleClass;", + "```" + ] + } + } + }, + "isSelected": { "getter": { "comment": { "tags": { @@ -275,4 +275,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/tabs/IgxTabItemComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabItemComponent.json similarity index 99% rename from typedoc/ja/lib/tabs/IgxTabItemComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabItemComponent.json index 97e28aa8..018e7c7e 100644 --- a/typedoc/ja/lib/tabs/IgxTabItemComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabItemComponent.json @@ -106,4 +106,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/tabs/IgxTabsComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsComponent.json similarity index 99% rename from typedoc/ja/lib/tabs/IgxTabsComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsComponent.json index 34dfedc3..70c5db47 100644 --- a/typedoc/ja/lib/tabs/IgxTabsComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsComponent.json @@ -148,4 +148,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/tabs/IgxTabsGroupComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsGroupComponent.json similarity index 94% rename from typedoc/ja/lib/tabs/IgxTabsGroupComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsGroupComponent.json index 47a1d43f..743b6231 100644 --- a/typedoc/ja/lib/tabs/IgxTabsGroupComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/tabs/IgxTabsGroupComponent.json @@ -36,13 +36,6 @@ "methods": { "select": { "comment": { - "parameters": { - "focusDelay": { - "comment": { - "text": "予期される遅延を表す数字。" - } - } - }, "tags": { "memberof": { "comment": { @@ -61,7 +54,6 @@ } }, "shortText": "タブにフォーカスを設定するメソッド。" - } } }, @@ -136,4 +128,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/time-picker/IgxTimePickerActionsDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerActionsDirective.json similarity index 100% rename from typedoc/ja/lib/time-picker/IgxTimePickerActionsDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerActionsDirective.json diff --git a/typedoc/ja/lib/time-picker/IgxTimePickerComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerComponent.json similarity index 98% rename from typedoc/ja/lib/time-picker/IgxTimePickerComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerComponent.json index a18ead3e..1a5ab172 100644 --- a/typedoc/ja/lib/time-picker/IgxTimePickerComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerComponent.json @@ -20,7 +20,7 @@ "```" ] } - }, + }, "minValue": { "comment": { "shortText": [ @@ -172,9 +172,7 @@ }, "onClosing": { "comment": { - "shortText": [ - "timePicker が閉じているときに発生します。" - ] + "shortText": "timePicker が閉じているときに発生します。" } } }, @@ -290,7 +288,7 @@ "午前午後の項目を表示可能領域にスクロールします。", "```typescript", "scrAmPmIntoView(picker) {", - "picker.scrollAmPmIntoView('PM');", + "picker.scrollAmPmIntoView('PM');", "}", "```", "```html", @@ -685,12 +683,10 @@ } } }, - "shortText": [ - "入力グループのテンプレートに渡されたコンテキストを取得します。" - ] + "shortText": "入力グループのテンプレートに渡されたコンテキストを取得します。" } } } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/time-picker/IgxTimePickerTemplateDirective.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerTemplateDirective.json similarity index 100% rename from typedoc/ja/lib/time-picker/IgxTimePickerTemplateDirective.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerTemplateDirective.json diff --git a/typedoc/ja/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json similarity index 100% rename from typedoc/ja/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValidationFailedEventArgs.json diff --git a/typedoc/ja/lib/time-picker/IgxTimePickerValueChangedEventArgs.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValueChangedEventArgs.json similarity index 100% rename from typedoc/ja/lib/time-picker/IgxTimePickerValueChangedEventArgs.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/IgxTimePickerValueChangedEventArgs.json diff --git a/typedoc/ja/lib/time-picker/TimeDisplayFormatPipe.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimeDisplayFormatPipe.json similarity index 100% rename from typedoc/ja/lib/time-picker/TimeDisplayFormatPipe.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimeDisplayFormatPipe.json diff --git a/typedoc/ja/lib/time-picker/TimeInputFormatPipe.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimeInputFormatPipe.json similarity index 100% rename from typedoc/ja/lib/time-picker/TimeInputFormatPipe.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimeInputFormatPipe.json diff --git a/typedoc/ja/lib/time-picker/TimePickerHammerConfig.json b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json similarity index 94% rename from typedoc/ja/lib/time-picker/TimePickerHammerConfig.json rename to typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json index f6502bb8..9f994d5c 100644 --- a/typedoc/ja/lib/time-picker/TimePickerHammerConfig.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/time-picker/TimePickerHammerConfig.json @@ -22,6 +22,7 @@ "methods": { "buildHammer": { "comment": { + "returns": "HammerJS イベント マネージャー オブジェクト。\n", "parameters": { "element": { "comment": { @@ -38,4 +39,4 @@ }, "accessors": {} } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/toast/IgxToastComponent.json b/typedoc/ja/projects/igniteui-angular/src/lib/toast/IgxToastComponent.json similarity index 99% rename from typedoc/ja/lib/toast/IgxToastComponent.json rename to typedoc/ja/projects/igniteui-angular/src/lib/toast/IgxToastComponent.json index e2cddb6d..94fc2958 100644 --- a/typedoc/ja/lib/toast/IgxToastComponent.json +++ b/typedoc/ja/projects/igniteui-angular/src/lib/toast/IgxToastComponent.json @@ -367,4 +367,4 @@ } } } -} +} \ No newline at end of file diff --git a/typedoc/ja/lib/toast/IgxToastPosition.json b/typedoc/ja/projects/igniteui-angular/src/lib/toast/IgxToastPosition.json similarity index 100% rename from typedoc/ja/lib/toast/IgxToastPosition.json rename to typedoc/ja/projects/igniteui-angular/src/lib/toast/IgxToastPosition.json