型・APIリファレンス
    Preparing search index...

    Function useSavedListDialogState

    • 保存リストダイアログStateのシングルトンインスタンスを返す。

      Returns {
          aggregationSavedListInfo: ComputedRef<
              | null
              | {
                  description?: string;
                  folderDisplayName?: string;
                  folderId?: string;
                  id: string;
                  name: string;
                  ownData: boolean;
                  owner?: string;
                  shared: boolean;
                  snapshot: boolean;
                  updateDate: number;
              },
          >;
          beginEdit: () => void;
          buildSearchParam: (
              overrides?: {
                  limit?: number;
                  offset?: number;
                  sortKey?: number;
                  sortType?: "ASC" | "DESC";
              },
          ) => null
          | SavedSearchParams;
          cancelEdit: () => void;
          canEdit: ComputedRef<boolean>;
          canFileDownload: ComputedRef<boolean>;
          close: () => void;
          executeSearch: (
              overrides?: {
                  limit?: number;
                  offset?: number;
                  sortKey?: number;
                  sortType?: "ASC" | "DESC";
              },
          ) => Promise<void>;
          isAggregation: ComputedRef<boolean>;
          isFilterReadonly: ComputedRef<boolean>;
          isSnapshot: ComputedRef<boolean>;
          loadAggregationSavedList: (listedId: string) => Promise<void>;
          loadConfig: () => Promise<void>;
          loadEntityListingSavedList: (listedId: string) => Promise<void>;
          loadSavedList: (listedId: string, dataType: string) => Promise<void>;
          open: (listedId: string, dataType?: string) => Promise<void>;
          openWithData: (
              listedId: string,
              options: {
                  data: SavedSearchLoadData | AggregationSavedListLoadData;
                  dataType: string;
              },
          ) => Promise<void>;
          savedListConfig: Ref<
              | null
              | {
                  canCreateFolder: boolean;
                  canDeleteFolder: boolean;
                  canDeleteOtherSavedList: boolean;
                  canDirectFileDownload: boolean;
                  canFileDownload: boolean;
                  canUpdate: boolean;
                  csvDownloadCharacterCode: string[];
                  hasCreateFolderPermission: boolean;
                  hasDeleteFolderPermission: boolean;
                  hasDeleteItemPermission: boolean;
                  linkActionMode: string;
              },
              | null
              | SavedListConfig
              | {
                  canCreateFolder: boolean;
                  canDeleteFolder: boolean;
                  canDeleteOtherSavedList: boolean;
                  canDirectFileDownload: boolean;
                  canFileDownload: boolean;
                  canUpdate: boolean;
                  csvDownloadCharacterCode: string[];
                  hasCreateFolderPermission: boolean;
                  hasDeleteFolderPermission: boolean;
                  hasDeleteItemPermission: boolean;
                  linkActionMode: string;
              },
          >;
          savedListInfo: ComputedRef<null | SavedSearchInfo>;
          state: Ref<
              {
                  aggregationData: | null
                  | {
                      canDefinitionCsvDownload: boolean;
                      cols: string[];
                      colSize: number;
                      data: unknown[][];
                      dataType: string;
                      definitionName?: string;
                      filterValueList?: {
                          displayLabel: string;
                          filterDisplayValue?: string;
                          from?: string;
                          inDisplayValues?: { label: ...; value: ... }[];
                          inList?: string[];
                          operatorName: string;
                          savedListColLabel?: string;
                          savedListName?: string;
                          to?: string;
                      }[];
                      rowSize: number;
                      savedListInfo: {
                          description?: string;
                          folderDisplayName?: string;
                          folderId?: string;
                          id: string;
                          name: string;
                          ownData: boolean;
                          owner?: string;
                          shared: boolean;
                          snapshot: boolean;
                          updateDate: number;
                      };
                  };
                  dataType: null
                  | string;
                  errorMessage: null | string;
                  isEditMode: boolean;
                  isOpen: boolean;
                  listedId: null | string;
                  loading: boolean;
                  savedListData:
                      | null
                      | {
                          canFileDownload?: boolean;
                          condition?: {
                              customFilterExpression?: string;
                              customResultFilterExpression?: string;
                              definitionName?: string;
                              distinct?: boolean;
                              entityName?: string;
                              filterValues?: {
                                  compareAsString?: (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  from?: unknown;
                                  in?: (...) | (...);
                                  operator?: (...) | (...);
                                  propertyName?: (...) | (...);
                                  relativeRangeName?: (...) | (...);
                                  savedList?: (...) | (...);
                                  selectColNum?: (...) | (...);
                                  to?: unknown;
                              }[];
                              resultFilterValues?: {
                                  compareAsString?: (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  from?: unknown;
                                  in?: (...) | (...);
                                  operator?: (...) | (...);
                                  propertyName?: (...) | (...);
                                  relativeRangeName?: (...) | (...);
                                  savedList?: (...) | (...);
                                  selectColNum?: (...) | (...);
                                  to?: unknown;
                              }[];
                              selectValues?: {
                                  aggregateType?: (...)
                                  | (...);
                                  displayName?: (...) | (...);
                                  dispStyle?: (...) | (...);
                                  propertyDisplayName?: (...) | (...);
                                  propertyName?: (...) | (...);
                              }[];
                              sortValues?: {
                                  sortColNum?: (...)
                                  | (...);
                                  sortType?: (...) | (...) | (...);
                              }[];
                          };
                          definitionName?: string;
                          deletable?: boolean;
                          editable?: boolean;
                          editorMap?: Record<string, Record<string, unknown>>;
                          entityName?: string;
                          fileSupportType?: string;
                          filterOperators?: string[];
                          filterValueItems?: Record<string, unknown>[];
                          referenceViewable?: boolean;
                          relativeRanges?: { displayLabel: string; name: string }[];
                          remainInlineText?: boolean;
                          resultFilterValueItems?: Record<string, unknown>[];
                          savedSearchInfo: {
                              canEdit?: boolean;
                              canFileDownload?: boolean;
                              canOthersEdit?: boolean;
                              canReference?: boolean;
                              canSavedFilterEdit?: boolean;
                              dataTypeDisplayName?: string;
                              description?: string;
                              entityDisplayName?: string;
                              folderDisplayName?: string;
                              folderId?: string;
                              id?: string;
                              initSearch?: boolean;
                              name?: string;
                              ownData?: boolean;
                              owner?: string;
                              shared?: boolean;
                              snapshot?: boolean;
                              sortColNum?: number;
                              sortType?: "ASC" | "DESC";
                              updateDate?: number;
                          };
                          selectValueItems?: Record<string, unknown>[];
                          showReferenceByName?: boolean;
                          snapshot?: boolean;
                          sortable?: boolean;
                          userViewName?: string;
                      };
                  searchLoading: boolean;
                  searchResult: | null
                  | {
                      data: Record<string, CellValue>[];
                      error?: string;
                      hasNext: boolean;
                      totalCount: number;
                  };
              },
              | SavedListDialogState
              | {
                  aggregationData: | null
                  | {
                      canDefinitionCsvDownload: boolean;
                      cols: string[];
                      colSize: number;
                      data: unknown[][];
                      dataType: string;
                      definitionName?: string;
                      filterValueList?: {
                          displayLabel: string;
                          filterDisplayValue?: string;
                          from?: string;
                          inDisplayValues?: (...)[];
                          inList?: (...)[];
                          operatorName: string;
                          savedListColLabel?: string;
                          savedListName?: string;
                          to?: string;
                      }[];
                      rowSize: number;
                      savedListInfo: {
                          description?: string;
                          folderDisplayName?: string;
                          folderId?: string;
                          id: string;
                          name: string;
                          ownData: boolean;
                          owner?: string;
                          shared: boolean;
                          snapshot: boolean;
                          updateDate: number;
                      };
                  };
                  dataType: null
                  | string;
                  errorMessage: null | string;
                  isEditMode: boolean;
                  isOpen: boolean;
                  listedId: null | string;
                  loading: boolean;
                  savedListData:
                      | null
                      | {
                          canFileDownload?: boolean;
                          condition?: {
                              customFilterExpression?: string;
                              customResultFilterExpression?: string;
                              definitionName?: string;
                              distinct?: boolean;
                              entityName?: string;
                              filterValues?: {
                                  compareAsString?: ...;
                                  from?: ...;
                                  in?: ...;
                                  operator?: ...;
                                  propertyName?: ...;
                                  relativeRangeName?: ...;
                                  savedList?: ...;
                                  selectColNum?: ...;
                                  to?: ...;
                              }[];
                              resultFilterValues?: {
                                  compareAsString?: ...;
                                  from?: ...;
                                  in?: ...;
                                  operator?: ...;
                                  propertyName?: ...;
                                  relativeRangeName?: ...;
                                  savedList?: ...;
                                  selectColNum?: ...;
                                  to?: ...;
                              }[];
                              selectValues?: {
                                  aggregateType?: ...;
                                  displayName?: ...;
                                  dispStyle?: ...;
                                  propertyDisplayName?: ...;
                                  propertyName?: ...;
                              }[];
                              sortValues?: { sortColNum?: ...; sortType?: ... }[];
                          };
                          definitionName?: string;
                          deletable?: boolean;
                          editable?: boolean;
                          editorMap?: Record<string, Record<string, unknown>>;
                          entityName?: string;
                          fileSupportType?: string;
                          filterOperators?: string[];
                          filterValueItems?: Record<string, unknown>[];
                          referenceViewable?: boolean;
                          relativeRanges?: { displayLabel: string; name: string }[];
                          remainInlineText?: boolean;
                          resultFilterValueItems?: Record<string, unknown>[];
                          savedSearchInfo: {
                              canEdit?: boolean;
                              canFileDownload?: boolean;
                              canOthersEdit?: boolean;
                              canReference?: boolean;
                              canSavedFilterEdit?: boolean;
                              dataTypeDisplayName?: string;
                              description?: string;
                              entityDisplayName?: string;
                              folderDisplayName?: string;
                              folderId?: string;
                              id?: string;
                              initSearch?: boolean;
                              name?: string;
                              ownData?: boolean;
                              owner?: string;
                              shared?: boolean;
                              snapshot?: boolean;
                              sortColNum?: number;
                              sortType?: "ASC" | "DESC";
                              updateDate?: number;
                          };
                          selectValueItems?: Record<string, unknown>[];
                          showReferenceByName?: boolean;
                          snapshot?: boolean;
                          sortable?: boolean;
                          userViewName?: string;
                      };
                  searchLoading: boolean;
                  searchResult: | null
                  | {
                      data: Record<string, CellValue>[];
                      error?: string;
                      hasNext: boolean;
                      totalCount: number;
                  };
              },
          >;
      }

      • aggregationSavedListInfo: ComputedRef<
            | null
            | {
                description?: string;
                folderDisplayName?: string;
                folderId?: string;
                id: string;
                name: string;
                ownData: boolean;
                owner?: string;
                shared: boolean;
                snapshot: boolean;
                updateDate: number;
            },
        >

        保存リスト基本情報(Aggregation)

      • beginEdit: () => void

        編集モードを開始します。

      • buildSearchParam: (
            overrides?: {
                limit?: number;
                offset?: number;
                sortKey?: number;
                sortType?: "ASC" | "DESC";
            },
        ) => null
        | SavedSearchParams

        検索パラメータを構築する。

      • cancelEdit: () => void

        編集モードを終了します。

      • canEdit: ComputedRef<boolean>

        編集権限あり(スナップショットの場合は常にfalse)

      • canFileDownload: ComputedRef<boolean>

        ファイルダウンロード権限あり(configのcanFileDownload=falseの場合は常にfalse)

      • close: () => void

        ダイアログを閉じます。

      • executeSearch: (
            overrides?: {
                limit?: number;
                offset?: number;
                sortKey?: number;
                sortType?: "ASC" | "DESC";
            },
        ) => Promise<void>

        保存リスト保存の検索条件で検索を実行します(EntityListingのみ)。

      • isAggregation: ComputedRef<boolean>

        Aggregation 種別か

      • isFilterReadonly: ComputedRef<boolean>

        フィルタ条件が読み取り専用か(スナップショット または canSavedFilterEdit=false)

      • isSnapshot: ComputedRef<boolean>

        スナップショットか

      • loadAggregationSavedList: (listedId: string) => Promise<void>

        Aggregation保存リストの詳細情報を読み込みます。

      • loadConfig: () => Promise<void>

        保存リスト設定情報をロードします。

      • loadEntityListingSavedList: (listedId: string) => Promise<void>

        保存リストの詳細情報を読み込みます(EntityListing)。

      • loadSavedList: (listedId: string, dataType: string) => Promise<void>

        保存リストの詳細情報を読み込みます。

      • open: (listedId: string, dataType?: string) => Promise<void>

        ダイアログを開く(事前データなし)。

      • openWithData: (
            listedId: string,
            options: {
                data: SavedSearchLoadData | AggregationSavedListLoadData;
                dataType: string;
            },
        ) => Promise<void>

        ダイアログを開く(事前データあり)。

      • savedListConfig: Ref<
            | null
            | {
                canCreateFolder: boolean;
                canDeleteFolder: boolean;
                canDeleteOtherSavedList: boolean;
                canDirectFileDownload: boolean;
                canFileDownload: boolean;
                canUpdate: boolean;
                csvDownloadCharacterCode: string[];
                hasCreateFolderPermission: boolean;
                hasDeleteFolderPermission: boolean;
                hasDeleteItemPermission: boolean;
                linkActionMode: string;
            },
            | null
            | SavedListConfig
            | {
                canCreateFolder: boolean;
                canDeleteFolder: boolean;
                canDeleteOtherSavedList: boolean;
                canDirectFileDownload: boolean;
                canFileDownload: boolean;
                canUpdate: boolean;
                csvDownloadCharacterCode: string[];
                hasCreateFolderPermission: boolean;
                hasDeleteFolderPermission: boolean;
                hasDeleteItemPermission: boolean;
                linkActionMode: string;
            },
        >

        保存リスト設定情報

      • savedListInfo: ComputedRef<null | SavedSearchInfo>

        保存リスト基本情報(EntityListing)

      • state: Ref<
            {
                aggregationData: | null
                | {
                    canDefinitionCsvDownload: boolean;
                    cols: string[];
                    colSize: number;
                    data: unknown[][];
                    dataType: string;
                    definitionName?: string;
                    filterValueList?: {
                        displayLabel: string;
                        filterDisplayValue?: string;
                        from?: string;
                        inDisplayValues?: { label: ...; value: ... }[];
                        inList?: string[];
                        operatorName: string;
                        savedListColLabel?: string;
                        savedListName?: string;
                        to?: string;
                    }[];
                    rowSize: number;
                    savedListInfo: {
                        description?: string;
                        folderDisplayName?: string;
                        folderId?: string;
                        id: string;
                        name: string;
                        ownData: boolean;
                        owner?: string;
                        shared: boolean;
                        snapshot: boolean;
                        updateDate: number;
                    };
                };
                dataType: null
                | string;
                errorMessage: null | string;
                isEditMode: boolean;
                isOpen: boolean;
                listedId: null | string;
                loading: boolean;
                savedListData:
                    | null
                    | {
                        canFileDownload?: boolean;
                        condition?: {
                            customFilterExpression?: string;
                            customResultFilterExpression?: string;
                            definitionName?: string;
                            distinct?: boolean;
                            entityName?: string;
                            filterValues?: {
                                compareAsString?: (...)
                                | (...)
                                | (...)
                                | (...);
                                from?: unknown;
                                in?: (...) | (...);
                                operator?: (...) | (...);
                                propertyName?: (...) | (...);
                                relativeRangeName?: (...) | (...);
                                savedList?: (...) | (...);
                                selectColNum?: (...) | (...);
                                to?: unknown;
                            }[];
                            resultFilterValues?: {
                                compareAsString?: (...)
                                | (...)
                                | (...)
                                | (...);
                                from?: unknown;
                                in?: (...) | (...);
                                operator?: (...) | (...);
                                propertyName?: (...) | (...);
                                relativeRangeName?: (...) | (...);
                                savedList?: (...) | (...);
                                selectColNum?: (...) | (...);
                                to?: unknown;
                            }[];
                            selectValues?: {
                                aggregateType?: (...)
                                | (...);
                                displayName?: (...) | (...);
                                dispStyle?: (...) | (...);
                                propertyDisplayName?: (...) | (...);
                                propertyName?: (...) | (...);
                            }[];
                            sortValues?: {
                                sortColNum?: (...)
                                | (...);
                                sortType?: (...) | (...) | (...);
                            }[];
                        };
                        definitionName?: string;
                        deletable?: boolean;
                        editable?: boolean;
                        editorMap?: Record<string, Record<string, unknown>>;
                        entityName?: string;
                        fileSupportType?: string;
                        filterOperators?: string[];
                        filterValueItems?: Record<string, unknown>[];
                        referenceViewable?: boolean;
                        relativeRanges?: { displayLabel: string; name: string }[];
                        remainInlineText?: boolean;
                        resultFilterValueItems?: Record<string, unknown>[];
                        savedSearchInfo: {
                            canEdit?: boolean;
                            canFileDownload?: boolean;
                            canOthersEdit?: boolean;
                            canReference?: boolean;
                            canSavedFilterEdit?: boolean;
                            dataTypeDisplayName?: string;
                            description?: string;
                            entityDisplayName?: string;
                            folderDisplayName?: string;
                            folderId?: string;
                            id?: string;
                            initSearch?: boolean;
                            name?: string;
                            ownData?: boolean;
                            owner?: string;
                            shared?: boolean;
                            snapshot?: boolean;
                            sortColNum?: number;
                            sortType?: "ASC" | "DESC";
                            updateDate?: number;
                        };
                        selectValueItems?: Record<string, unknown>[];
                        showReferenceByName?: boolean;
                        snapshot?: boolean;
                        sortable?: boolean;
                        userViewName?: string;
                    };
                searchLoading: boolean;
                searchResult: | null
                | {
                    data: Record<string, CellValue>[];
                    error?: string;
                    hasNext: boolean;
                    totalCount: number;
                };
            },
            | SavedListDialogState
            | {
                aggregationData: | null
                | {
                    canDefinitionCsvDownload: boolean;
                    cols: string[];
                    colSize: number;
                    data: unknown[][];
                    dataType: string;
                    definitionName?: string;
                    filterValueList?: {
                        displayLabel: string;
                        filterDisplayValue?: string;
                        from?: string;
                        inDisplayValues?: (...)[];
                        inList?: (...)[];
                        operatorName: string;
                        savedListColLabel?: string;
                        savedListName?: string;
                        to?: string;
                    }[];
                    rowSize: number;
                    savedListInfo: {
                        description?: string;
                        folderDisplayName?: string;
                        folderId?: string;
                        id: string;
                        name: string;
                        ownData: boolean;
                        owner?: string;
                        shared: boolean;
                        snapshot: boolean;
                        updateDate: number;
                    };
                };
                dataType: null
                | string;
                errorMessage: null | string;
                isEditMode: boolean;
                isOpen: boolean;
                listedId: null | string;
                loading: boolean;
                savedListData:
                    | null
                    | {
                        canFileDownload?: boolean;
                        condition?: {
                            customFilterExpression?: string;
                            customResultFilterExpression?: string;
                            definitionName?: string;
                            distinct?: boolean;
                            entityName?: string;
                            filterValues?: {
                                compareAsString?: ...;
                                from?: ...;
                                in?: ...;
                                operator?: ...;
                                propertyName?: ...;
                                relativeRangeName?: ...;
                                savedList?: ...;
                                selectColNum?: ...;
                                to?: ...;
                            }[];
                            resultFilterValues?: {
                                compareAsString?: ...;
                                from?: ...;
                                in?: ...;
                                operator?: ...;
                                propertyName?: ...;
                                relativeRangeName?: ...;
                                savedList?: ...;
                                selectColNum?: ...;
                                to?: ...;
                            }[];
                            selectValues?: {
                                aggregateType?: ...;
                                displayName?: ...;
                                dispStyle?: ...;
                                propertyDisplayName?: ...;
                                propertyName?: ...;
                            }[];
                            sortValues?: { sortColNum?: ...; sortType?: ... }[];
                        };
                        definitionName?: string;
                        deletable?: boolean;
                        editable?: boolean;
                        editorMap?: Record<string, Record<string, unknown>>;
                        entityName?: string;
                        fileSupportType?: string;
                        filterOperators?: string[];
                        filterValueItems?: Record<string, unknown>[];
                        referenceViewable?: boolean;
                        relativeRanges?: { displayLabel: string; name: string }[];
                        remainInlineText?: boolean;
                        resultFilterValueItems?: Record<string, unknown>[];
                        savedSearchInfo: {
                            canEdit?: boolean;
                            canFileDownload?: boolean;
                            canOthersEdit?: boolean;
                            canReference?: boolean;
                            canSavedFilterEdit?: boolean;
                            dataTypeDisplayName?: string;
                            description?: string;
                            entityDisplayName?: string;
                            folderDisplayName?: string;
                            folderId?: string;
                            id?: string;
                            initSearch?: boolean;
                            name?: string;
                            ownData?: boolean;
                            owner?: string;
                            shared?: boolean;
                            snapshot?: boolean;
                            sortColNum?: number;
                            sortType?: "ASC" | "DESC";
                            updateDate?: number;
                        };
                        selectValueItems?: Record<string, unknown>[];
                        showReferenceByName?: boolean;
                        snapshot?: boolean;
                        sortable?: boolean;
                        userViewName?: string;
                    };
                searchLoading: boolean;
                searchResult: | null
                | {
                    data: Record<string, CellValue>[];
                    error?: string;
                    hasNext: boolean;
                    totalCount: number;
                };
            },
        >