FilteringExtension

Documentation Index

Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt

Use this file to discover all available pages before exploring further.

​

Accessors

​

filteringState

get filteringState(): FilteringState

​

Methods

​

hideObjects

hideObjects(
    objectIds: string[],
    stateKey: string = null,
    includeDescendants = false,
    ghost = false
  ): FilteringState

• objectIds: The ids of the objects to hide
• optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
• optional includeDescendants: Whether to include the descendants of the provided object ids
• optional ghost Whether to ghost the rest of the objects

​

isolateObjects

isolateObjects(
    objectIds: string[],
    stateKey: string = null,
    includeDescendants = true,
    ghost = true
  ): FilteringState

• objectIds: The ids of the objects to hide
• optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
• optional includeDescendants: Whether to include the descendants of the provided object ids
• optional ghost Whether to ghost the rest of the objects

​

isolateObjects

removeColorFilter(): FilteringState

​

removeUserObjectColors

removeUserObjectColors(): FilteringState

​

resetFilters

resetFilters(): FilteringState

​

setColorFilter

setColorFilter(prop: PropertyInfo, ghost = true): FilteringState

• prop: PropertyInfo
• optional ghost” Whether to ghost the rest of the objects

​

setUserObjectColors

setUserObjectColors(
    groups: { objectIds: string[]; color: string }[]
): FilteringState

• groups: Groups of objects organized by color

​

showObjects

showObjects(
    objectIds: string[],
    stateKey: string = null,
    includeDescendants = false
  ): FilteringState

• objectIds: The ids of the objects to hide
• optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
• optional includeDescendants: Whether to include the descendants of the provided object ids

​

unIsolateObjects

unIsolateObjects(
    objectIds: string[],
    stateKey: string = null,
    includeDescendants = true,
    ghost = true
  ): FilteringState

• objectIds: The ids of the objects to hide
• optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
• optional includeDescendants: Whether to include the descendants of the provided object ids
• optional ghost Whether to ghost the rest of the objects

​

Typedefs

​

FilteringState

type FilteringState = {
  selectedObjects?: string[];
  hiddenObjects?: string[];
  isolatedObjects?: string[];
  colorGroups?: Record<string, string>[];
  userColorGroups?: { ids: string[]; color: string }[];
  activePropFilterKey?: string;
  passMin?: number | null;
  passMax?: number | null;
};

• selectedObjects: The current selected object ids
• hidenObjects: The current hidden object ids
• isolatedObjects: The current isolated object ids
• colorGroups: The current color groups
• userColorGroups: The current user color groups
• activePropFilterKey: The active property filtering key
• passMin: The minimal value of the property filtering value if numeric
• passMax: The maximum value of the property filtering value if numeric

​

PropertyInfo

interface PropertyInfo {
  key: string;
  objectCount: number;
  type: 'number' | 'string' | 'boolean';
  path: string[];
  concatenatedPath: string;
  name: string;
}

• key: The property key (flattened path, e.g., "level.name")
• objectCount: The object count where the key is present
• type: Property type - 'number', 'string', or 'boolean'
• path: Property path as array segments
• concatenatedPath: Full property path (same as key)
• name: Property name (last path segment)