@itwin/presentation-common
Version:
Common pieces for iModel.js presentation packages
36 lines • 1.72 kB
TypeScript
/** @packageDocumentation
* @module PresentationRules
*/
import { ChildNodeSpecificationBase } from "./ChildNodeSpecification.js";
/**
* Returns a static custom-defined node that's not based on an ECInstance.
*
* @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)
* @public
* @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
* package for creating hierarchies.
*/
export interface CustomNodeSpecification extends ChildNodeSpecificationBase {
/** Used for serializing to JSON. */
specType: "CustomNode";
/** Specifies node type, which is assigned to node's key. */
type: string;
/**
* Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).
*/
label: string;
/**
* Specifies the value of [[Node.description]] property, which is a string that may
* be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose
* whether and how to surface this information to users.
*/
description?: string;
/**
* Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's
* up to the UI component to decide what to do with it.
*
* @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
imageId?: string;
}
//# sourceMappingURL=CustomNodeSpecification.d.ts.map