Skip to content

Commit

Permalink
Fix link redirection in 2.4.6, 3.1 and 3.2 docs
Browse files Browse the repository at this point in the history
Signed-off-by: srikant <[email protected]>
  • Loading branch information
srikant-ch5 committed Feb 28, 2024
1 parent 339ec87 commit a0ed397
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/2.4.6-Constructing-a-read-only-or-locked-canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Some host applications need to display flows that cannot be edited by the user.
There are many aspects of common-canvas components that need to considered for a read-only canvas. Since common-canvas is highly customizable it is not possible for the common-canvas code to manage components of the canvas that have been customized by the host application. For example, if the host app code added tools to the toolbar, common-canvas does not know whether those tools should be disabled when displaying a read-only canvas or not. So the host application code will need to manage that. Let's look at each element of common-canvas and see what needs to be done.

# General Config
There is one main canvas configuration property that will change the common-canvas behavior to implement a read-only canvas. This is [`enableEditingActions`](2.1-Config-Objects#enableeditingactions) which defaults to true and needs to be set to `false` for read-only canvases. The sections below will cover what effect this will have on the different components of common-canvas and what you need to do for any customizations you have made.
There is one main canvas configuration property that will change the common-canvas behavior to implement a read-only canvas. This is [`enableEditingActions`](2.1-Config-Objects.md#enableeditingactions) which defaults to true and needs to be set to `false` for read-only canvases. The sections below will cover what effect this will have on the different components of common-canvas and what you need to do for any customizations you have made.

# Canvas
Setting `enableEditingActions` to false will prevent nodes and comments (and detachable links) from being moved relative to one another. It will also prevent new links from being created and prevent text (like comments or node labels) from being edited.
Expand Down
4 changes: 2 additions & 2 deletions docs/3.1-Common-Properties-Parameter-Definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Example
}
```

UI-only parameters require information about the parameters same as the parameter definition information used for the backend parameters. The UI-only parameter definition information is stored in the UI-hints section in the sub-section named `ui_parameters`. A description of the UI hints specifications can be found here: [3.2 Common Properties UI Hints](3.2-Common-Properties--UI-Hints.md)
UI-only parameters require information about the parameters same as the parameter definition information used for the backend parameters. The UI-only parameter definition information is stored in the UI-hints section in the sub-section named `ui_parameters`. A description of the UI hints specifications can be found here: [3.2 Common Properties UI Hints](3.2-Common-Properties-UI-Hints.md)


UI-only properties are returned to the consuming application via a separate parameter on the applyPropertiesChanges callback. See the `Callbacks` section of [3.1 Common Properties Documentation section.](3.0-Common-Properties-documentation.md)
Expand Down Expand Up @@ -157,7 +157,7 @@ Note that both parameter and complex type definitions are in the exact same form


## UI Hints
A set of specifications for controlling the layout and flow of the common properties. A description of the UI hints specifications can be found here: [3.2 Common Properties UI Hints](3.2-Common-Properties--UI-Hints.md)
A set of specifications for controlling the layout and flow of the common properties. A description of the UI hints specifications can be found here: [3.2 Common Properties UI Hints](3.2-Common-Properties-UI-Hints.md)

## Conditions
A set of specifications for controlling validation checking of parameters during the common properties dialog. A description of the Conditions specifications can be found here:
Expand Down
20 changes: 10 additions & 10 deletions docs/3.2-Common-Properties-UI-Hints.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Group info attributes.
+ See [Resource Definition](#resource-definition)
* `description` (*object*) Group description. Only used with `textPanel` and `actionPanel`.
+ See [Resource Definition](#resource-definition)
+ See [Dynamic Text Expressions](3.2-Common-Properties--UI-Hints.md#dynamic-text-expressions)
+ See [Dynamic Text Expressions](3.2-Common-Properties-UI-Hints.md#dynamic-text-expressions)
+ `link` (object) Optional link in the description. [tooltipLinkHandler callback](3.0-Common-Properties-documentation.md#tooltiplinkhandler) must be defined whenever link object is added in uiHints..
+ `id` (string) Required unique link id.
+ `data` (object) Data passed to the tooltipLinkHandler callback.
Expand Down Expand Up @@ -130,7 +130,7 @@ Parameter info attributes.
* `separator` (*string*) Determines where to put a separator relative to the current control. Valid values are ` after, before`.
* `visible` (*boolean*) Determines whether to display control in a table cell. Used in complex types only.
* `place_holder_text` (*object*) Text hint for the user displayed input controls.
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
* `resource_key` (*string*) Used as a key for enum value labels in the resources section of property definition.
* `edit_style` (*string*) Editing style of elements in a table. Valid values are `subpanel, inline, on_panel`.
* `value_icons` (*array[string]*) For enumerated types, this defines the set of icons for the valid values. The ordering must be consistent with the order in the parameter enum attribute.
Expand All @@ -141,13 +141,13 @@ Parameter info attributes.
* `dm_image` (*string*) This can be set to display an icon of the corresponding dm type in the `role`:`column` field of a table. Valid values are `measure`, `type`, `none`
* `summary` (*boolean*) Determines if parameter should be shown in the summary when using a `summaryPanel`.
* `text_before` (*object*) Text to be displayed before the control
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
+ `type` (*string*) Adds a icon and additional formatting to the text. Only `info` is support at this time.
+ See [Dynamic Text Expressions](3.2-Common-Properties--UI-Hints.md#dynamic-text-expressions)
+ See [Dynamic Text Expressions](3.2-Common-Properties-UI-Hints.md#dynamic-text-expressions)
* `text_after` (*object*) Text to be displayed after the control
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
+ `type` (*string*) Adds a icon and additional formatting to the text. Only `info` is support at this time.
+ See [Dynamic Text Expressions](3.2-Common-Properties--UI-Hints.md#dynamic-text-expressions)
+ See [Dynamic Text Expressions](3.2-Common-Properties-UI-Hints.md#dynamic-text-expressions)
* `custom_control_id` (*string*) Id that is used to determine which custom control to use when `control=custom`
* `data` (*any*) Returned in custom control constructor without any changes.
* `rows` (*integer*) Number of rows to show in a table before scrolling starts. If one table in a panel is set to -1, that table will use the remaining available vertical space, down to a minimum of 2 rows. Used in expression and code controls to determine the number of rows to show for those controls.
Expand Down Expand Up @@ -184,7 +184,7 @@ Complex Type info attributes.
* `complex_type_ref` (*string*) **Required** Name of complex type, can be referenced in other places.
* `key_definition` (*string*) A set of parameter info attributes about the key parameter.
* `label` (*object*) External name of subpanel.
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
* `parameters` (*object*) **Required** List of parameters that are part of this complex parameter. This parameter can either have a set of parameter_info attributes or other nested complex_type_info attributes.
* `header` (*boolean*) If `true` then the table has a header row with column names. Defaults to `true`.
* `add_remove_rows` (*boolean*) If `true` then the table can have rows added and removed. Defaults to `true`.
Expand All @@ -196,9 +196,9 @@ Complex Type info attributes.
* `buttons` (*array*) An array of objects that define custom buttons to be displayed in this complex structure, overriding any default buttons. Each button object contains the following properties:
+ `id` (*string*) **Required**: Unique identifier used to identify the button in the callback function.
+ `label` (*object*): Button label to display. If an icon is specified as well, the icon will be shown to the right of the label.
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
+ `description` (*object*): Tooltip text to display when the button is hovered.
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
+ `icon` (*string*): URL to .svg image to display.
+ `carbon_icon` (*string*): Host provided name of Carbon icon to display. A callback function is required for the host application to return the jsx icon object imported from @carbon/icons-react library.
+ `enabled` (*boolean*): Button will be enabled if true, disabled if false.
Expand Down Expand Up @@ -295,7 +295,7 @@ Action info attributes.
* `id` (*string*) **Required** Id of the action.
* `label` (*object*) **Required** External name of action.
+ See [Resource Definition](3.2-Common-Properties--UI-Hints.md#resource-definition)
+ See [Resource Definition](3.2-Common-Properties-UI-Hints.md#resource-definition)
* `control` (*string*) **Required** The type of action. Currently `button` and `image` are supported.
* `class_name` (*string*) Optional classname for this action
* `image` (*object*) Properties associate with an `image` action.
Expand Down

0 comments on commit a0ed397

Please sign in to comment.