Class Register

Hierarchy

Constructors

constructor

new Register(params): Register
Parameters
- params: {
  apiGetters?: ApiGetters;
  viewer: Viewer;
  }
  - Optional apiGetters?: ApiGetters
  - viewer: Viewer
Returns Register
- Defined in src/rendering/visuals-register.ts:470

Properties

`Private` apiGetters

apiGetters: ApiGetters

`Private` cameraCullerDispose

cameraCullerDispose: ((params?) => void)

Type declaration

- (params?): void
- Parameters
  - Optional params: IMonitorDispose
  Returns void

`Private` hiddenIds

hiddenIds: string[] = []

`Private` id

id: string = ...

`Private` isolatedIds

isolatedIds: string[] = []

`Private` labelledEntityIds

labelledEntityIds: string[] = []

`Private` onUpdate

onUpdate: BruceEvent<IVisualUpdate> = ...

`Private` opacity

opacity: IDictionary<number> = {}

`Private` rego

rego: IDictionary<IVisualRego[]> = {}

`Private` selectedIds

selectedIds: string[] = []

`Private` selectionColor

selectionColor: Color

`Private` viewer

viewer: Viewer

Accessors

ApiGetters

get ApiGetters(): ApiGetters
Returns ApiGetters
- Defined in src/rendering/visuals-register.ts:444

Id

get Id(): string
Returns string
- Defined in src/rendering/visuals-register.ts:436

OnUpdate

get OnUpdate(): BruceEvent<IVisualUpdate>
Returns BruceEvent<IVisualUpdate>
- Defined in src/rendering/visuals-register.ts:449

Viewer

get Viewer(): Viewer
Returns Viewer
- Defined in src/rendering/visuals-register.ts:440

Methods

AddRego

AddRego(params): void
Parameters
- params: {
  rego: IVisualRego;
  requestRender?: boolean;
  }
  - rego: IVisualRego
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:784

ClearHidden

ClearHidden(params?): void
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:770

ClearIsolated

ClearIsolated(params?): void
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:716

ClearLabelled

ClearLabelled(params?): void
Clears all labelled entities.
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:553

ClearOpacity

ClearOpacity(params?): void
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:1205

ClearSelected

ClearSelected(params?): void
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:644

Dispose

Dispose(): void
Returns void
- Defined in src/rendering/visuals-register.ts:483

ForceUpdate

ForceUpdate(params): void
Parameters
- params: {
  entityIds: string[];
  }
  - entityIds: string[]
Returns void
- Defined in src/rendering/visuals-register.ts:490

GetEntityIds

GetEntityIds(): string[]
Returns all registered entity ids.

Returns string[]
- Defined in src/rendering/visuals-register.ts:1070

GetHidden

GetHidden(): string[]
Returns string[]
- Defined in src/rendering/visuals-register.ts:766

GetIsHidden

GetIsHidden(params): boolean
Parameters
- params: {
  entityId: string;
  }
  - entityId: string
Returns boolean
- Defined in src/rendering/visuals-register.ts:759

GetIsIsolated

GetIsIsolated(params): boolean
Parameters
- params: {
  entityId: string;
  }
  - entityId: string
Returns boolean
- Defined in src/rendering/visuals-register.ts:705

GetIsLabelled

GetIsLabelled(params): boolean
Returns if given entity id is labelled.
Parameters
- params: {
  entityId: string;
  }
  - entityId: string
Returns boolean
- Defined in src/rendering/visuals-register.ts:542

GetIsSelected

GetIsSelected(params): boolean
Parameters
- params: {
  entityId: string;
  }
  - entityId: string
Returns boolean
- Defined in src/rendering/visuals-register.ts:637

GetIsolated

GetIsolated(): string[]
Returns string[]
- Defined in src/rendering/visuals-register.ts:712

GetLabelled

GetLabelled(): string[]
Returns all labelled entity ids.

Returns string[]
- Defined in src/rendering/visuals-register.ts:571

GetOpacity

GetOpacity(params): number
Returns opacity for given entity/s. If multiple entities are supplied, then the average is returned. Unknown opacity is treated as 100% opacity.
Parameters
- params: {
  entityIds: string[];
  menuItemIds?: string;
  }
  - entityIds: string[]
  - Optional menuItemIds?: string
Returns number
- Defined in src/rendering/visuals-register.ts:1178

GetOpacityMap

GetOpacityMap(): IDictionary<number>
Returns a dictionary containing entityId -> opacity values. Opacity 1 = 100%.

Returns IDictionary<number>
- Defined in src/rendering/visuals-register.ts:1234

GetRego

GetRego(params): IVisualRego
Locates a visual corresponding to a given entity id. If no menu item id is provided, then it will pick the "best" one.
Parameters
- params: {
      entityId?: string;
      menuItemId?: string;
      relation?: IRelation;
  }
  - Optional entityId?: string
  - Optional menuItemId?: string
  - Optional relation?: IRelation
Returns IVisualRego
- Defined in src/rendering/visuals-register.ts:841

GetRegos

GetRegos(params): IVisualRego[]
Returns regos matching given criteria. Either entityId or menuItemId must be provided.
Parameters
- params: {
  entityId?: string;
  menuItemId?: string;
  }
  - Optional entityId?: string
  - Optional menuItemId?: string
Returns IVisualRego[]
- Defined in src/rendering/visuals-register.ts:878

GetRegosFromCursor

GetRegosFromCursor(params): {
regos: IVisualRego[];
}
Returns an array of drilled visuals associated with this register. The top array item is the first found.
Parameters
- params: {
      cursor: ICartes2;
      height?: number;
      pickLimit?: number;
      width?: number;
  }
  - cursor: ICartes2
  - Optional height?: number
  - Optional pickLimit?: number
  - Optional width?: number
Returns {
regos: IVisualRego[];
}
- regos: IVisualRego[]
- Defined in src/rendering/visuals-register.ts:1033

GetSelected

GetSelected(): string[]
Returns string[]
- Defined in src/rendering/visuals-register.ts:667

MarkStale

MarkStale(params): void
Marks regos corresponding to given entity ids as stale. This will cause them to be updated on the next update cycle. Optionally include menu item ids to restrict the filter.
Parameters
- params: {
  entityIds: string[];
  menuItemIds?: string[];
  }
  - entityIds: string[]
  - Optional menuItemIds?: string[]
Returns void
- Defined in src/rendering/visuals-register.ts:1087

RemoveRegos

RemoveRegos(params): void
Removes regos matching given criteria. Either entityId or menuItemId must be provided.
Parameters
- params: {
      doUpdate?: boolean;
      entityId?: string;
      menuItemId?: string;
      relation?: IRelation;
      requestRender?: boolean;
      retainTagIds?: (string | number)[];
  }
  - Optional doUpdate?: boolean
  - Optional entityId?: string
  - Optional menuItemId?: string
  - Optional relation?: IRelation
  - Optional requestRender?: boolean
  - Optional retainTagIds?: (string | number)[]
Returns void
- Defined in src/rendering/visuals-register.ts:916

SetHidden

SetHidden(params): void
Parameters
- params: {
      entityIds: string[];
      hidden: boolean;
      requestRender?: boolean;
  }
  - entityIds: string[]
  - hidden: boolean
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:726

SetIsolated

SetIsolated(params): void
Parameters
- params: {
      entityIds: string[];
      isolated: boolean;
      requestRender?: boolean;
  }
  - entityIds: string[]
  - isolated: boolean
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:671

SetLabelled

SetLabelled(params): void
Marks given entityIds as either labelled or not labelled. When an entity is labelled a label will be drawn on the "best" visual for it.
Parameters
- params: {
      entityIds: string[];
      labelled: boolean;
      requestRender?: boolean;
  }
  - entityIds: string[]
  - labelled: boolean
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:510

SetOpacity

SetOpacity(params): void
Sets opacity for given set of entities. 100% opacity is treated as "use original".
Parameters
- params: {
      entityIds: string[];
      menuItemId?: string;
      opacity: number;
      requestRender?: boolean;
  }
  - entityIds: string[]
  - Optional menuItemId?: string
  - opacity: number
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:1124

SetSelected

SetSelected(params): void
Parameters
- params: {
      entityIds: string[];
      refreshIfSelected?: boolean;
      requestRender?: boolean;
      selected: boolean;
  }
  - entityIds: string[]
  - Optional refreshIfSelected?: boolean
  - Optional requestRender?: boolean
  - selected: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:584

SetSelectionColor

SetSelectionColor(color): void
Updates the selection color. This will not update the selection color for already selected entities.
Parameters
- color: Color
Returns void
- Defined in src/rendering/visuals-register.ts:580

`Private` updateAllEntities

updateAllEntities(params?): void
Parameters
- Optional params: {
  requestRender?: boolean;
  }
  - Optional requestRender?: boolean
Returns void
- Defined in src/rendering/visuals-register.ts:1104

Class Register

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: { apiGetters?: ApiGetters; viewer: Viewer; }

Optional apiGetters?: ApiGetters

viewer: Viewer

Returns Register

Properties

Private apiGetters

Private cameraCullerDispose

Type declaration

Parameters

Optional params: IMonitorDispose

Returns void

Private hiddenIds

Private id

Private isolatedIds

Private labelledEntityIds

Private onUpdate

Private opacity

Private rego

Private selectedIds

Private selectionColor

Private viewer

Accessors

ApiGetters

Returns ApiGetters

Id

Returns string

OnUpdate

Returns BruceEvent<IVisualUpdate>

Viewer

Returns Viewer

Methods

AddRego

Parameters

params: { rego: IVisualRego; requestRender?: boolean; }

rego: IVisualRego

Optional requestRender?: boolean

Returns void

ClearHidden

Parameters

Optional params: { requestRender?: boolean; }

Optional requestRender?: boolean

Returns void

ClearIsolated

Parameters

Optional params: { requestRender?: boolean; }

Optional requestRender?: boolean

Returns void

ClearLabelled

Parameters

Optional params: { requestRender?: boolean; }

Optional requestRender?: boolean

Returns void

ClearOpacity

Parameters

Optional params: { requestRender?: boolean; }

Optional requestRender?: boolean

Returns void

ClearSelected

Parameters

Optional params: { requestRender?: boolean; }

Optional requestRender?: boolean

Returns void

Dispose

Returns void

ForceUpdate

Parameters

params: { entityIds: string[]; }

entityIds: string[]

Returns void

GetEntityIds

params: {
apiGetters?: ApiGetters;
viewer: Viewer;
}

`Optional` apiGetters?: ApiGetters

`Private` apiGetters

`Private` cameraCullerDispose

`Optional` params: IMonitorDispose

`Private` hiddenIds

`Private` id

`Private` isolatedIds

`Private` labelledEntityIds

`Private` onUpdate

`Private` opacity

`Private` rego

`Private` selectedIds

`Private` selectionColor

`Private` viewer

params: {
rego: IVisualRego;
requestRender?: boolean;
}

`Optional` requestRender?: boolean

`Optional` params: {
requestRender?: boolean;
}

`Optional` requestRender?: boolean

`Optional` params: {
requestRender?: boolean;
}

`Optional` requestRender?: boolean

`Optional` params: {
requestRender?: boolean;
}

`Optional` requestRender?: boolean

`Optional` params: {
requestRender?: boolean;
}

`Optional` requestRender?: boolean

`Optional` params: {
requestRender?: boolean;
}

`Optional` requestRender?: boolean

params: {
entityIds: string[];
}

params: {
entityId: string;
}

params: {
entityId: string;
}

params: {
entityId: string;
}

params: {
entityId: string;
}

params: {
entityIds: string[];
menuItemIds?: string;
}

`Optional` menuItemIds?: string

params: {
entityId?: string;
menuItemId?: string;
relation?: IRelation;
}

`Optional` entityId?: string

`Optional` menuItemId?: string

`Optional` relation?: IRelation

params: {
entityId?: string;
menuItemId?: string;
}

`Optional` entityId?: string

`Optional` menuItemId?: string

params: {
cursor: ICartes2;
height?: number;
pickLimit?: number;
width?: number;
}

`Optional` height?: number

`Optional` pickLimit?: number

`Optional` width?: number

Returns {
regos: IVisualRego[];
}

params: {
entityIds: string[];
menuItemIds?: string[];
}

`Optional` menuItemIds?: string[]

params: {
doUpdate?: boolean;
entityId?: string;
menuItemId?: string;
relation?: IRelation;
requestRender?: boolean;
retainTagIds?: (string | number)[];
}

`Optional` doUpdate?: boolean

`Optional` entityId?: string