# snk-detail-view



<!-- Auto Generated Below -->


## Properties

| Property                   | Attribute                     | Description                                                               | Type                                                                                        | Default                      |
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- |
| `branchGuide`              | --                            |                                                                           | `IGuideItem`                                                                                | `undefined`                  |
| `canEdit`                  | `can-edit`                    | Define se a edição está habilitada na grid.                               | `boolean`                                                                                   | `true`                       |
| `customEditors`            | --                            | Registra um editor customizado para campos da grade e formulário.         | `PropsCustomEditor`                                                                         | `undefined`                  |
| `customRenders`            | --                            | Render customizados da grade.                                             | `PropsCustomRender`                                                                         | `undefined`                  |
| `dataState`                | --                            | Representa o estado do dataUnit detail.                                   | `DataState`                                                                                 | `undefined`                  |
| `dataUnit`                 | --                            | Instância do DataUnit detail.                                             | `DataUnit`                                                                                  | `undefined`                  |
| `dataUnitName`             | `data-unit-name`              | Determina todo o caminho desde o pai até chegar neste nível               | `string`                                                                                    | `undefined`                  |
| `entityName`               | `entity-name`                 | Nome da entidade detail.                                                  | `string`                                                                                    | `undefined`                  |
| `formConfigManager`        | --                            | Gerenciador de configuração do formulário.                                | `SnkFormConfigManager`                                                                      | `undefined`                  |
| `guideItemPath`            | --                            | Caminho do identificador da guia vinculada.                               | `IGuideItem[]`                                                                              | `undefined`                  |
| `label`                    | `label`                       | Descrição amigável do cadastro detalhe.                                   | `string`                                                                                    | `undefined`                  |
| `messagesBuilder`          | --                            |                                                                           | `SnkMessageBuilder`                                                                         | `undefined`                  |
| `presentationMode`         | `presentation-mode`           | Altera o modo de apresentação dos botões do snk-taskbar.                  | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.SECONDARY` |
| `resourceID`               | `resource-i-d`                | Identificador de recursos como configurações e acesso.                    | `string`                                                                                    | `undefined`                  |
| `selectedForm`             | `selected-form`               | Representa o formulário selecionado.                                      | `string`                                                                                    | `undefined`                  |
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string`                                                                                    | `undefined`                  |


## Events

| Event                   | Description                                                                     | Type                         |
| ----------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
| `formItemsReady`        | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
| `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias.                | `CustomEvent<GuideBuilder>`  |
| `snkSwitchGuide`        | Emitido quando há necessidade de comutar entre grid e form.                     | `CustomEvent<string>`        |


## Methods

### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`

Registra um editor customizado para campos da grade e formulário.

#### Returns

Type: `Promise<void>`

---

### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`

Registra um render customizado para colunas da grid.

#### Returns

Type: `Promise<void>`

---

### `changeViewMode(mode: VIEW_MODE) => Promise<void>`

Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM

#### Returns

Type: `Promise<void>`

---

### `configGrid() => Promise<void>`

Abre o configurador de grid.

#### Returns

Type: `Promise<void>`

---

### `showUp() => Promise<void>`



#### Returns

Type: `Promise<void>`




## Dependencies

### Used by

 - [snk-guides-viewer](..)

### Depends on

- [snk-data-unit](../../../snk-data-unit)
- [snk-grid](../../../snk-grid)
- [snk-form-view](..)
- [snk-taskbar](../../../snk-taskbar)
- [snk-attach](../../../snk-attach)
- [snk-data-exporter](../../../snk-data-exporter)
- [snk-actions-button](../../../snk-actions-button)
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)

### Graph
```mermaid
graph TD;
  snk-detail-view --> snk-data-unit
  snk-detail-view --> snk-grid
  snk-detail-view --> snk-form-view
  snk-detail-view --> snk-taskbar
  snk-detail-view --> snk-attach
  snk-detail-view --> snk-data-exporter
  snk-detail-view --> snk-actions-button
  snk-detail-view --> taskbar-split-button
  snk-detail-view --> taskbar-actions-button
  snk-grid --> snk-filter-bar
  snk-grid --> snk-taskbar
  snk-grid --> snk-grid-config
  snk-grid --> snk-data-exporter
  snk-grid --> snk-actions-button
  snk-grid --> taskbar-split-button
  snk-grid --> taskbar-actions-button
  snk-filter-bar --> snk-filter-item
  snk-filter-bar --> snk-personalized-filter
  snk-filter-bar --> snk-filter-modal
  snk-filter-item --> snk-filter-detail
  snk-personalized-filter --> snk-filter-field-search
  snk-personalized-filter --> snk-filter-assistent-mode
  snk-personalized-filter --> snk-filter-advanced-mode
  snk-personalized-filter --> snk-simple-bar
  snk-filter-assistent-mode --> snk-expression-group
  snk-expression-group --> snk-expression-item
  snk-expression-group --> snk-expression-group
  snk-expression-item --> snk-filter-field-search
  snk-expression-item --> snk-filter-param-config
  snk-filter-modal --> snk-filter-modal-item
  snk-filter-modal --> snk-default-filter
  snk-taskbar --> snk-data-exporter
  snk-taskbar --> snk-actions-button
  snk-taskbar --> taskbar-split-button
  snk-taskbar --> taskbar-actions-button
  snk-data-exporter --> snk-exporter-email-sender
  snk-grid-config --> snk-select-box
  snk-form-view --> snk-form-summary
  snk-attach --> snk-simple-bar
  snk-attach --> snk-simple-crud
  snk-simple-crud --> snk-taskbar
  snk-simple-crud --> snk-data-unit
  snk-simple-crud --> snk-simple-form-config
  snk-simple-crud --> snk-configurator
  snk-simple-crud --> snk-grid-config
  snk-simple-crud --> snk-data-exporter
  snk-simple-crud --> snk-actions-button
  snk-simple-crud --> taskbar-split-button
  snk-simple-crud --> taskbar-actions-button
  snk-configurator --> snk-layout-form-config
  snk-layout-form-config --> snk-view-representation
  snk-guides-viewer --> snk-detail-view
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------


