@sassoftware/vi-api
Version:
Types used in the SAS Visual Investigator API
23 lines (22 loc) • 736 B
TypeScript
import { MetadataApi } from "../metadata-api";
export interface FieldTypeLabels {
[type: string]: string;
}
/**
* {@link MetadataApi} extension provides the functionality related to retrieval of metadata.
* Additional methods are available only in the SAS Visual Investigator Manage and Investigate interface.
*
* Accessed from the window at `window.sas.vi.metadata`.
*
* @extends MetadataApi
* @example window.sas.vi.metadata.getFieldDataTypeLabels();
* @category API
*/
export interface AdminMetadataApi extends MetadataApi {
/**
* @method
* @description Gets the field data type labels.
* @returns Object containing the field data type labels.
*/
getFieldDataTypeLabels(): FieldTypeLabels;
}