Skip to content

Conversation

@ShereinDabbah
Copy link

  1. bump to version 5.0.0
  2. Add formatting pane model interfaces
  3. Separate visuals and formatting pane interfaces into two files

@AsafMozes
Copy link
Contributor

Please wait for api 4.8 before completing this one.


export interface FormattingModelMessageAction {
key: string;
fn: () => void;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does fn() do? does the CV pass the code into the host?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont know how it exactly works, But I see that yes it run some code in our side in some html file in front end.
Should I delete it ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this is code that the visual provides then we should remove it.

topLevelToggle?: EnabledSlice;
groups: (FormattingGroup | FormattingGroupPlaceholder)[];
/** This contains the list of descriptors for revert to default, note the descriptors of all the slices ever possible in the card must be added */
revertToDefaultDescriptors?: FormattingDescriptor[];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey can you explain what the purpose of this is?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revertToDefaultDescriptors is the list of all formatting properties descriptors (descriptor is objectName and propertyName - the same as in capabilites) in this formatting card that will be reverted/reset their values to their default values when we click on Reset to default option which appears in each formatting card.
revertToDefaultDescriptors is required if we want to use the Reset to default option and reset all of the properties in card in one click

* signal action is taken. E.g., for an Analytics Pane forecast, the forecast parameter values shouldn't be
* saved to the visual until the Apply button is clicked. Note that this applies to all slices in the group.
*/
delaySaveSlices?: boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this applicable to CVs?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont know exactly what is the use of this

}

/**
* Handles resolving the type of placeholder that's expected to be return.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: to be returned.


interface Slider extends NumUpDown { }

// ideally we would set type here to number, but the old formatting pane always converts enum members to string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this comment required?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, will be deleted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants