@antv/t8/types/plugin/createEntityPhraseFactory.d.ts

T8 is a text visualization solution for unstructured data within the AntV technology stack, and it is a declarative JSON Schema syntax that can be used to describe the content of data interpretation reports.

import { EntityMetaData, EntityType } from '../schema';
import { PhraseDescriptor, SpecificEntityPhraseDescriptor, CustomEntityMode } from './types';
/**
 * Factory function creator for entity phrase descriptors.
 *
 * This higher-order function creates a factory function that generates entity phrase descriptors.
 * It allows customization of entity descriptors while maintaining default behaviors through
 * merging or overwriting strategies.
 *
 * @param key - The entity type identifier for the phrase.
 * @param defaultDescriptor - The base descriptor providing default behavior and styling.
 * @returns A factory function that creates customized phrase descriptors.
 */
export declare const createEntityPhraseFactory: (key: EntityType, defaultDescriptor: SpecificEntityPhraseDescriptor) => (
/**
 * @param customDescriptor - Optional descriptor to customize the entity phrase.
 * @param mode - Strategy for applying customizations: 'merge' combines with defaults, 'overwrite' replaces defaults.
 * @returns A fully configured phrase descriptor for the entity type.
 */
customDescriptor?: SpecificEntityPhraseDescriptor, mode?: CustomEntityMode) => PhraseDescriptor<EntityMetaData>;
//# sourceMappingURL=createEntityPhraseFactory.d.ts.map