title: “Получить AutoFilter” description: “Получите описание AutoFilter из рабочей книги Excel с использованием REST API Aspose.Cells Cloud.” keywords: “AutoFilter, Excel, Aspose.Cells Cloud, REST API, SDK, C#, Java, PHP, Ruby, Node.js, Python, Perl, Go” type: docs url: /cells/autofilter/get/ aliases:

Получение описания AutoFilter из рабочего листа

Версия: v3.0
Конечная точка: GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/autoFilter

Примечание: Все примеры запросов используют HTTPS. Никогда не отправляйте JWT-токены по незащищённому соединению.

Обзор

AutoFilter позволяет фильтровать строки на рабочем листе на основе значений столбцов, цветов, пользовательских критериев и других параметров. Этот API возвращает полную конфигурацию AutoFilter — включая фильтруемые столбцы, диапазон и детали сортировки — чтобы вы могли программно проверить или воспроизвести настройки фильтра.

Требования

Требование Описание
Аутентификация Требуется действительный JWT-токен. Подробности см. в руководстве по аутентификации.
Расположение файла Рабочая книга должна храниться в облачном хранилище Aspose Cloud (или в подключённом внешнем хранилище).
Поддерживаемые форматы Любой формат Excel, поддерживаемый Aspose.Cells (например, .xlsx, .xls, .xlsm).
SDK (необязательно) Если вы предпочитаете использовать SDK, установите соответствующий пакет (например, dotnet add package Aspose.Cells-Cloud для .NET).

Запрос

HTTP-запрос

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/autoFilter

Параметры пути

Параметр Тип Описание
name string Обязательный. Имя файла рабочей книги с расширением.
sheetName string Обязательный. Имя рабочего листа, из которого нужно получить AutoFilter.

Параметры запроса

Параметр Тип Описание
folder string Путь к папке в хранилище, где находится рабочая книга.
storageName string Имя используемого хранилища.

Безопасность

API использует аутентификацию на основе JWT-токена. Укажите токен в заголовке Authorization:

Authorization: Bearer <your_jwt_token>

Пример запроса (cURL)

curl "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter?folder=MyFolder&storageName=MyStorage" \
  -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt_token>"

Ответ

Сервис возвращает объект JSON, оборачивающий модель AutoFilter.

Схема успешного ответа

{
  "Status": "OK",
  "Code": 200,
  "AutoFilter": {
    "link": {
      "Href": "string",
      "Rel": "string",
      "Title": "string",
      "Type": "string"
    },
    "FilterColumns": [
      {
        "FieldIndex": 0,
        "FilterType": "string",
        "MultipleFilters": {
          "MatchBlank": true,
          "MultipleFilterList": [
            {}
          ]
        },
        "ColorFilter": {
          "FilterByFillColor": "string",
          "Pattern": "string",
          "Color": {
            "Color": { "A": 0, "R": 0, "G": 0, "B": 0 },
            "ColorIndex": 0,
            "IsShapeColor": true,
            "ThemeColor": { "ColorType": "string", "Tint": 0 },
            "Type": "string"
          },
          "ForegroundColorColor": {
            "Color": { "A": 0, "R": 0, "G": 0, "B": 0 },
            "ColorIndex": 0,
            "IsShapeColor": true,
            "ThemeColor": { "ColorType": "string", "Tint": 0 },
            "Type": "string"
          },
          "BackgroundColor": {
            "Color": { "A": 0, "R": 0, "G": 0, "B": 0 },
            "ColorIndex": 0,
            "IsShapeColor": true,
            "ThemeColor": { "ColorType": "string", "Tint": 0 },
            "Type": "string"
          }
        },
        "CustomFilters": [
          { "FilterOperatorType": "string" }
        ],
        "DynamicFilter": { "DynamicFilterType": "string" },
        "IconFilter": { "IconId": 0, "IconSetType": "string" },
        "Top10Filter": {
          "Criteria": "string",
          "IsPercent": true,
          "IsTop": true,
          "Items": 0
        },
        "Visibledropdown": "string"
      }
    ],
    "Range": "string",
    "Sorter": {
      "CaseSensitive": true,
      "HasHeaders": true,
      "KeyList": [
        { "Key": 0, "SortOrder": "string", "CustomList": "string" }
      ],
      "SortLeftToRight": true
    }
  }
}

Пример ответа

{
  "Status": "OK",
  "Code": 200,
  "AutoFilter": {
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/autoFilter",
      "Rel": "self",
      "Title": "AutoFilter",
      "Type": "application/json"
    },
    "FilterColumns": [
      {
        "FieldIndex": 1,
        "FilterType": "Custom",
        "MultipleFilters": {
          "MatchBlank": false,
          "MultipleFilterList": [
            {
              "Operator": "Equals",
              "Criteria": "Approved"
            }
          ]
        },
        "ColorFilter": null,
        "CustomFilters": [],
        "DynamicFilter": null,
        "IconFilter": null,
        "Top10Filter": null,
        "Visibledropdown": "true"
      }
    ],
    "Range": "A1:C100",
    "Sorter": {
      "CaseSensitive": false,
      "HasHeaders": true,
      "KeyList": [
        {
          "Key": 1,
          "SortOrder": "Ascending",
          "CustomList": null
        }
      ],
      "SortLeftToRight": false
    }
  }
}

Коды HTTP-статуса

Код Значение Описание
200 OK (ОК) Фильтр применён успешно; ответ содержит детали операции.
400 Bad Request (Неверный запрос) Отсутствуют или недопустимы параметры (например, неподдерживаемый тип файла).
401 Unauthorized (Неавторизовано) Недействительный или отсутствующий JWT-токен.
413 Payload Too Large (Слишком большой полезный груз) Загруженный файл превышает допустимый размер.
500 Internal Server Error (Внутренняя ошибка сервера) Непредвиденная ошибка сервера.

Примеры SDK

Операция доступна во всех SDK Aspose.Cells Cloud. Ниже приведены готовые к запуску фрагменты кода.

Язык Пример
C#
Показать кодcsharp\nusing Aspose.Cells.Cloud.SDK.Api;\nusing Aspose.Cells.Cloud.SDK.Model;\n\nvar apiInstance = new CellsApi();\nvar response = apiInstance.GetWorksheetAutoFilter("Book1.xlsx", "Sheet1", folder: "MyFolder", storageName: "MyStorage");\nConsole.WriteLine(response.AutoFilter);\n
Java
Показать кодjava\nimport com.aspose.cells.cloud.api.CellsApi;\nimport com.aspose.cells.cloud.model.AutoFilterResponse;\n\nCellsApi api = new CellsApi();\nAutoFilterResponse resp = api.getWorksheetAutoFilter("Book1.xlsx", "Sheet1", "MyFolder", "MyStorage");\nSystem.out.println(resp.getAutoFilter());\n
Python
Показать кодpython\nfrom asposecellscloud import CellsApi\n\napi = CellsApi()\nresp = api.get_worksheet_auto_filter(name='Book1.xlsx', sheet_name='Sheet1', folder='MyFolder', storage_name='MyStorage')\nprint(resp.auto_filter)\n
Node.js
Показать кодjavascript\nconst { CellsApi } = require('asposecellscloud');\nconst api = new CellsApi();\napi.getWorksheetAutoFilter('Book1.xlsx', 'Sheet1', { folder: 'MyFolder', storageName: 'MyStorage' })\n .then(resp => console.log(resp.autoFilter))\n .catch(err => console.error(err));\n
PHP
Показать кодphp\nuse Aspose\Cells\CellsApi;\nuse Aspose\Cells\Models\AutoFilterResponse;\n\n$api = new CellsApi();\n$response = $api->getWorksheetAutoFilter('Book1.xlsx', 'Sheet1', 'MyFolder', 'MyStorage');\nprint_r($response->getAutoFilter());\n
Ruby
Показать кодruby\nrequire 'aspose_cells_cloud'\napi = AsposeCellsCloud::CellsApi.new\nresp = api.get_worksheet_auto_filter('Book1.xlsx', 'Sheet1', folder: 'MyFolder', storage_name: 'MyStorage')\nputs resp.auto_filter\n
Go
Показать кодgo\nimport (\n \"fmt\"\n \"github.com/aspose-cells-cloud/aspose-cells-cloud-go/v3\"\n)\n\napi := asposecellscloud.NewAPIClient()\nresp, _, err := api.CellsApi.GetWorksheetAutoFilter(context.Background(), \"Book1.xlsx\", \"Sheet1\", \"MyFolder\", \"MyStorage\")\nif err != nil { panic(err) }\nfmt.Println(resp.AutoFilter)\n
Perl
Показать кодperl\nuse AsposeCellsCloud::CellsApi;\nmy $api = AsposeCellsCloud::CellsApi->new();\nmy $resp = $api->get_worksheet_auto_filter(name=>'Book1.xlsx', sheet_name=>'Sheet1', folder=>'MyFolder', storage_name=>'MyStorage');\nprint $resp->{autoFilter};\n

Полный список SDK и инструкции по установке доступны на GitHub-репозитории Aspose.Cells Cloud.

См. также