topic Re: Modifying parseSettings/VisualSettings in Developer

Modifying parseSettings/VisualSettings

callum — Wed, 06 Sep 2017 11:24:10 GMT

Hello,

A newly created visual comes with a static parseSettings method, which calls VisualSettings.parse(). If I inspect the return value of this call then it is a VisualSettings instance with a property called "dataPointSettings", which itself has properties like "defaultColor", "fontSize", etc. My question is where are these defined? I'd like to be able to modify these values but I can't find any class called VisualSettings in my source code.

Thank you.

Re: Modifying parseSettings/VisualSettings

v-chuncz-msft — Thu, 07 Sep 2017 07:27:28 GMT

@callum,

Check "src/settings.ts" in your visual project.

Re: Modifying parseSettings/VisualSettings

Anonymous — Thu, 19 Oct 2017 07:40:50 GMT

Hi @callum @v-chuncz-msft
I'm also trying to develop a custom visual and is stuck at this particular point.
how did you retrieve property values from the dataview and how did you populate the property pane afterwards?
Did you use enumerateObjectInstances ?

Re: Modifying parseSettings/VisualSettings

v-viig — Thu, 19 Oct 2017 07:57:04 GMT

Hello @Anonymous

Yes, you should implement enumerateObjectInstances in order to update values at the format panel.

Do you have VisualSettings class in your csutom visual?

Ignat Vilesov,

Software Engineer

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

Re: Modifying parseSettings/VisualSettings

Anonymous — Thu, 19 Oct 2017 08:04:36 GMT

hello @v-viig
Yes,I am using VisualSettings class.
Should i use the switch statement then.
I'm a little confused as this template is slightly different from the one in the tutorial.

Re: Modifying parseSettings/VisualSettings

v-viig — Thu, 19 Oct 2017 08:50:43 GMT

If you want to include new properties into formatting panel you should:

Create a new class

export class NewGroup {
    public show: boolean = true;
}

Specify an instance of the new class into VisualSettings class

export class VisualSettings extends DataViewObjectsParser {
  public newGroup: NewGroup = new NewGroup();
}

Specify the new group at capabilities.json

"objects": {
    "newGroup": {
        "displayName": "New Group",
        "properties": {
            "show": {
                "displayName": "Show",
                "type": {
                    "bool": true
                }
            }
        }
    }
}

Please note that these steps are for including the new group of properties. You can actually include new properties into the existing classes (please don't forget to specify the same properties at capabilities.json).

Please let me know if you have any further questions.

Ignat Vilesov,

Software Engineer

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

Re: Modifying parseSettings/VisualSettings

Anonymous — Thu, 19 Oct 2017 09:41:57 GMT

Actually I have done upto here.Since now there is no need for an interface,How do I retrieve the property value from the pane.
Also how would this code snippet change after I add more properties?

public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {                   
            return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
        }

Re: Modifying parseSettings/VisualSettings

v-viig — Fri, 20 Oct 2017 07:06:05 GMT

You shouldn't change this snippet code.
All of properties will be parsed automatically.

Ignat Vilesov,

Software Engineer

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

Re: Modifying parseSettings/VisualSettings

Anonymous — Sat, 21 Oct 2017 15:44:15 GMT

@v-viig
and how do i retrieve the property values from the pane?
are interfaces needed?

Re: Modifying parseSettings/VisualSettings

v-viig — Thu, 09 Nov 2017 07:29:20 GMT

The property will in this.settings.

Do you want to include any extra properties?

Ignat Vilesov,

Software Engineer

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com