ISelectionApi
Integration guide · Reference index
Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.
add
add(entities: EntityId[] | EntityId): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
entities | EntityId[] | EntityId | Yes |
set
set(entities: EntityId[] | EntityId): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
entities | EntityId[] | EntityId | Yes |
remove
remove(entities: EntityId[]): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
entities | EntityId[] | Yes |
contains
contains(entity: EntityId): boolean;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
entity | EntityId | Yes |
allSources
allSources(): EntityId[];Use the type signature above and the integration guide for the owning capability.
isEmpty
isEmpty(): boolean;Use the type signature above and the integration guide for the owning capability.
clear
clear(): void;Use the type signature above and the integration guide for the owning capability.
onChanged
onChanged(): ISubscription<() => void>;Use the type signature above and the integration guide for the owning capability.
canBeAddedToSelection
canBeAddedToSelection(entity: EntityId): boolean;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
entity | EntityId | Yes |