@itwin/core-common/lib/esm/EmphasizeElementsProps.d.ts

iTwin.js components common to frontend and backend

/** @packageDocumentation
 * @module Rendering
 */
import { Id64Array } from "@itwin/core-bentley";
import { ColorDefProps } from "./ColorDef";
import { FeatureAppearanceProps } from "./FeatureSymbology";
/** Options for overriding element appearance.
 * @see [EmphasizeElements]($frontend)
 * @see [[AppearanceOverrideProps]]
 * @public
 * @extensions
 */
export declare enum FeatureOverrideType {
    /** Override color only. */
    ColorOnly = 0,
    /** Override alpha only. */
    AlphaOnly = 1,
    /** Override both color and alpha. */
    ColorAndAlpha = 2
}
/** JSON representation of an appearance override in an [[EmphasizeElementsProps]].
 * @see [EmphasizeElements]($frontend).
 * @public
 * @extensions
 */
export interface AppearanceOverrideProps {
    /** Whether to override color, transparency, or both. */
    overrideType?: FeatureOverrideType;
    /** The 0xTTBBGGRR format color/transparency value. */
    color?: ColorDefProps;
    /** The element IDs to display with the specified override. */
    ids?: Id64Array;
}
/** JSON representation of an [EmphasizeElements]($frontend).
 * @public
 * @extensions
 */
export interface EmphasizeElementsProps {
    /** See [EmphasizeElements.getNeverDrawnElements]($frontend) */
    neverDrawn?: Id64Array;
    /** See [EmphasizeElements.getAlwaysDrawnElements]($frontend) */
    alwaysDrawn?: Id64Array;
    /** See [EmphasizeElements.getIsolatedElements]($frontend) */
    isAlwaysDrawnExclusive?: boolean;
    /** See [EmphasizeElements.getEmphasizedIsolatedElements]($frontend) */
    alwaysDrawnExclusiveEmphasized?: Id64Array;
    /** See [EmphasizeElements.defaultAppearance]($frontend) */
    defaultAppearance?: FeatureAppearanceProps;
    /** See [EmphasizeElements.getOverriddenElementsByKey]($frontend) */
    appearanceOverride?: AppearanceOverrideProps[];
    /** See [EmphasizeElements.wantEmphasis]($frontend) */
    wantEmphasis?: boolean;
    /** See [EmphasizeElements.unanimatedAppearance]($frontend) */
    unanimatedAppearance?: FeatureAppearanceProps;
}
//# sourceMappingURL=EmphasizeElementsProps.d.ts.map