Interface ControlApi<ControlTypeAttributes, ControlFieldType>

Extension of ControlApiBase supplied by SAS Visual Investigator to provide more functionality.

interface ControlApi<ControlTypeAttributes, ControlFieldType> {
    component?: any;
    getAriaLabel: (() => string);
    masking: MaskingControlApi;
    state: ControlStateApi;
    type: string;
    getAncestorControl(ofType: string): undefined | Control<TypeAttributes>;
    getControl(): Control<ControlTypeAttributes>;
    getFieldRestrictions(): FieldTypeToRestrictions<ControlFieldType>;
    getFieldValue(): FieldTypeToValue<ControlFieldType>;
    getFileRestrictions(): FileRestrictions;
    getParentControl(): undefined | Control<TypeAttributes>;
    isAuthorizedToUnmask(): boolean;
    isMaskedControl(): boolean;
    setComponentSpecificApi(componentSpecificApi?: any): void;
    setFieldValue(value: FieldTypeToValue<ControlFieldType>): void;
}

Type Parameters

ControlTypeAttributes extends TypeAttributes = TypeAttributes
ControlFieldType extends FieldType = never

Hierarchy (view full)

ControlApiBase<ControlTypeAttributes, ControlFieldType>
- ControlApi

Index

Properties

component? getAriaLabel masking state type

Methods

getAncestorControl getControl getFieldRestrictions getFieldValue getFileRestrictions getParentControl isAuthorizedToUnmask isMaskedControl setComponentSpecificApi setFieldValue

Properties

`Optional` `Readonly`component

component?: any

Space for component specific API functions.

getAriaLabel

getAriaLabel: (() => string)

Returns a string that can be used as an aria label for the field, which includes its required state. Uses the typeAttributes.title.text field for the label.

Type declaration

- (): string
- Returns string
  The aria label that should be applied.

Method

masking

masking: MaskingControlApi

Access the Control Data Masking API

`Readonly`state

state: ControlStateApi

Methods related to the state of the control.

`Readonly`type

type: string

Control type.

Methods

getAncestorControl

getAncestorControl(ofType): undefined | Control<TypeAttributes>
Returns the parent ancestor with the given type for this control.
Parameters
- ofType: string
  {string} Type of ancestor to be returned.
Returns undefined | Control<TypeAttributes>
Object representing the calling control's ancestor, or undefined if no match.

Method

getControl

getControl(): Control<ControlTypeAttributes>
Returns the calling control object.

Returns Control<ControlTypeAttributes>
Object representing the calling control.

Method
Inherited from ControlApiBase.getControl

getFieldRestrictions

getFieldRestrictions(): FieldTypeToRestrictions<ControlFieldType>
Returns the field restrictions that are associated with the calling control. Field must be configured as dataSource in the control's typeAttributes.

Returns FieldTypeToRestrictions<ControlFieldType>
The field restrictions that should be applied.

Method
Inherited from ControlApiBase.getFieldRestrictions

getFieldValue

getFieldValue(): FieldTypeToValue<ControlFieldType>
Gives the value of the control's field. Field must be configured as dataSource in the control's typeAttributes.

Returns FieldTypeToValue<ControlFieldType>
The value of the control's field.

Method
Inherited from ControlApiBase.getFieldValue

getFileRestrictions

getFileRestrictions(): FileRestrictions
Returns the restrictions of the control's file category. File category must be configured as fileCategory in the control's typeAttributes.

Returns FileRestrictions
The file restrictions that should be applied.

Method
Inherited from ControlApiBase.getFileRestrictions

getParentControl

getParentControl(): undefined | Control<TypeAttributes>
Returns the calling control's parent object.

Returns undefined | Control<TypeAttributes>
Object representing the calling control's parent.

Method

isAuthorizedToUnmask

isAuthorizedToUnmask(): boolean
Control Mask Authorization

Returns boolean
Deprecated
use api.control.masking.isAuthorizedToUnmask

Inherited from ControlApiBase.isAuthorizedToUnmask

isMaskedControl

isMaskedControl(): boolean
Control Mask

Returns boolean
Deprecated
use api.control.masking.isConfiguredForMasking instead.

Inherited from ControlApiBase.isMaskedControl

setComponentSpecificApi

setComponentSpecificApi(componentSpecificApi?): void
Sets the value of the component specific API.
Parameters
- OptionalcomponentSpecificApi: any
Returns void

setFieldValue

setFieldValue(value): void
Sets the value of the control's field. Field must be configured as dataSource in the control's typeAttributes.
Parameters
- value: FieldTypeToValue<ControlFieldType>
  {FieldTypeToValue} New field value.
Returns void
Method
Inherited from ControlApiBase.setFieldValue

Interface ControlApi<ControlTypeAttributes, ControlFieldType>

Type Parameters

Hierarchy (view full)

Index

Properties

Methods

Properties

Optional Readonlycomponent

getAriaLabel

Type declaration

Returns string

Method

masking

Readonlystate

Readonlytype

Methods

getAncestorControl

Parameters

Returns undefined | Control<TypeAttributes>

Method

getControl

Returns Control<ControlTypeAttributes>

Method

getFieldRestrictions

Returns FieldTypeToRestrictions<ControlFieldType>

Method

getFieldValue

Returns FieldTypeToValue<ControlFieldType>

Method

getFileRestrictions

Returns FileRestrictions

Method

getParentControl

Returns undefined | Control<TypeAttributes>

Method

isAuthorizedToUnmask

Returns boolean

Deprecated

isMaskedControl

Returns boolean

Deprecated

setComponentSpecificApi

Parameters

Returns void

setFieldValue

Parameters

Returns void

Method

Settings

On This Page

`Optional` `Readonly`component

`Readonly`state

`Readonly`type