Home > kibana-plugin-core-server > SavedObjectsTypeManagementDefinition
Configuration options for the type's management section.
Signature:
export interface SavedObjectsTypeManagementDefinition<Attributes = any> | Property | Type | Description |
|---|---|---|
| defaultSearchField? | string | (Optional) The default search field to use for this type. Defaults to id. |
| displayName? | string | (Optional) When specified, will be used instead of the type's name in SO management section's labels. |
| getEditUrl? | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. |
| getInAppUrl? | (savedObject: SavedObject<Attributes>) => { path: string; uiCapabilitiesPath: string; } | (Optional) Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. |
| getTitle? | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. |
| icon? | string | (Optional) The eui icon name to display in the management table. If not defined, the default icon will be used. |
| importableAndExportable? | boolean | (Optional) Is the type importable or exportable. Defaults to false. |
| isExportable? | SavedObjectsExportablePredicate<Attributes> | (Optional) Optional hook to specify whether an object should be exportable.If specified, isExportable will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) |
| onExport? | SavedObjectsExportTransform<Attributes> | (Optional) An optional export transform function that can be used transform the objects of the registered type during the export process.It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.See the transform type documentation for more info and examples.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) |
| onImport? | SavedObjectsImportHook<Attributes> | (Optional) An optional import hook to use when importing given type.Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the hook documentation for more info. |
| visibleInManagement? | boolean | (Optional) When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to true. |