TrackingGroup Class
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy
.
For more information about our API support guarantees, see here.
Signature
export declare class TrackingGroup implements ITrackingGroup
Implements: ITrackingGroup
Constructors
Constructor | Alerts | Description |
---|---|---|
(constructor)() | Beta |
Constructs a new instance of the TrackingGroup class |
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
size | Beta |
readonly |
number | |
tracked | Beta |
readonly |
readonly Trackable[] |
Methods
Method | Alerts | Return Type | Description |
---|---|---|---|
has(trackable) | Beta |
boolean | |
link(trackable) | Beta |
void | |
unlink(trackable) | Beta |
boolean |
Constructor Details
(constructor)
Constructs a new instance of the TrackingGroup
class
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
constructor();
Property Details
size
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
get size(): number;
Type: number
tracked
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
get tracked(): readonly Trackable[];
Type: readonly Trackable[]
Method Details
has
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
has(trackable: Trackable): boolean;
Parameters
Parameter | Type | Description |
---|---|---|
trackable | Trackable |
Returns
Return type: boolean
link
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
link(trackable: Trackable): void;
Parameters
Parameter | Type | Description |
---|---|---|
trackable | Trackable |
unlink
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
unlink(trackable: Trackable): boolean;
Parameters
Parameter | Type | Description |
---|---|---|
trackable | Trackable |
Returns
Return type: boolean