@itwin/appui-abstract
Version:
iTwin.js UI abstractions
61 lines • 1.97 kB
TypeScript
/** @packageDocumentation
* @module Properties
*/
import { Id64String } from "@itwin/core-bentley";
/** Primitive Property Value Types.
* @public
*/
export declare namespace Primitives {
/** Text type */
type Text = string;
/** String type */
type String = string;
/** DateTime will be formatted as date and time */
type DateTime = string | Date;
/** ShortDate will be formatted as date only and will not include time */
type ShortDate = string | Date;
/** Boolean type */
type Boolean = boolean | string | object | [];
/** Float type */
type Float = number | string;
/** Int type */
type Int = number | string;
/** Hexadecimal type (number expressed in hex string) */
type Hexadecimal = Id64String;
/** Enum type (enumerated list of values) */
type Enum = number | string;
/** Numeric type (can be float or int) */
type Numeric = Float | Int;
/** Point2d type (contains an x and a y coordinate) */
type Point2d = string[] | number[] | {
x: number;
y: number;
};
/** Point3d type (contains x,y,and z coordinates) */
type Point3d = string[] | number[] | {
x: number;
y: number;
z: number;
};
/** Point type (can be a 2d or 3d point) */
type Point = Point2d | Point3d;
/** CompositePart (ties a raw value of a specific type to a display string) */
interface CompositePart {
displayValue: string;
rawValue: Value;
typeName: string;
}
/** Composite type (built of one or more CompositePart items) */
interface Composite {
separator: string;
parts: CompositePart[];
}
/** Instance key type. */
interface InstanceKey {
className: string;
id: Id64String;
}
/** Raw value */
type Value = Text | String | ShortDate | Boolean | Numeric | Enum | Point | Composite | InstanceKey;
}
//# sourceMappingURL=PrimitiveTypes.d.ts.map